WSF
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Report Class Referenceabstract

#include <Report.hpp>

Inheritance diagram for Report:
Inheritance graph
[legend]

Classes

struct  TagData

Public Types

enum class  AngleUnitType { cDEGREES , cRADIANS }
enum class  LengthUnitType { cFEET , cMETERS }
enum class  TrackNumericalType { cNUMERICAL , cJTIDS }
enum class  DelimiterType {
  cUNKNOWN , cCOMMA , cCOLUMN , cSEMICOLON ,
  cSPACE , cTAB
}
enum class  Type {
  cUNKNOWN , cCOMMUNICATION , cDETECTION , cDSV ,
  cENGAGEMENT , cTRAJECTORY , cECLIPSE
}

Public Member Functions

 Report ()=delete
 Report (const Type aReportType, const Options &aOptions)
virtual ~Report ()=default
bool PrintReport ()
void ProcessData (std::istream &aInStream)
virtual bool CreateRequiredData (std::string &aOutputDir)
virtual bool ProcessInputConfiguration (UtInput &aInput)
virtual void PrintReportHeader (std::ostream &aStream)
virtual bool Filter (std::vector< std::string > &aLine)
std::string PrintDelimiter () const
void SetDelimiter (const std::string &aTypeString)
void SetDateTime (const std::vector< std::string > &aDataStrVec)
double FormatAngle (double aAngle) const
UtTime FormatTime (double aSimTime) const

Static Public Member Functions

static void FormatNumberColumn (std::ostream &aStream, size_t aNumSpaces, int aNumDigits, int aInt)
static void FormatStringColumn (std::ostream &aStream, std::string &aString, int aNumSpaces)
static std::string GetTypeStr (Report::Type aReportType)
static Header::DataTag ParseHeaderTag (const std::string &aString, bool aExpectType=false)
static void Tokenize (const std::string &aStr, std::vector< std::string > &aTokens, const char aDelimiter=',')
static std::vector< std::string > Tokenize (const std::string &aStr, char aDelimiter)

Protected Member Functions

void PrepareExtension (std::string &aOutputDir)
virtual void PrintReport (std::istream &aInStream, std::ostream &aOutStream)=0
virtual void ProcessHeaders (std::istream &aStream)
Header ProcessHeaderLine (const std::string &aLine)
void SetLatLonFormat (int &aFormat)
std::string FormatDateTime (double aSimTime=0)
std::string FormatDateTime (int aYear, int aMonth, int aDay, int aHour, int aMinute, double aSecond)

Static Protected Member Functions

static std::string SubstituteOutputFileVariables (const std::string &aOutputFile, size_t aMC_Number, UtCalendar &aCalendar)
static std::vector< std::string > ExtractHeaders (std::istream &aStream)

Protected Attributes

Type mReportType
std::string mReportName
std::string mDataFile
std::string mOutputDir
size_t mStartMC
size_t mEndMC
UtCalendar mSimDateTime
DelimiterType mDelimiterType = DelimiterType::cCOMMA
double mStartTime = 0.0
std::string mStartTimeUnits = "seconds"
double mEndTime = std::numeric_limits<double>::max()
std::string mEndTimeUnits = "seconds"
size_t mCurrentMC = mStartMC
bool mUseMC = false
std::map< std::string, std::map< std::string, TagData > > mEventToTagData
std::vector< std::string > mEvents
std::vector< std::string > mHeader
bool mWriteHeader = true
std::iostream::pos_type mEndOfHeaders = 0
int mTimeFormat = UtTime::FmtS + 5 + UtTime::FmtShowPoint + UtTime::FmtNoSuffix
int mLatLonFormat = UtAngle::FmtDMS + 2
AngleUnitType mAngleUnits = AngleUnitType::cDEGREES
int mInterval = 1
bool mSingleOutputFile = true
TrackNumericalType mTrackNum = TrackNumericalType::cNUMERICAL
LengthUnitType mLengthUnits = LengthUnitType::cMETERS
int mPrecision = 8
size_t mMaxPlatformNameSize = 8
size_t mMaxTimeSize = 15
std::vector< std::string > mRequiredData
std::queue< std::iostream::pos_type > mFilteredDataLoc

Member Enumeration Documentation

◆ AngleUnitType

enum class Report::AngleUnitType
strong
Enumerator
cDEGREES 
cRADIANS 

◆ DelimiterType

enum class Report::DelimiterType
strong
Enumerator
cUNKNOWN 
cCOMMA 
cCOLUMN 
cSEMICOLON 
cSPACE 
cTAB 

◆ LengthUnitType

enum class Report::LengthUnitType
strong
Enumerator
cFEET 
cMETERS 

◆ TrackNumericalType

enum class Report::TrackNumericalType
strong
Enumerator
cNUMERICAL 
cJTIDS 

◆ Type

enum class Report::Type
strong
Enumerator
cUNKNOWN 
cCOMMUNICATION 
cDETECTION 
cDSV 
cENGAGEMENT 
cTRAJECTORY 
cECLIPSE 

Constructor & Destructor Documentation

◆ Report() [1/2]

Report::Report ( )
delete

References Report().

Referenced by CommunicationReport::CommunicationReport(), DetectionReport::DetectionReport(), DSV_Output::DSV_Output(), EclipseReport::EclipseReport(), EngagementReport::EngagementReport(), Report(), and TrajectoryReport::TrajectoryReport().

◆ Report() [2/2]

Report::Report ( const Type aReportType,
const Options & aOptions )

References mDataFile, mEndMC, mOutputDir, mReportName, mReportType, and mStartMC.

◆ ~Report()

virtual Report::~Report ( )
virtualdefault

References PrintReport(), and ProcessData().

Member Function Documentation

◆ CreateRequiredData()

virtual bool Report::CreateRequiredData ( std::string & aOutputDir)
inlinevirtual

Reimplemented in CommunicationReport, DetectionReport, DSV_Output, EclipseReport, EngagementReport, and TrajectoryReport.

Referenced by PrintReport().

◆ ExtractHeaders()

std::vector< std::string > Report::ExtractHeaders ( std::istream & aStream)
staticprotected

Referenced by ProcessHeaders().

◆ Filter()

virtual bool Report::Filter ( std::vector< std::string > & aLine)
inlinevirtual

Reimplemented in CommunicationReport, DetectionReport, DSV_Output, EclipseReport, EngagementReport, and TrajectoryReport.

Referenced by ProcessData().

◆ FormatAngle()

double Report::FormatAngle ( double aAngle) const

References cDEGREES, and mAngleUnits.

◆ FormatDateTime() [1/2]

std::string Report::FormatDateTime ( double aSimTime = 0)
protected

References FormatDateTime(), and mSimDateTime.

Referenced by FormatDateTime(), EclipseReport::PrintReport(), DetectionReport::PrintReportHeader(), and EclipseReport::PrintReportHeader().

◆ FormatDateTime() [2/2]

std::string Report::FormatDateTime ( int aYear,
int aMonth,
int aDay,
int aHour,
int aMinute,
double aSecond )
protected

◆ FormatNumberColumn()

void Report::FormatNumberColumn ( std::ostream & aStream,
size_t aNumSpaces,
int aNumDigits,
int aInt )
static

◆ FormatStringColumn()

void Report::FormatStringColumn ( std::ostream & aStream,
std::string & aString,
int aNumSpaces )
static

Referenced by DetectionReport::PrintReport(), and EngagementReport::PrintReport().

◆ FormatTime()

UtTime Report::FormatTime ( double aSimTime) const

References mTimeFormat.

Referenced by CommunicationReport::PrintReport(), DetectionReport::PrintReport(), and EngagementReport::PrintReport().

◆ GetTypeStr()

std::string Report::GetTypeStr ( Report::Type aReportType)
static

References cCOMMUNICATION, cDETECTION, cDSV, cECLIPSE, cENGAGEMENT, cTRAJECTORY, and cUNKNOWN.

Referenced by Configuration::GetReportTypeStr(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and EngagementReport::PrintReportHeader().

◆ ParseHeaderTag()

Header::DataTag Report::ParseHeaderTag ( const std::string & aString,
bool aExpectType = false )
static

References Header::cCOUNT, Header::cINDEX, Header::DataTag::countType, Header::DataTag::dataType, Header::GetDataType(), and Header::DataTag::name.

Referenced by ParseEventTags().

◆ PrepareExtension()

void Report::PrepareExtension ( std::string & aOutputDir)
protected

Referenced by PrintReport().

◆ PrintDelimiter()

std::string Report::PrintDelimiter ( ) const

References cCOMMA, cSEMICOLON, cSPACE, cTAB, and mDelimiterType.

Referenced by CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EclipseReport::PrintReport(), EngagementReport::PrintReport(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and EngagementReport::PrintReportHeader().

◆ PrintReport() [1/2]

bool Report::PrintReport ( )

References cDSV, CreateRequiredData(), mCurrentMC, mDataFile, mEndMC, mOutputDir, mReportName, mReportType, mStartMC, mUseMC, mWriteHeader, PrepareExtension(), PrintReport(), PrintReportHeader(), ProcessData(), ProcessHeaders(), and SubstituteOutputFileVariables().

Referenced by PrintReport(), and ~Report().

◆ PrintReport() [2/2]

virtual void Report::PrintReport ( std::istream & aInStream,
std::ostream & aOutStream )
protectedpure virtual

Implemented in CommunicationReport, DetectionReport, EclipseReport, EngagementReport, and TrajectoryReport.

References ProcessHeaderLine(), and ProcessHeaders().

◆ PrintReportHeader()

virtual void Report::PrintReportHeader ( std::ostream & aStream)
inlinevirtual

Reimplemented in CommunicationReport, DetectionReport, DSV_Output, EclipseReport, EngagementReport, and TrajectoryReport.

Referenced by PrintReport().

◆ ProcessData()

void Report::ProcessData ( std::istream & aInStream)

References Filter(), mEndOfHeaders, mFilteredDataLoc, SetDateTime(), and Tokenize().

Referenced by PrintReport(), and ~Report().

◆ ProcessHeaderLine()

Header Report::ProcessHeaderLine ( const std::string & aLine)
protected

References ParseEventTags().

Referenced by PrintReport(), and ProcessHeaders().

◆ ProcessHeaders()

void Report::ProcessHeaders ( std::istream & aStream)
protectedvirtual

References ExtractHeaders(), mEndOfHeaders, mEvents, mEventToTagData, Report::TagData::mIndex, Report::TagData::mType, and ProcessHeaderLine().

Referenced by PrintReport(), and PrintReport().

◆ ProcessInputConfiguration()

bool Report::ProcessInputConfiguration ( UtInput & aInput)
virtual

Reimplemented in CommunicationReport, DetectionReport, EclipseReport, and EngagementReport.

References cDEGREES, cFEET, cJTIDS, cMETERS, cNUMERICAL, cRADIANS, mAngleUnits, mEndTime, mInterval, mLatLonFormat, mLengthUnits, mMaxTimeSize, mPrecision, mSingleOutputFile, mStartTime, mTimeFormat, mTrackNum, mUseMC, mWriteHeader, and SetDelimiter().

Referenced by CommunicationReport::ProcessInputConfiguration(), DetectionReport::ProcessInputConfiguration(), EclipseReport::ProcessInputConfiguration(), and EngagementReport::ProcessInputConfiguration().

◆ SetDateTime()

void Report::SetDateTime ( const std::vector< std::string > & aDataStrVec)

References mEventToTagData, and mSimDateTime.

Referenced by ProcessData().

◆ SetDelimiter()

void Report::SetDelimiter ( const std::string & aTypeString)

References cCOLUMN, cCOMMA, cSEMICOLON, cSPACE, cTAB, cUNKNOWN, and mDelimiterType.

Referenced by ProcessInputConfiguration().

◆ SetLatLonFormat()

void Report::SetLatLonFormat ( int & aFormat)
inlineprotected

References mLatLonFormat.

◆ SubstituteOutputFileVariables()

std::string Report::SubstituteOutputFileVariables ( const std::string & aOutputFile,
size_t aMC_Number,
UtCalendar & aCalendar )
staticprotected

Performs substitution for naming output files d - Current Monte-Carlo Number D - Date M-D-Y T - Time HHMMSS

Referenced by PrintReport().

◆ Tokenize() [1/2]

std::vector< std::string > Report::Tokenize ( const std::string & aStr,
char aDelimiter )
static

References Tokenize().

◆ Tokenize() [2/2]

void Report::Tokenize ( const std::string & aStr,
std::vector< std::string > & aTokens,
const char aDelimiter = ',' )
static

Referenced by ParseEventTags(), CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EngagementReport::PrintReport(), ProcessData(), and Tokenize().

Member Data Documentation

◆ mAngleUnits

AngleUnitType Report::mAngleUnits = AngleUnitType::cDEGREES
protected

Referenced by FormatAngle(), and ProcessInputConfiguration().

◆ mCurrentMC

size_t Report::mCurrentMC = mStartMC
protected

Referenced by CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EclipseReport::PrintReport(), EngagementReport::PrintReport(), and PrintReport().

◆ mDataFile

std::string Report::mDataFile
protected

Referenced by PrintReport(), and Report().

◆ mDelimiterType

DelimiterType Report::mDelimiterType = DelimiterType::cCOMMA
protected

Referenced by PrintDelimiter(), CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EclipseReport::PrintReport(), EngagementReport::PrintReport(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), EngagementReport::PrintReportHeader(), and SetDelimiter().

◆ mEndMC

size_t Report::mEndMC
protected

Referenced by PrintReport(), and Report().

◆ mEndOfHeaders

std::iostream::pos_type Report::mEndOfHeaders = 0
protected

Referenced by ProcessData(), and ProcessHeaders().

◆ mEndTime

double Report::mEndTime = std::numeric_limits<double>::max()
protected

Referenced by CommunicationReport::Filter(), DetectionReport::Filter(), DSV_Output::Filter(), EclipseReport::Filter(), EngagementReport::Filter(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), EngagementReport::PrintReportHeader(), ProcessInputConfiguration(), and EclipseReport::UpdateEclipseReport().

◆ mEndTimeUnits

std::string Report::mEndTimeUnits = "seconds"
protected

Referenced by CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and EngagementReport::PrintReportHeader().

◆ mEvents

std::vector<std::string> Report::mEvents
protected

Referenced by DSV_Output::CreateRequiredData(), CommunicationReport::Filter(), DetectionReport::Filter(), EclipseReport::Filter(), DSV_Output::PrintReportHeader(), and ProcessHeaders().

◆ mEventToTagData

std::map<std::string, std::map<std::string, TagData> > Report::mEventToTagData
protected

Referenced by DSV_Output::CreateRequiredData(), EclipseReport::CreateRequiredData(), DetectionReport::Filter(), EclipseReport::Filter(), EngagementReport::Filter(), CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EngagementReport::PrintReport(), ProcessHeaders(), SetDateTime(), and EclipseReport::UpdateEclipseReport().

◆ mFilteredDataLoc

std::queue<std::iostream::pos_type> Report::mFilteredDataLoc
protected

Referenced by CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EngagementReport::PrintReport(), and ProcessData().

◆ mHeader

std::vector<std::string> Report::mHeader
protected

Referenced by CommunicationReport::PrintReportHeader().

◆ mInterval

int Report::mInterval = 1
protected

Referenced by CommunicationReport::PrintReport(), and ProcessInputConfiguration().

◆ mLatLonFormat

int Report::mLatLonFormat = UtAngle::FmtDMS + 2
protected

Referenced by ProcessInputConfiguration(), and SetLatLonFormat().

◆ mLengthUnits

LengthUnitType Report::mLengthUnits = LengthUnitType::cMETERS
protected

Referenced by ProcessInputConfiguration().

◆ mMaxPlatformNameSize

size_t Report::mMaxPlatformNameSize = 8
protected

Referenced by EclipseReport::PrintReport(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and EclipseReport::UpdateEclipseReport().

◆ mMaxTimeSize

size_t Report::mMaxTimeSize = 15
protected

Referenced by EclipseReport::PrintReport(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and ProcessInputConfiguration().

◆ mOutputDir

std::string Report::mOutputDir
protected

Referenced by PrintReport(), and Report().

◆ mPrecision

int Report::mPrecision = 8
protected

Referenced by ProcessInputConfiguration().

◆ mReportName

std::string Report::mReportName
protected

Referenced by PrintReport(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), EngagementReport::PrintReportHeader(), and Report().

◆ mReportType

Type Report::mReportType
protected

Referenced by PrintReport(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), EngagementReport::PrintReportHeader(), and Report().

◆ mRequiredData

std::vector<std::string> Report::mRequiredData
protected

Referenced by DetectionReport::CreateRequiredData(), EngagementReport::CreateRequiredData(), DetectionReport::PrintReport(), and EngagementReport::PrintReport().

◆ mSimDateTime

UtCalendar Report::mSimDateTime
protected

Referenced by FormatDateTime(), and SetDateTime().

◆ mSingleOutputFile

bool Report::mSingleOutputFile = true
protected

Referenced by ProcessInputConfiguration().

◆ mStartMC

size_t Report::mStartMC
protected

Referenced by PrintReport(), and Report().

◆ mStartTime

double Report::mStartTime = 0.0
protected

Referenced by DetectionReport::Filter(), EclipseReport::Filter(), CommunicationReport::PrintReport(), CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), EngagementReport::PrintReportHeader(), ProcessInputConfiguration(), and EclipseReport::UpdateEclipseReport().

◆ mStartTimeUnits

std::string Report::mStartTimeUnits = "seconds"
protected

Referenced by CommunicationReport::PrintReportHeader(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and EngagementReport::PrintReportHeader().

◆ mTimeFormat

int Report::mTimeFormat = UtTime::FmtS + 5 + UtTime::FmtShowPoint + UtTime::FmtNoSuffix
protected

Referenced by FormatTime(), EclipseReport::PrintReport(), and ProcessInputConfiguration().

◆ mTrackNum

TrackNumericalType Report::mTrackNum = TrackNumericalType::cNUMERICAL
protected

Referenced by ProcessInputConfiguration().

◆ mUseMC

bool Report::mUseMC = false
protected

Referenced by CommunicationReport::PrintReport(), DetectionReport::PrintReport(), EclipseReport::PrintReport(), EngagementReport::PrintReport(), PrintReport(), DetectionReport::PrintReportHeader(), EclipseReport::PrintReportHeader(), and ProcessInputConfiguration().

◆ mWriteHeader

bool Report::mWriteHeader = true
protected

Referenced by PrintReport(), and ProcessInputConfiguration().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved