wsf::coverage::TimeAverageGap Class Reference

An MOE that measures timing of gaps in coverage. More...

#include <WsfCoverageTimeAverageGap.hpp>

Inheritance diagram for wsf::coverage::TimeAverageGap:

Collaboration diagram for wsf::coverage::TimeAverageGap:

Public Member Functions
	TimeAverageGap (const WsfScenario &aScenario)
	TimeAverageGap (const TimeAverageGap &aOther)=default
	~TimeAverageGap () override=default
TimeAverageGap *	Clone () const override
double	GetMeasuredValue (const GridAsset &aGridAsset) const override
	Return the measured value for the given aGridAsset.
double	GetDefaultValue () const override
	Return the default value for the measure if there were no accesses.
void	CollectionStarting (Coverage &aCoverage, double aSimTime) override
std::string	GetValueHeader () const override
	Return the text header for output files for this MOE.
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_TIME_AVERAGE_GAP_MOE"}

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
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 timing of gaps in coverage.

Constructor & Destructor Documentation

TimeAverageGap() [1/2]

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

inlineexplicit

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

Referenced by Clone(), and TimeAverageGap().

TimeAverageGap() [2/2]

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

default

References TimeAverageGap().

~TimeAverageGap()

wsf::coverage::TimeAverageGap::~TimeAverageGap ( )

overridedefault

Member Function Documentation

Clone()

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

CollectionStarting()

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

overridevirtual

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

Implements wsf::coverage::Measure.

Referenced by GetMeasuredValue().

GetMeasuredValue()

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

overridevirtual

Return the measured value for the given aGridAsset.

Implements wsf::coverage::Measure.

References GetDefaultValue().

GetValueHeader()

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

overridevirtual

Return the text header for output files for this MOE.

Implements wsf::coverage::Measure.

Member Data Documentation

cTYPE

const char* wsf::coverage::TimeAverageGap::cTYPE {"WSF_TIME_AVERAGE_GAP_MOE"}

staticconstexpr

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

---

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

• WsfCoverageTimeAverageGap.hpp
• WsfCoverageTimeAverageGap.cpp