WsfNORAD_SpaceMover Class Reference
WsfNORAD_SpaceMover is a specialization of WsfMover for earth-orbiting satellites. More...
#include <WsfNORAD_SpaceMover.hpp>
Inheritance diagram for WsfNORAD_SpaceMover:
Collaboration diagram for WsfNORAD_SpaceMover:
Public Member Functions | |
| WsfNORAD_SpaceMover (const WsfScenario &aScenario) | |
| WsfNORAD_SpaceMover (const WsfNORAD_SpaceMover &aSrc) | |
| WsfNORAD_SpaceMover & | operator= (const WsfNORAD_SpaceMover &)=delete |
| ~WsfNORAD_SpaceMover () override=default | |
| Public Member Functions inherited from WsfSpaceMoverBase | |
| WsfSpaceMoverBase ()=delete | |
| WsfSpaceMoverBase (const WsfScenario &aScenario, std::unique_ptr< UtOrbitalPropagatorBase > aPropagatorPtr, const std::string &aScriptClassName="WsfSpaceMover") | |
| WsfSpaceMoverBase (const WsfSpaceMoverBase &aSrc) | |
| WsfSpaceMoverBase & | operator= (const WsfSpaceMoverBase &)=delete |
| ~WsfSpaceMoverBase () override | |
| WSF_SPACE_DEPRECATED WsfGeoPoint | GetInitialPositionLLA () const |
| UtVec3d | GetInitialPositionECI () const |
| UtVec3d | GetInitialPositionWCS () const |
| UtVec3d | GetInitialVelocityECI () const |
| UtVec3d | GetInitialVelocityWCS () const |
| const char * | GetScriptClassName () const override |
| WsfSpatialDomain | GetSpatialDomain () const override |
| bool | IsExtrapolating () const override |
| const UtOrbitalPropagatorBase & | GetPropagator () const |
| Return a reference to the orbital propagator associated with this space mover. | |
| UtOrbitalPropagatorBase & | GetPropagator () |
| Return a reference to the orbital propagator associated with this space mover (non-const version). | |
| const WsfOrbitalManeuvering & | GetOrbitalManeuvering () const |
| Return the maneuvering model for this space mover. | |
| bool | InitializeOrbitalManeuvering (const UtCalendar &aEpoch) |
| Initialize just the orbital maneuvering model. | |
| const WsfOrbitalEvent * | GetCurrentMissionEvent () const |
| Return the current maneuver, if any, being performed by this mover. | |
| const WsfOrbitalMissionSequence & | GetMissionEvents () const |
| void | ScheduleMission (const UtCalendar &aEpoch, std::unique_ptr< WsfOrbitalMissionSequence > aMissionEventsPtr) |
| void | CancelMission () |
| bool | VerifyMission (const UtCalendar &aEpoch, const WsfOrbitalMissionSequence &aSequence, wsf::space::verify::PreOperation aPreVerifyOp=wsf::space::verify::PreOperation{}, wsf::space::verify::PostOperation aPostVerifyOp=wsf::space::verify::PostOperation{}) const |
| bool | VerifyMission (const UtCalendar &aEpoch) const |
| WsfAttitudeController & | GetAttitudeController () |
| Return a reference to the attitude controller associated with this space mover. | |
| double | GetSimTimeOfEpoch () const |
| WsfScriptContext & | GetScriptContext () |
| Return a reference to the script context. | |
| void | UpdatePropagation (const UtCalendar &aEpoch) |
| const UtCalendar & | GetCurrentTime () const |
| Get the current propagation time. | |
| double | GetElementOutputUpdateInterval () const |
| Get the interval between entries in an event pipe of this mover's elements. | |
| const std::string & | GetDescriptor () const |
| Return the descriptor associated with this mover. | |
| const std::string & | GetDesignator () const |
| Return the designator associated with this mover. | |
| const ut::OrbitalState & | GetInitialOrbitalState () const |
| Return the initial unpropagated orbital state. | |
| double | GetInitialHeading () const |
| void | SetInitialOrbitalState (const ut::OrbitalState &aState) |
| A pass-through method to set the initial orbital state. | |
| bool | GetFutureLocationWCS (double aSimTime, double aLocationWCS[3]) final |
| Return the WCS location at some time aSimTime in the future. | |
| WsfMover::KinematicModel * | CreateKinematicModel (double aSimTime, WsfStringId aModelTypeId, const double aLocationWCS[3], const double aVelocityWCS[3], WsfMover *aMoverPtr, WsfDraw *aDrawPtr) const override |
| void | SetTargetOrientationECI (double aPsi, double aTheta, double aPhi) |
| Set the mover's target ECI orientation. | |
| ut::optional< UtColor > | GetOrbitColor () const |
| UtColor | GetOrbitColorValue () const |
| bool | OrbitColorSet () const |
| void | UpdateColor (double aSimTime, const UtColor &aColor) |
| void | SetOrbitColor (const std::string &aOrbitColor) |
| void | SetOrbitColor (const UtColor &aOrbitColor) |
| bool | IsTLEInputAllowed () const noexcept |
| void | SetTLEInputAllowed (bool aTLE_InputAllowed) noexcept |
| double | GetLookAngleTo (const UtVec3d &aLocationWCS) const |
| double | GetIncidenceAngle (const UtVec3d &aLocationWCS) const |
| double | GetTargetElevationAngle (const UtVec3d &aLocationWCS) const |
| double | GetSquintAngleTo (const UtVec3d &aLocationWCS) const |
| double | GetDistanceToHorizon () const |
| double | GetLookAngleToHorizon () const |
| WsfMover * | Clone () const override |
| const int * | GetComponentRoles () const override |
| void * | QueryInterface (int aRole) override |
| bool | PreInitialize (double aSimTime) override |
| bool | Initialize (double aSimTime) override |
| bool | Initialize2 (double aSimTime) override |
| bool | ProcessInput (UtInput &aInput) override |
| void | Update (double aSimTime) override |
| const ut::OrbitalState & | GetOrbitalState () const |
| Return the current propagated orbital state. | |
| double | GetAvailableDeltaV () const |
| double | GetRequiredDuration (double aDeltaV) const |
| double | GetRequiredDeltaV (double aDuration) const |
| double | GetManeuverDuration (const UtCalendar &aEpoch, const WsfOrbitalManeuver &aManeuver, double aDeltaV) const |
| bool | PerformStagingOperation () |
| const ut::CentralBody & | GetCentralBody () const |
| const ut::CentralPoint & | GetCentralPoint () const |
| bool | Maneuver (const UtCalendar &aEpoch, const UtVec3d &aCommandedDeltaV, UtVec3d &aActualDeltaV) |
| Public Member Functions inherited from WsfMover | |
| WsfMover ()=delete | |
| WsfMover (const WsfScenario &aScenario) | |
| WsfMover (const WsfMover &aSrc) | |
| WsfMover & | operator= (const WsfMover &)=delete |
| ~WsfMover () override | |
| virtual double | TurnRadius (double atSpeed) |
| WsfModeList * | GetModeList () const |
| virtual void | TriggerExtrapolation () |
| WsfComponent * | CloneComponent () const override |
| int | GetComponentInitializationOrder () const override |
| const char * | GetScriptClassName () const override |
| virtual void | SwapMoverInitiated (double aSimTime, WsfMover *aOldMoverPtr) |
| void | TurnOff (double aSimTime) override |
| void | TurnOn (double aSimTime) override |
| void | SetNonOperational (double aSimTime) override |
| void | SetOperational (double aSimTime) override |
| void | PartBroken (double aSimTime) override |
| void | Restore (double aSimTime) override |
| virtual bool | IsStopped () const |
| Return whether the mover (and its attached platform) is stopped. | |
| virtual bool | IsPaused () const |
| virtual void | SetHeading (double aHeading) |
| virtual void | SetPitch (double aPitch) |
| virtual void | SetRoll (double aRoll) |
| virtual void | SetOrientationNED (double aHeading, double aPitch, double aRoll) |
| virtual void | ResetPosition (double aSimTime) |
| Informs the mover to use the current platform state. | |
| double | GetLastUpdateTime () const |
| double | GetUpdateInterval () const override |
| double | GetUpdateTimeTolerance () const |
| void | SetUpdateInterval (double aUpdateInterval) override |
| void | SetLastUpdateTime (double aLastUpdateTime) |
| virtual bool | UpdateAllowed () const |
| bool | UpdateWhenBroken () const |
| void | SetUpdateWhenBroken () |
| void | SetNoUpdateWhenBroken () |
| virtual const WsfRoute * | GetRoute () const |
| virtual const WsfRoute * | GetDefaultRoute () const |
| virtual int | RoutePointIndex () const |
| virtual bool | GoToAltitude (double aSimTime, double aAltitude, double aClimbDiveRate, bool aKeepRoute) |
| virtual bool | ReturnToRoute (double aSimTime) |
| virtual bool | GoToClosestPoint (double aSimTime) |
| virtual bool | GoToLabel (double aSimTime, WsfStringId aLabelId) |
| virtual bool | GoToLocation (double aSimTime, double aLatitude, double aLongitude, double aAltitude) |
| virtual bool | GoToSpeed (double aSimTime, double aSpeed, double aLinearAccel, bool aKeepRoute) |
| virtual bool | TurnToHeading (double aSimTime, double aHeading, double aRadialAccel, WsfPath::TurnDirection aTurnDirection) |
| virtual bool | TurnToRelativeHeading (double aSimTime, double aHeadingChange, double aRadialAccel, WsfPath::TurnDirection aTurnDirection) |
| virtual bool | SetRoute (double aSimTime, const WsfRoute &aRoute) |
| virtual bool | UpdateRoute (double aSimTime, const WsfRoute &aRoute) |
| virtual bool | UpdateDefaultRoute () |
| virtual bool | GoToWaypoint (double aSimTime, unsigned int aDestination) |
| virtual bool | FindAndSetPath (double aSimTime, WsfGeoPoint *aStartPtr, WsfGeoPoint *aEndPtr) |
| virtual bool | FlyRates (const UtVec3d &aAngularRates, const UtVec3d &aLongitudinalAccel) |
| virtual bool | FlyHeadingSpeedAltitude (double aHeading, double aSpeed, double aAltitude, double aMaxGees, double aMaxClimb) |
| virtual bool | TurnInPlaneWithSpeed (const UtVec3d &aPlane, double aGees, double aSpeed) |
| virtual bool | TurnInPlaneWithThrottle (const UtVec3d &aPlane, double aGees, double aThrottle) |
| virtual bool | FlyVectorWithSpeed (const UtVec3d &aVelocityVector, double aMaxGees, double aSpeed) |
| virtual bool | FlyVectorWithThrottle (const UtVec3d &aVelocityVector, double aMaxGees, double aThrottle) |
| virtual bool | ExecuteTriggers (double aSimTime, unsigned int aPointIndex) |
| WsfStringId | GetModeId () const |
| virtual void | SetMode (WsfStringId aModeName) |
| bool | ThreadSafe () const |
| Returns true if the mover update is thread safe. | |
| void | SetThreadSafe () |
| void | SetNotThreadSafe () |
| virtual void | InitializeProperties () |
| Add any input properties and its default value common properties list. | |
| virtual bool | PropertyExists (const std::string &aPropertyName) |
| Return true if the given property exists in the set of properties. | |
| virtual void | RegisterProperty (const std::string &aPropertyName, const int &aProperty) |
| Add an integer property to the common set of properties. | |
| virtual void | RegisterProperty (const std::string &aPropertyName, const double &aProperty) |
| Add an floating point property to the common set of properties. | |
| virtual void | RegisterProperty (const std::string &aPropertyName, const std::string &aProperty) |
| Add an string property to the set of common properties. | |
| virtual bool | GetPropertyInt (const std::string &aPropertyName, int &aProperty) |
| virtual bool | GetPropertyDouble (const std::string &aPropertyName, double &aProperty) |
| virtual bool | GetPropertyString (const std::string &aPropertyName, std::string &aProperty) |
| virtual double | GetThrottlePosition () |
| Public Member Functions inherited from WsfPlatformPart | |
| WsfPlatformPart (const WsfScenario &aScenario, int aPartType) | |
| WsfPlatformPart & | operator= (const WsfPlatformPart &aRhs)=delete |
| ~WsfPlatformPart () override | |
| bool | DebugEnabled () const |
| Returns 'true' if debugging is enabled for this instance. | |
| void | SetDebugEnabled (bool aDebugEnabled) |
| unsigned int | GetDebugMask () |
| bool | IsExternallyControlled () const |
| virtual void | SetExternallyControlled (double aSimTime, bool aIsExternallyControlled) |
| int | GetPartType () const |
| const char * | GetScriptClassName () const override |
| WsfSimulation * | GetSimulation () const |
| const WsfScenario & | GetScenario () const |
| WsfStringId | GetComponentName () const override |
| void | ComponentParentChanged (WsfPlatform *aPlatformPtr) override |
| WsfPlatform * | GetPlatform () const |
| virtual void | SetPlatform (WsfPlatform *aPlatformPtr) |
| virtual void | PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr) |
| virtual void | PlatformDeleted (WsfPlatform *aPlatformPtr) |
| double | GetLastStatusChangeTime () const |
| void | SetLastStatusChangeTime (double aSimTime) |
| Allows a system to set the time at which the device was initialized. | |
| bool | CanBeMadeOperational () const |
| Returns an indication that this system can be made operational. | |
| bool | CanBeMadeNonOperational () const |
| Returns an indication that this system can be made non-operational. | |
| bool | CanBeTurnedOn () const |
| Returns an indication that this system can be turned on. | |
| bool | CanBeTurnedOff () const |
| Returns an indication that this system can be turned off. | |
| bool | IsTurnedOn () const |
| bool | InitiallyTurnedOn () const |
| Is the system to be turned 'on' when added to the simulation? | |
| void | SetInitiallyTurnedOn (bool aInitiallyTurnedOn) |
| Sets if the system is turned on when added to the simulation. | |
| bool | IsOperational () const |
| bool | SetOperational (double aSimTime, bool aMakeOperational) |
| double | GetDamageFactor () const |
| bool | SetDamageFactor (double aSimTime, double aDamageFactor) |
| bool | IsCritical () const |
| void | SetCritical (bool aValue) |
| virtual void | OnPlatformBrokenEvent (double aSimTime) |
| Owning platform has issued a broken event. | |
| bool | IsBroken () const |
| WsfInternalLinks & | GetInternalLinks () |
| Return the internal links for this part. | |
| virtual bool | HasInternalLinks () const |
| Does this platform part have a communication link to other platform parts? | |
| virtual bool | ProcessMessage (double aSimTime, const WsfMessage &aMessage) |
| virtual bool | ReceiveMessage (double aSimTime, const WsfMessage &aMessage) |
| virtual void | SendMessage (double aSimTime, const WsfMessage &aMessage) |
| virtual void | SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId) |
| void | SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId) |
| virtual void | SendQueuedMessages (double aSimTime) |
| const WsfCategoryList & | GetCategories () const |
| Get the categories to which this part belongs. | |
| void | AddCategory (WsfStringId aCategoryId) |
| Adds the provided category to the platform part's category list. | |
| bool | IsCategoryMember (WsfStringId aCategoryId) const |
| const WsfGroupList & | GetGroups () const |
| Get the groups to which this platform part belongs. | |
| void | JoinGroup (WsfGroup *aGroupPtr) |
| Join the given group. | |
| void | LeaveGroup (WsfGroup *aGroupPtr) |
| Leave the given group. | |
| bool | IsGroupMember (WsfStringId aGroupId) |
| unsigned int | GetUpdateEventEpoch () const |
| void | IncrementUpdateEventEpoch () |
| bool | UpdateEventActive () const |
| Is an 'Update' event active? | |
| void | SetUpdateEventActive (bool aUpdateEventActive) |
| Indicate if the 'Update' event is active. | |
| 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) |
| Public Member Functions inherited from WsfComponentT< WsfPlatform > | |
| WsfComponentT () | |
| WsfComponentT (const WsfComponentT &) noexcept | |
| WsfComponentT & | operator= (const WsfComponentT &) noexcept |
| ~WsfComponentT () override=default | |
| ParentType * | GetComponentParent () const |
| void | SetComponentParent (ParentType *aParentPtr) |
| Public Member Functions inherited from WsfComponent | |
| virtual | ~WsfComponent ()=default |
| template<typename T> | |
| bool | QueryInterfaceT (T *&aRolePtr) |
| bool | ComponentHasRole (int aRole) |
| Returns true if the component has the specified role. | |
| virtual void | PreInput () |
| Public Member Functions inherited from WsfUniqueId | |
| WsfUniqueId () | |
| Construtor initializes the unique identifier to 0. | |
| WsfUniqueId (const WsfUniqueId &) | |
| Copy constructor initializes the unique identifier to 0. | |
| WsfUniqueId & | operator= (const WsfUniqueId &) |
| unsigned int | GetUniqueId () const |
| Get the unique identifier assigned to this object. | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| For XIO (de)serialization. | |
| Public Member Functions inherited from WsfAuxDataEnabled | |
| WsfAuxDataEnabled ()=default | |
| WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default | |
| WsfAuxDataEnabled & | operator= (const WsfAuxDataEnabled &aRhs) |
| WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default | |
| WsfAuxDataEnabled & | operator= (WsfAuxDataEnabled &&)=default |
| virtual | ~WsfAuxDataEnabled () noexcept |
| void | SetAuxData (const WsfAttributeContainer &aAuxData) |
| void | DeleteAuxData () |
| Delete the aux data container from the object. | |
| void | MergeAuxData (const WsfAuxDataEnabled &aSrc) |
| Merge the object's aux data with aux data from an existing object. | |
| void | UpdateAuxData (const WsfAuxDataEnabled &aSrc) |
| Update the object's aux data with aux data from an existing object. | |
| bool | HasAuxData () const |
| Returns true if this object has aux data. | |
| bool | ProcessInput (UtInput &aInput) |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| (De)serialization for XIO | |
| WsfAttributeContainer & | GetAuxData () |
| const WsfAttributeContainer & | GetAuxData () const noexcept |
| const WsfAttributeContainer & | GetAuxDataConst () const noexcept |
Common framework methods. | |
| WsfMover * | Clone () const override |
| bool | ProcessInput (UtInput &aInput) override |
| bool | Initialize (double aSimTime) override |
| bool | SetInitialPoint (double aLat, double aLon, double aAlt, double aSpeed, double aHeading) override |
| Set the initial point of the mover. | |
Additional Inherited Members | |
| Public Types inherited from WsfPlatformPart | |
| enum | { cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 } |
| using | InternalMessageQueue = std::queue<WsfMessage*> |
| using | RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart*, WsfMessage*>> |
| Public Types inherited from WsfObject | |
| typedef std::vector< WsfStringId > | TypeList |
| The list of types returned by GetTypeList. | |
| Public Types inherited from WsfComponentT< WsfPlatform > | |
| typedef WsfPlatform | ParentType |
| This is needed to support the WsfComponentList template. | |
| Static Public Attributes inherited from WsfMover | |
| static const char * | cTYPE_KIND = "mover" |
| Static Public Attributes inherited from WsfAuxDataEnabled | |
| static UtCallbackListN< void(const WsfAuxDataEnabled *)> | AuxDataAccessed |
| static UtCallbackListN< void(const WsfAuxDataEnabled *)> | AuxDataDestroyed |
| void | SetModeList (WsfModeList *aModeListPtr) |
| void | SetUpdateTimeTolerance (double aDt) |
| Revise the internal time tolerance allowed for Update() sequencing logic. | |
| WsfPlatformPart (const WsfPlatformPart &aSrc) | |
| Copy constructor (for Clone()). | |
| WsfObject (const WsfObject &aSrc) | |
| Copy constructor (for Clone()). | |
| Protected Member Functions inherited from WsfUniqueId | |
| void | AssignUniqueId (WsfSimulation *aSimulationPtr) |
| double | mLastUpdateTime |
| The simulation time when Update was last called. | |
| WsfVariable< double > | mUpdateTimeTolerance |
| bool | mThreadSafe |
| std::vector< WsfMoverMode * > | mMoverModeList |
| The generic list of modes (not valid until Initialize is called). | |
| WsfStringId | mModeId |
Detailed Description
WsfNORAD_SpaceMover is a specialization of WsfMover for earth-orbiting satellites.
Constructor & Destructor Documentation
◆ WsfNORAD_SpaceMover() [1/2]
|
explicit |
References WsfSpaceMoverBase::SetTLEInputAllowed(), and WsfSpaceMoverBase::WsfSpaceMoverBase().
Referenced by Clone(), operator=(), and WsfNORAD_SpaceMover().
◆ WsfNORAD_SpaceMover() [2/2]
| WsfNORAD_SpaceMover::WsfNORAD_SpaceMover | ( | const WsfNORAD_SpaceMover & | aSrc | ) |
◆ ~WsfNORAD_SpaceMover()
|
overridedefault |
References WsfMover::WsfMover().
Member Function Documentation
◆ Clone()
|
overridevirtual |
Clone this object.
- Returns
- a pointer to the new object.
Implements WsfMover.
References WsfMover::WsfMover(), and WsfNORAD_SpaceMover().
◆ Initialize()
|
overridevirtual |
Initialize the kinematic state of the associated platform. Fix the initial location, orientation, speed and acceleration of the attached platform to what it should be at the beginning of its existence.
- Parameters
-
aSimTime The current simulation time.
- Returns
- True if successful.
Reimplemented from WsfMover.
References WsfSimulation::GetDateTime(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSpaceMoverBase::GetPropagator(), WsfPlatformPart::GetSimulation(), WsfDateTime::GetStartDateAndTime(), and WsfSpaceMoverBase::Initialize().
◆ operator=()
|
delete |
References WsfNORAD_SpaceMover().
◆ ProcessInput()
|
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 WsfMover.
References WsfSpaceMoverBase::ProcessInput().
◆ SetInitialPoint()
|
overridevirtual |
Set the initial point of the mover.
Reimplemented from WsfSpaceMoverBase.
The documentation for this class was generated from the following files: