A class that performs output of the measured data. More...

#include <WsfCoverageMeasureOutput.hpp>

Inheritance diagram for wsf::coverage::MeasureOutput:

[legend]

Collaboration diagram for wsf::coverage::MeasureOutput:

Public Member Functions
	MeasureOutput ()=default
	MeasureOutput (const MeasureOutput &aOther)=default
	~MeasureOutput () override=default
MeasureOutput *	Clone () const override=0
bool	ProcessInput (UtInput &aInput) override
virtual void	Write (const Coverage &aCoverage, const Measure &aMeasure)=0
virtual void	SetFileNameToDefault (const Coverage &aCoverage, const Measure &aMeasure)=0
virtual std::string	GetOutputType () const =0
const std::string &	GetFileName () const
	Return the file name into which output will be written.
const std::string &	GetOutputDir () const
	Return the directory into which any files will be generated.
void	SetFileName (const std::string &aFileName)
	Set the file name into which output will be written.
void	SetOutputDir (const std::string &aOutputDir)
	Set the directory into which any files will be generated.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Detailed Description

A class that performs output of the measured data.

Constructor & Destructor Documentation

◆ MeasureOutput() [1/2]

wsf::coverage::MeasureOutput::MeasureOutput ( )

default

Referenced by Clone(), MeasureOutput(), wsf::coverage::MeasureTextOutput::MeasureTextOutput(), and wsf::coverage::MeasureTextOutput::MeasureTextOutput().

◆ MeasureOutput() [2/2]

wsf::coverage::MeasureOutput::MeasureOutput ( const MeasureOutput & aOther )

default

References MeasureOutput().

◆ ~MeasureOutput()

wsf::coverage::MeasureOutput::~MeasureOutput ( )

overridedefault

Member Function Documentation

◆ Clone()

MeasureOutput * wsf::coverage::MeasureOutput::Clone ( ) const

overridepure virtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

Implemented in wsf::coverage::MeasureCSV_Output, wsf::coverage::MeasureGridStatsOutput, and wsf::coverage::MeasureLatLonStatsOutput.

References MeasureOutput().

◆ GetFileName()

const std::string & wsf::coverage::MeasureOutput::GetFileName ( ) const

inline

Return the file name into which output will be written.

Referenced by wsf::coverage::MeasureTextOutput::SetFileNameToDefault(), and wsf::coverage::MeasureTextOutput::Write().

◆ GetOutputDir()

const std::string & wsf::coverage::MeasureOutput::GetOutputDir ( ) const

inline

Return the directory into which any files will be generated.

Referenced by wsf::coverage::MeasureTextOutput::Write().

◆ GetOutputType()

virtual std::string wsf::coverage::MeasureOutput::GetOutputType ( ) const

pure virtual

Return a string identifying the kind of output.

This will match the identifier used in the input file for this output type.

Returns: - A string identifier for this output type.

Implemented in wsf::coverage::MeasureCSV_Output, wsf::coverage::MeasureGridStatsOutput, and wsf::coverage::MeasureLatLonStatsOutput.

◆ ProcessInput()

bool wsf::coverage::MeasureOutput::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

Reimplemented in wsf::coverage::MeasureTextOutput.

Referenced by wsf::coverage::MeasureTextOutput::ProcessInput().

◆ SetFileName()

void wsf::coverage::MeasureOutput::SetFileName ( const std::string & aFileName )

inline

Set the file name into which output will be written.

Referenced by wsf::coverage::MeasureTextOutput::SetFileNameToDefault().

◆ SetFileNameToDefault()

virtual void wsf::coverage::MeasureOutput::SetFileNameToDefault	(	const Coverage &	aCoverage,
		const Measure &	aMeasure )

pure virtual

Set the filename to a default value that is reasonably unique.

To avoid the user having to manually set the name of every file, MeasureOutput provides an automatic naming feature. Subclasses should implement this so that the default names have a reasonable chance of being unique.

Parameters

aCoverage	- The coverage object defining the measure.
aMeasure	- The measure to be output.

Implemented in wsf::coverage::MeasureTextOutput.

◆ SetOutputDir()

void wsf::coverage::MeasureOutput::SetOutputDir ( const std::string & aOutputDir )

inline

Set the directory into which any files will be generated.

◆ Write()

virtual void wsf::coverage::MeasureOutput::Write	(	const Coverage &	aCoverage,
		const Measure &	aMeasure )

pure virtual

Write the measured data out.

The subclass is responsible for implementing this in the way that produces the output required for that subclass.

Parameters

aCoverage	- The coverage object defining the measure.
aMeasure	- The measure to be output.

Implemented in wsf::coverage::MeasureTextOutput.

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeasureOutput() [1/2]

◆ MeasureOutput() [2/2]

◆ ~MeasureOutput()

Member Function Documentation

◆ Clone()

◆ GetFileName()

◆ GetOutputDir()

◆ GetOutputType()

◆ ProcessInput()

◆ SetFileName()

◆ SetFileNameToDefault()

◆ SetOutputDir()

◆ Write()