wsf::coverage::MeasureLatLonStatsOutput Class Reference

#include <WsfCoverageMeasureLatLonStatsOutput.hpp>

Inheritance diagram for wsf::coverage::MeasureLatLonStatsOutput:

Collaboration diagram for wsf::coverage::MeasureLatLonStatsOutput:

Public Member Functions
	MeasureLatLonStatsOutput ()=default
	MeasureLatLonStatsOutput (std::unique_ptr< TextOutputWriter > aWriterPtr)
	MeasureLatLonStatsOutput (const MeasureLatLonStatsOutput &aOther)=default
	~MeasureLatLonStatsOutput () override=default
MeasureLatLonStatsOutput *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
double	GetBinSizeDeg () const
	Return the bin size in degrees.
MeasureLatLonStats::Projection	GetProjection () const
	Return the direction onto which the data is projected.
std::string	GetOutputType () const override
Public Member Functions inherited from wsf::coverage::MeasureTextOutput
	MeasureTextOutput ()
	MeasureTextOutput (std::unique_ptr< TextOutputWriter > aWriterPtr)
	MeasureTextOutput (const MeasureTextOutput &aOther)=default
	~MeasureTextOutput () override=default
bool	ProcessInput (UtInput &aInput) override
void	Write (const Coverage &aCoverage, const Measure &aMeasure) override
void	SetFileNameToDefault (const Coverage &aCoverage, const Measure &aMeasure) override
TextOutputWriter &	GetWriter ()
	Return the writer being used by this object.
Public Member Functions inherited from wsf::coverage::MeasureOutput
	MeasureOutput ()=default
	MeasureOutput (const MeasureOutput &aOther)=default
	~MeasureOutput () override=default
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)

Static Public Attributes
static constexpr const char *	cTYPE {"lat_lon_stats"}

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 to project data in latitude or longitude and produce summary statistics.

This class collects projects out either latitude or longitude and then presents summary statistics as a function of the remaining direction. The data in the remaining direction is binned according to a user-provided bin size. Each instance of this class will project in only one direction, so if both projections are needed, two instances with different projections selected are needed.

Constructor & Destructor Documentation

MeasureLatLonStatsOutput() [1/3]

wsf::coverage::MeasureLatLonStatsOutput::MeasureLatLonStatsOutput ( )

default

References MeasureLatLonStatsOutput().

Referenced by Clone(), MeasureLatLonStatsOutput(), and MeasureLatLonStatsOutput().

MeasureLatLonStatsOutput() [2/3]

wsf::coverage::MeasureLatLonStatsOutput::MeasureLatLonStatsOutput ( std::unique_ptr< TextOutputWriter > aWriterPtr )

explicit

References wsf::coverage::MeasureTextOutput::MeasureTextOutput().

MeasureLatLonStatsOutput() [3/3]

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

default

References MeasureLatLonStatsOutput().

~MeasureLatLonStatsOutput()

wsf::coverage::MeasureLatLonStatsOutput::~MeasureLatLonStatsOutput ( )

overridedefault

Member Function Documentation

Clone()

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

inlineoverridevirtual

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

Implements wsf::coverage::MeasureOutput.

References MeasureLatLonStatsOutput().

GetBinSizeDeg()

double wsf::coverage::MeasureLatLonStatsOutput::GetBinSizeDeg ( ) const

inline

Return the bin size in degrees.

GetOutputType()

std::string wsf::coverage::MeasureLatLonStatsOutput::GetOutputType ( ) const

inlineoverridevirtual

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.

Implements wsf::coverage::MeasureOutput.

References cTYPE.

GetProjection()

MeasureLatLonStats::Projection wsf::coverage::MeasureLatLonStatsOutput::GetProjection ( ) const

inline

Return the direction onto which the data is projected.

ProcessInput()

bool wsf::coverage::MeasureLatLonStatsOutput::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.

References wsf::coverage::MeasureLatLonStats::cLATITUDE, wsf::coverage::MeasureLatLonStats::cLONGITUDE, and wsf::coverage::MeasureTextOutput::ProcessInput().

Member Data Documentation

cTYPE

const char* wsf::coverage::MeasureLatLonStatsOutput::cTYPE {"lat_lon_stats"}

staticconstexpr

Referenced by GetOutputType(), and wsf::coverage::MeasureOutputTypes::MeasureOutputTypes().

---

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

• WsfCoverageMeasureLatLonStatsOutput.hpp
• WsfCoverageMeasureLatLonStatsOutput.cpp