A simulation extension to manage WsfConstellation objects. More...
#include <WsfConstellationManager.hpp>
Public Member Functions | |
| WsfConstellationManager ()=default | |
| ~WsfConstellationManager () override=default | |
| bool | AddConstellation (std::unique_ptr< WsfConstellation > aConstellationPtr) |
| WsfConstellation * | FindConstellation (const std::string &aConstellationName) const |
| std::vector< WsfConstellation * > | GetConstellations () const |
| Return the constellations defined in the current simulation. | |
| Public Member Functions inherited from WsfSimulationExtension | |
| WsfSimulationExtension () | |
| ~WsfSimulationExtension () override=default | |
| WsfSimulation & | GetSimulation () const |
| const WsfScenario & | GetScenario () const |
| virtual void | AddedToSimulation () |
| virtual bool | Initialize () |
| virtual bool | PrepareExtension () |
| virtual bool | PlatformsInitialized () |
| virtual void | PendingStart () |
| virtual void | Start () |
| virtual void | Complete (double aSimTime) |
| Public Member Functions inherited from WsfExtension | |
| virtual | ~WsfExtension ()=default |
| const std::string & | GetExtensionName () const |
Static Public Member Functions | |
| static WsfConstellationManager & | Get (const WsfSimulation *aSimulation) |
Accessor to get a handle to the instance of this extension for the given aSimulation. | |
| static void | __private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr) |
Static Public Attributes | |
| static constexpr const char * | cEXTENSION_NAME {"wsf_constellation_manager"} |
Additional Inherited Members | |
| Protected Member Functions inherited from WsfExtension | |
| void | InitializeExtensionName (const std::string &aName) |
Detailed Description
A simulation extension to manage WsfConstellation objects.
Constructor & Destructor Documentation
◆ WsfConstellationManager()
|
default |
Referenced by Get(), and ~WsfConstellationManager().
◆ ~WsfConstellationManager()
|
overridedefault |
References WsfConstellationManager(), and WsfSimulationExtension::WsfSimulation.
Member Function Documentation
◆ AddConstellation()
| bool WsfConstellationManager::AddConstellation | ( | std::unique_ptr< WsfConstellation > | aConstellationPtr | ) |
Add a constellation to this manager.
This will add the given constellation to this manager if there is not already a constellation with the name of the given aConstellationPtr. This returns true if the constellation was successfully added to the manager, or false otherwise.
- Parameters
-
aConstellationPtr - The constellation to add.
- Returns
- - true if the constellation was successfully added; false otherwise.
◆ FindConstellation()
| WsfConstellation * WsfConstellationManager::FindConstellation | ( | const std::string & | aConstellationName | ) | const |
Return the constellation with the given name, if it exists.
- Parameters
-
aConstellationName - The name of the constellation to find.
- Returns
- - The constellation if there is a constellation with that name; nullptr otherwise.
Referenced by UT_DEFINE_SCRIPT_METHOD().
◆ Get()
|
static |
Accessor to get a handle to the instance of this extension for the given aSimulation.
References cEXTENSION_NAME, WsfSimulation::GetExtension(), WsfConstellationManager(), and WsfSimulationExtension::WsfSimulation.
Referenced by UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().
◆ GetConstellations()
| std::vector< WsfConstellation * > WsfConstellationManager::GetConstellations | ( | ) | const |
Return the constellations defined in the current simulation.
Referenced by UT_DEFINE_SCRIPT_METHOD().
Member Data Documentation
◆ cEXTENSION_NAME
|
staticconstexpr |
Referenced by Get(), and WsfSpaceExtension::SimulationCreated().
The documentation for this class was generated from the following files: