An MoE that measures the amount of time covered. More...

#include <WsfCoverageCoverageTime.hpp>

Inheritance diagram for wsf::coverage::CoverageTime:

[legend]

Collaboration diagram for wsf::coverage::CoverageTime:

[legend]

Public Types
enum class	SubType { cUNKNOWN , cTOTAL , cPERCENT , cTOTAL_TIME_ABOVE , cPERCENT_TIME_ABOVE , cMAX_PER_TIME , cMAX_PERCENT_PER_TIME , cMIN_PER_TIME , cMIN_PERCENT_PER_TIME , cMEAN_PER_TIME , cMEAN_PERCENT_PER_TIME , cSTD_DEV_PER_TIME , cSTD_DEV_PERCENT_PER_TIME }
	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
	CoverageTime (const WsfScenario &aScenario)
	CoverageTime (const CoverageTime &aOther)=default
	~CoverageTime () override=default
CoverageTime *	Clone () const override
double	GetDefaultValue () const override
	Return the default value of the measure.
bool	ProcessInput (UtInput &aInput) override
double	GetMeasuredValue (const GridAsset &aGridAsset) const override
	Return the measured value for a given `aGridAsset`.
void	CollectionStarting (Coverage &aCoverage, double aSimTime) override
std::string	GetValueHeader () const override
SubType	GetSubType () const
	Get the sub-type enumeration that describes this CoverageTime instance.
double	GetSampleSpan () const
	Get the duration of samples for per-time subtypes.
double	GetParameter () const
Public Member Functions inherited from wsf::coverage::Measure
	Measure (const WsfScenario &aScenario)
	Measure (const Measure &aOther)=default
	~Measure () override=default
bool	ProcessInput (UtInput &aInput) override
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_COVERAGE_TIME_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 amount of time covered.

Member Enumeration Documentation

◆ SubType

enum class wsf::coverage::CoverageTime::SubType

strong

The available sub-types for this MOE.

Enumerator
cUNKNOWN
cTOTAL
cPERCENT
cTOTAL_TIME_ABOVE
cPERCENT_TIME_ABOVE
cMAX_PER_TIME
cMAX_PERCENT_PER_TIME
cMIN_PER_TIME
cMIN_PERCENT_PER_TIME
cMEAN_PER_TIME
cMEAN_PERCENT_PER_TIME
cSTD_DEV_PER_TIME
cSTD_DEV_PERCENT_PER_TIME

Constructor & Destructor Documentation

◆ CoverageTime() [1/2]

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

inlineexplicit

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

Referenced by Clone(), and CoverageTime().

◆ CoverageTime() [2/2]

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

default

References CoverageTime().

◆ ~CoverageTime()

wsf::coverage::CoverageTime::~CoverageTime ( )

overridedefault

Member Function Documentation

◆ Clone()

CoverageTime * wsf::coverage::CoverageTime::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 CoverageTime().

◆ CollectionStarting()

void wsf::coverage::CoverageTime::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::CoverageTime::GetDefaultValue ( ) const

overridevirtual

Return the default value of the measure.

Implements wsf::coverage::Measure.

References cMAX_PER_TIME, cMAX_PERCENT_PER_TIME, cMEAN_PER_TIME, cMEAN_PERCENT_PER_TIME, cMIN_PER_TIME, cMIN_PERCENT_PER_TIME, cPERCENT, cPERCENT_TIME_ABOVE, cSTD_DEV_PER_TIME, cSTD_DEV_PERCENT_PER_TIME, cTOTAL, cTOTAL_TIME_ABOVE, and cUNKNOWN.

Referenced by GetMeasuredValue().

◆ GetMeasuredValue()

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

overridevirtual

Return the measured value for a given aGridAsset.

Implements wsf::coverage::Measure.

References GetDefaultValue().

◆ GetParameter()

double wsf::coverage::CoverageTime::GetParameter ( ) const

inline

Get the value of the parameter given to total_time_above or percent_time_above.

Returns: The value of the parameter given to total_time_above or percent_time_above if one of those is the sub-type, 1 otherwise.

◆ GetSampleSpan()

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

inline

Get the duration of samples for per-time subtypes.

◆ GetSubType()

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

inline

Get the sub-type enumeration that describes this CoverageTime instance.

◆ GetValueHeader()

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

overridevirtual

Return a string giving the header for this value in output files.

This header should be descriptive enough to be interpreted by a human reader. The return value will appear as a field in a CSV file, so there should not be any commas in the returned value.

Implements wsf::coverage::Measure.

References cMAX_PER_TIME, cMAX_PERCENT_PER_TIME, cMEAN_PER_TIME, cMEAN_PERCENT_PER_TIME, cMIN_PER_TIME, cMIN_PERCENT_PER_TIME, cPERCENT, cPERCENT_TIME_ABOVE, cSTD_DEV_PER_TIME, cSTD_DEV_PERCENT_PER_TIME, cTOTAL, cTOTAL_TIME_ABOVE, and cUNKNOWN.

◆ ProcessInput()

bool wsf::coverage::CoverageTime::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 cMEAN_PER_TIME, cUNKNOWN, WsfObject::GetType(), and wsf::coverage::Measure::ProcessInput().

Member Data Documentation

◆ cTYPE

const char* wsf::coverage::CoverageTime::cTYPE {"WSF_COVERAGE_TIME_MOE"}

staticconstexpr

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

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

◆ CoverageTime() [1/2]

◆ CoverageTime() [2/2]

◆ ~CoverageTime()

Member Function Documentation

◆ Clone()

◆ CollectionStarting()

◆ GetDefaultValue()

◆ GetMeasuredValue()

◆ GetParameter()

◆ GetSampleSpan()

◆ GetSubType()

◆ GetValueHeader()

◆ ProcessInput()

Member Data Documentation

◆ cTYPE