An MOE that measures if a grid asset has had any interaction with a free asset. More...
#include <WsfSimpleCoverage.hpp>
Public Member Functions | |
| SimpleCoverage (const WsfScenario &aScenario) | |
| SimpleCoverage (const SimpleCoverage &aOther)=default | |
| ~SimpleCoverage () override=default | |
| SimpleCoverage * | Clone () const override |
| double | GetMeasuredValue (const GridAsset &aGridAsset) const override |
Return the measured value for a given aGridAsset. | |
| double | GetDefaultValue () const override |
| Return the default value of the measure. | |
| std::string | GetValueHeader () const override |
| 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) |
| virtual void | CollectionStarting (Coverage &aCoverage, double aSimTime) |
| 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_SIMPLE_COVERAGE_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 if a grid asset has had any interaction with a free asset.
Constructor & Destructor Documentation
◆ SimpleCoverage() [1/2]
|
inlineexplicit |
References cTYPE, wsf::coverage::Measure::Measure(), and WsfObject::SetType().
Referenced by Clone(), and SimpleCoverage().
◆ SimpleCoverage() [2/2]
|
default |
References SimpleCoverage().
◆ ~SimpleCoverage()
|
overridedefault |
Member Function Documentation
◆ Clone()
|
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 SimpleCoverage().
◆ GetDefaultValue()
|
inlineoverridevirtual |
Return the default value of the measure.
Implements wsf::coverage::Measure.
◆ GetMeasuredValue()
|
overridevirtual |
Return the measured value for a given aGridAsset.
Implements wsf::coverage::Measure.
◆ GetValueHeader()
|
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.
Member Data Documentation
◆ cTYPE
|
staticconstexpr |
Referenced by wsf::coverage::MeasureTypes::MeasureTypes(), and SimpleCoverage().
The documentation for this class was generated from the following files: