wsf::coverage::SensorCoverage Class Reference
Compute coverage from sensor interactions. More...
#include <WsfSensorCoverage.hpp>
Inheritance diagram for wsf::coverage::SensorCoverage:
Collaboration diagram for wsf::coverage::SensorCoverage:
Public Member Functions | |
| SensorCoverage (const WsfScenario &aScenario) | |
| SensorCoverage (const SensorCoverage &aOther)=default | |
| ~SensorCoverage () override=default | |
| SensorCoverage * | Clone () const override |
| Public Member Functions inherited from wsf::coverage::Coverage | |
| Coverage (const WsfScenario &aScenario) | |
| Coverage (const Coverage &aOther)=default | |
| ~Coverage () override=default | |
| bool | ProcessInput (UtInput &aInput) override |
| bool | Initialize (WsfSimulation &aSimulation) |
| bool | ResolveAssets (WsfSimulation &aSimulation) |
| void | CategorizePlatforms (const WsfSimulation &aSimulation) |
| void | PendingStart (WsfSimulation &aSimulation) |
| void | Finalize (double aSimTime, const UtCalendar &aSimStartEpoch) |
| AccessIntervalStartCallback & | AccessIntervalStart () |
| AccessIntervalEndCallback & | AccessIntervalEnd () |
| AccessIntervalCompleteCallback & | AccessIntervalComplete () |
| const Grid * | GetGrid () const |
| const std::string & | GetOutputDir () const |
| bool | InCoverageInterval (double aSimTime) const |
| Does the given simulation time fall inside this object's coverage interval? | |
| double | GetStartTime () const |
| Return the simulation time of the start of the coverage interval. | |
| double | GetEndTime () const |
| Return the simulation time of the end of the coverage interval. | |
| const UtCalendar & | GetStartEpoch () const |
| Return the date and time of the start of the coverage interval. | |
| bool | IsStartEpochDefined () const |
| Has the start epoch been given a value? | |
| const UtCalendar & | GetEndEpoch () const |
| Return the date and time of the end of the coverage interval. | |
| bool | IsEndEpochDefined () const |
| Has the end epoch been given a value? | |
| bool | IsAsset (const WsfPlatform *aPlatformPtr) const |
Return if the given aPlatformPtr is either a grid or free asset for this coverage. | |
| bool | IsFreeAsset (const WsfPlatform *aPlatformPtr) const |
Return if the given aPlatformPtr is a free asset for this coverage. | |
| bool | IsGridAsset (const WsfPlatform *aPlatformPtr) const |
Return if the given aPlatformPtr is a grid asset for this coverage. | |
| bool | IsPlatformOfType (const std::string &aPlatformName, const std::string &aPlatformType) const |
Return if the platform with the given aPlatformName has the given aPlatformType. | |
| bool | IsPlatformDeviceOfType (const std::string &aPlatformName, const std::string &aDeviceName, const std::string &aDeviceType) const |
| 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_SENSOR_COVERAGE"} |
Additional Inherited Members | |
| Public Types inherited from wsf::coverage::Coverage | |
| using | AccessIntervalStartCallback = UtCallbackListN<void(const GridAsset&, const FreeAsset&, double)> |
| using | AccessIntervalEndCallback = UtCallbackListN<void(const GridAsset&, const FreeAsset&, double)> |
| using | AccessIntervalCompleteCallback = UtCallbackListN<void(const GridAsset&, const FreeAsset&, const AccessInterval&)> |
| Public Types inherited from WsfObject | |
| typedef std::vector< WsfStringId > | TypeList |
| The list of types returned by GetTypeList. | |
| Protected Member Functions inherited from wsf::coverage::Coverage | |
| void | SetGrid (const Grid *aGridPtr) |
| void | AddIntervalStartToData (const GridAsset &aGridAsset, const FreeAsset &aFreeAsset, double aSimTime) |
| void | AddIntervalEndToData (const GridAsset &aGridAsset, const FreeAsset &aFreeAsset, double aSimTime) |
| const std::string & | GetGridAssetCategory () const |
| Return the category assigned to grid asset platforms for this coverage. | |
| const std::string & | GetFreeAssetCategory () const |
| Return the category assigned to free asset platform for this coverage. | |
| WsfObject (const WsfObject &aSrc) | |
| Copy constructor (for Clone()). | |
| Protected Attributes inherited from wsf::coverage::Coverage | |
| std::set< FreeAsset > | mFreeAssets {} |
| Free assets for this coverage. | |
| UtCallbackHolder | mCallbacks {} |
Detailed Description
Compute coverage from sensor interactions.
Constructor & Destructor Documentation
◆ SensorCoverage() [1/2]
|
inlineexplicit |
References wsf::coverage::Coverage::Coverage(), cTYPE, and WsfObject::SetType().
Referenced by Clone(), and SensorCoverage().
◆ SensorCoverage() [2/2]
|
default |
References SensorCoverage().
◆ ~SensorCoverage()
|
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::Coverage.
References SensorCoverage().
Member Data Documentation
◆ cTYPE
|
staticconstexpr |
Referenced by wsf::coverage::CoverageTypes::CoverageTypes(), and SensorCoverage().
The documentation for this class was generated from the following files: