An MOE that measures the number of gaps in coverage. More...

#include <WsfCoverageNumberOfGaps.hpp>

Inheritance diagram for wsf::coverage::NumberOfGaps:

[legend]

Collaboration diagram for wsf::coverage::NumberOfGaps:

[legend]

Public Types
enum class	SubType { cTOTAL , cIN_SPAN , cMINIMUM_PER_TIME , cMAXIMUM_PER_TIME , cMEAN_PER_TIME , cIN_SPAN_PER_TIME , cUNKNOWN }
	The available sub-types for this MOE. More...
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	NumberOfGaps (const WsfScenario &aScenario)
	NumberOfGaps (const NumberOfGaps &aOther)=default
	~NumberOfGaps () override=default
NumberOfGaps *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
double	GetDefaultValue () const override
	Return the default value for the measure if there were no accesses.
double	GetMeasuredValue (const GridAsset &aGridAsset) const override
	Return the measured value for the given `aGridAsset`.
void	CollectionStarting (Coverage &aCoverage, double aSimTime) override
std::string	GetValueHeader () const override
	Return the text header for output files for this MOE.
SubType	GetSubType () const
double	GetSampleSpan () const
	If the subtype is a per-time subtype, then this is the duration of the sample in seconds.
double	GetMinParameter () const
double	GetMaxParameter () const
Public Member Functions inherited from wsf::coverage::Measure
	Measure (const WsfScenario &aScenario)
	Measure (const Measure &aOther)=default
	~Measure () override=default
bool	Initialize (Coverage &aCoverage)
void	CollectionCompleting (Coverage &aCoverage, double aSimTime)
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 {"WSF_NUMBER_OF_GAPS_MOE"}

Additional Inherited Members
Protected Member Functions inherited from wsf::coverage::Measure
std::size_t	GetNumOutput () const
	Return the number of output objects attached to this Measure.
const MeasureOutput *	GetOutput (std::size_t aIndex) const
	Return the output object at the given index.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from wsf::coverage::Measure
UtCallbackHolder	mCallbacks {}
	Holder for callbacks created when this object connects to events on it's coverage.

Detailed Description

An MOE that measures the number of gaps in coverage.

Member Enumeration Documentation

◆ SubType

enum class wsf::coverage::NumberOfGaps::SubType

strong

The available sub-types for this MOE.

Enumerator
cTOTAL
cIN_SPAN
cMINIMUM_PER_TIME
cMAXIMUM_PER_TIME
cMEAN_PER_TIME
cIN_SPAN_PER_TIME
cUNKNOWN

Constructor & Destructor Documentation

◆ NumberOfGaps() [1/2]

wsf::coverage::NumberOfGaps::NumberOfGaps ( const WsfScenario & aScenario )

inlineexplicit

References cTYPE, wsf::coverage::Measure::Measure(), and WsfObject::SetType().

Referenced by Clone(), and NumberOfGaps().

◆ NumberOfGaps() [2/2]

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

default

References NumberOfGaps().

◆ ~NumberOfGaps()

wsf::coverage::NumberOfGaps::~NumberOfGaps ( )

overridedefault

Member Function Documentation

◆ Clone()

NumberOfGaps * wsf::coverage::NumberOfGaps::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::Measure.

References NumberOfGaps().

◆ CollectionStarting()

void wsf::coverage::NumberOfGaps::CollectionStarting	(	Coverage &	aCoverage,
		double	aSimTime )

overridevirtual

Perform any needed actions when the coverage interval begins.

Parameters

aCoverage	- The coverage owning this object.
aSimTime	- The sim time at which the coverate interval starts.

Reimplemented from wsf::coverage::Measure.

◆ GetDefaultValue()

double wsf::coverage::NumberOfGaps::GetDefaultValue ( ) const

overridevirtual

Return the default value for the measure if there were no accesses.

Implements wsf::coverage::Measure.

References cIN_SPAN, cIN_SPAN_PER_TIME, cMAXIMUM_PER_TIME, cMEAN_PER_TIME, cMINIMUM_PER_TIME, cTOTAL, and cUNKNOWN.

Referenced by GetMeasuredValue().

◆ GetMaxParameter()

double wsf::coverage::NumberOfGaps::GetMaxParameter ( ) const

inline

If the subtype is cIN_SPAN or cPER_DAY_IN_SPAN, then get the maximum duration of coverage gaps to be counted. Otherwise, return -1.0.

◆ GetMeasuredValue()

double wsf::coverage::NumberOfGaps::GetMeasuredValue ( const GridAsset & aGridAsset ) const

overridevirtual

Return the measured value for the given aGridAsset.

Implements wsf::coverage::Measure.

References GetDefaultValue().

◆ GetMinParameter()

double wsf::coverage::NumberOfGaps::GetMinParameter ( ) const

inline

If the subtype is cIN_SPAN or cPER_DAY_IN_SPAN, then get the minimum duration of coverage gaps to be counted. Otherwise, return -1.0.

◆ GetSampleSpan()

double wsf::coverage::NumberOfGaps::GetSampleSpan ( ) const

inline

If the subtype is a per-time subtype, then this is the duration of the sample in seconds.

◆ GetSubType()

SubType wsf::coverage::NumberOfGaps::GetSubType ( ) const

inline

◆ GetValueHeader()

std::string wsf::coverage::NumberOfGaps::GetValueHeader ( ) const

overridevirtual

Return the text header for output files for this MOE.

Implements wsf::coverage::Measure.

References cIN_SPAN, cIN_SPAN_PER_TIME, cMAXIMUM_PER_TIME, cMEAN_PER_TIME, cMINIMUM_PER_TIME, cTOTAL, and cUNKNOWN.

◆ ProcessInput()

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

References cMEAN_PER_TIME, cUNKNOWN, WsfObject::GetType(), and wsf::coverage::Measure::ProcessInput().

Member Data Documentation

◆ cTYPE

const char* wsf::coverage::NumberOfGaps::cTYPE {"WSF_NUMBER_OF_GAPS_MOE"}

staticconstexpr

Referenced by wsf::coverage::MeasureTypes::MeasureTypes(), and NumberOfGaps().

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SubType

Constructor & Destructor Documentation

◆ NumberOfGaps() [1/2]

◆ NumberOfGaps() [2/2]

◆ ~NumberOfGaps()

Member Function Documentation

◆ Clone()

◆ CollectionStarting()

◆ GetDefaultValue()

◆ GetMaxParameter()

◆ GetMeasuredValue()

◆ GetMinParameter()

◆ GetSampleSpan()

◆ GetSubType()

◆ GetValueHeader()

◆ ProcessInput()

Member Data Documentation

◆ cTYPE