|
WSF
|
#include <WsfTSPI_Mover.hpp>


Classes | |
| class | OpenError |
| struct | Point |
| struct | PathMovement |
| class | InitializeMoverEvent |
| class | TSPI_Model |
Public Types | |
| enum | EndPath { cEP_EXTRAPOLATE , cEP_STOP , cEP_REMOVE } |
| End of-path option. More... | |
| 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. | |
Public Member Functions | |
| WsfTSPI_Mover ()=delete | |
| WsfTSPI_Mover (WsfScenario &aScenario) | |
| ~WsfTSPI_Mover () override | |
| WsfMover * | Clone () const override |
| bool | Initialize (double aSimTime) override |
| bool | ProcessInput (UtInput &aInput) override |
| void | Update (double aSimTime) override |
| WsfSpatialDomain | GetSpatialDomain () const override |
| bool | IsStopped () const override |
| Return whether the mover (and its attached platform) is stopped. | |
| bool | IsPaused () const override |
| bool | IsExtrapolating () const override |
| bool | InitializeMover (double aSimTime) |
| void | CloseFile () |
| Close the TSPI input file. | |
| void | OpenFile (const std::string &aFileName) |
| double | SimStartTime () const |
| double | TSPI_StartTime () const |
| std::string | FileName () const |
| bool | SetFileName (const std::string &aName) |
| void | SetStartAtInitialTime (bool aValue) |
| void | SetDeleteOnDestruct (bool aValue) |
| void | TriggerExtrapolation () override |
| bool | Fetch_TSPI () |
| void | TranslateAndRotateToNewFile () |
| void | NormalizeLatLonDeg (double &aLatitudeDeg, double &aLongitudeDeg) |
| Fix Latitude and Longitude within conventional limits. | |
| WsfMover::KinematicModel * | CreateKinematicModel (double aSimTime, WsfStringId aModelTypeId, const double aLocationWCS[3], const double aVelocityWCS[3], WsfMover *aMoverPtr, WsfDraw *aDrawPtr) const override |
| 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 |
| WsfComponent * | CloneComponent () const override |
| int | GetComponentInitializationOrder () const override |
| const int * | GetComponentRoles () const override |
| void * | QueryInterface (int aRole) override |
| const char * | GetScriptClassName () const override |
| virtual void | SwapMoverInitiated (double aSimTime, WsfMover *aOldMoverPtr) |
| bool | Initialize2 (double aSimTime) override |
| 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 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) |
| virtual bool | GetFutureLocationWCS (double aSimTime, double aLocationWCS[3]) |
| 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 | |
| const int * | GetComponentRoles () const override |
| void * | QueryInterface (int aRole) 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 |
| bool | Initialize2 (double aSimTime) 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 bool | PreInitialize (double aSimTime) |
| 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 |
Protected Member Functions | |
| void | UpdateMover (double aSimTime) |
| 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) |
Additional Inherited Members | |
| 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 |
| 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 |
WsfTSPI_Mover is a specialization of WsfMover that updates position based on data from a file (see WsfTSPI for details.)
|
delete |
References WsfMover::WsfMover(), and WsfTSPI_Mover().
Referenced by Clone(), WsfTSPI_Mover::InitializeMoverEvent::InitializeMoverEvent(), WsfTSPI_Mover::TSPI_Model::TSPI_Model(), and WsfTSPI_Mover().
| WsfTSPI_Mover::WsfTSPI_Mover | ( | WsfScenario & | aScenario | ) |
References cEP_EXTRAPOLATE, and WsfMover::WsfMover().
|
override |
References CloseFile().
|
overridevirtual |
Clone this object.
Implements WsfMover.
References WsfMover::WsfMover(), and WsfTSPI_Mover().
| void WsfTSPI_Mover::CloseFile | ( | ) |
Close the TSPI input file.
Referenced by ~WsfTSPI_Mover().
|
overridevirtual |
Get the kinematic model of this mover if available. If aMoverPtr is null, "this" has been initialized (i.e., GetPlatform(), etc. will work); however, if aMoverPtr is non-null, "this" has not been initialized, so that any data needed from the simulation or scenario should be retrieved using aMoverPtr instead. In either case, the kinematic model needs to be extracted without disturbing the state of the platform to which either of "this" or aMoverPtr is attached.
| aSimTime | The current simulation time. |
| aPlatformTypeId | The platform type id that is being propagated kinematically. |
| aLocationWCS | The location of the platform at aSimTime. |
| aVelocityWCS | The velocity of the platform at aSimTime. |
| aMoverPtr | If non-null, a valid mover from which "this" should be initialized. |
| aDrawPtr | A WsfDraw object that can be used for custom visualization. |
Reimplemented from WsfMover.
References SimStartTime(), TSPI_StartTime(), and WsfMover::WsfMover().
| bool WsfTSPI_Mover::Fetch_TSPI | ( | ) |
Referenced by TranslateAndRotateToNewFile().
|
inline |
Referenced by WsfTSPI_Mover::TSPI_Model::TSPI_Model().
|
inlineoverridevirtual |
Return the spatial domain in which the mover is operating.
The spatial domain is the domain in which the mover is operating (land, sea, space, etc.).
Reimplemented from WsfMover.
References WSF_SPATIAL_DOMAIN_AIR.
|
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.
| aSimTime | The current simulation time. |
Reimplemented from WsfMover.
References WsfSimulation::AddEvent(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfMover::Initialize(), ok, OpenFile(), WsfMover::SetUpdateInterval(), and TranslateAndRotateToNewFile().
| bool WsfTSPI_Mover::InitializeMover | ( | double | aSimTime | ) |
Initialize the mover (called by InitializeMoverEvent::Execute()).
|
overridevirtual |
Return whether the mover is "extrapolating". 'Extrapolating' has a slightly different meaning depending on the mover, but it fundamentally means it is moving without any form of external guidance. In the case of a simple waypoint- following mover this means it has reached its final waypoint and has either stopped there or is continuing on at a specified direction, speed, and altitude. For movers that do not follow waypoints it is a little murkier, but it typically means that the motion is occuring without any propulsion. In this latter case it basically means that with a little knowledge an external observer could take the position at any time and use Newton's Laws to estimate future positions.
Reimplemented from WsfMover.
References WsfPlatformPart::GetPlatform().
|
overridevirtual |
Indicates that the platform is currently in "pause" mode, and is not moving, but may begin moving at some future time. Note that a "paused" platform may supply a non-zero velocity and/or acceleration, but still not move through space with advancing time.
Reimplemented from WsfMover.
References IsStopped().
|
overridevirtual |
Return whether the mover (and its attached platform) is stopped.
Reimplemented from WsfMover.
References WsfPlatformPart::GetPlatform().
Referenced by IsPaused().
| void WsfTSPI_Mover::NormalizeLatLonDeg | ( | double & | aLatitudeDeg, |
| double & | aLongitudeDeg ) |
Fix Latitude and Longitude within conventional limits.
| void WsfTSPI_Mover::OpenFile | ( | const std::string & | aFileName | ) |
Open the TSPI input file. This will throw an OpenError exception if the file cannot be opened or if a file is already opened.
References WsfPlatformPart::GetScenario(), WsfScenario::GetSystemLog(), and WsfSystemLog::WriteLogEntry().
Referenced by Initialize(), and TranslateAndRotateToNewFile().
|
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'.
| aInput | a reference to a UtInput object. |
| UtInput::ExceptionBase | (or an object derived from it) if the command was recognized but contains some sort of error. |
Reimplemented from WsfMover.
References cEP_EXTRAPOLATE, cEP_REMOVE, cEP_STOP, ok, WsfMover::ProcessInput(), and SetFileName().
|
inline |
| bool WsfTSPI_Mover::SetFileName | ( | const std::string & | aName | ) |
References WsfScenario::GetInput(), and WsfPlatformPart::GetScenario().
Referenced by ProcessInput(), and UT_DEFINE_SCRIPT_METHOD().
|
inline |
|
inline |
Referenced by CreateKinematicModel().
| void WsfTSPI_Mover::TranslateAndRotateToNewFile | ( | ) |
References Fetch_TSPI(), WsfPlatform::GetIndex(), WsfPlatformPart::GetPlatform(), and OpenFile().
Referenced by Initialize().
|
overridevirtual |
Way to artificially inject an extrapolation event into the simulation. (Primarily for script-driven TSPI Movers, to inform of a burnout event.)
Reimplemented from WsfMover.
Referenced by UT_DEFINE_SCRIPT_METHOD().
|
inline |
Referenced by CreateKinematicModel().
|
overridevirtual |
Update the kinematic state of the associated platform. Update the location, orientation, speed and acceleration of the attached platform to what it should be at the supplied time.
| aSimTime | The current simulation time. |
Reimplemented from WsfMover.
References cEP_REMOVE, cEP_STOP, WsfSimulation::DeletePlatform(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfMover::mLastUpdateTime, WsfMover::SetUpdateInterval(), and UpdateMover().
|
protected |
Update the mover, based on the current data from the TSPI input file
| aSimTime | The current simulation time. |
References WsfPlatformPart::GetPlatform(), and WsfMover::mLastUpdateTime.
Referenced by Update().