#include <WsfOrbitalStagingEvent.hpp>

Inheritance diagram for WsfOrbitalStagingEvent:

[legend]

Collaboration diagram for WsfOrbitalStagingEvent:

[legend]

Public Member Functions
	WsfOrbitalStagingEvent (const WsfScenario &aScenario)
	WsfOrbitalStagingEvent (const WsfOrbitalStagingEvent &aSrc)
	~WsfOrbitalStagingEvent () override
WsfOrbitalEvent *	Clone () const override
	Make a copy of this object.
const char *	GetScriptClassName () const override
void	Accept (WsfOrbitalEventVisitor *aVisitorPtr) override
Public Member Functions inherited from WsfOrbitalEvent
	WsfOrbitalEvent (const WsfOrbitalEvent &aSrc)
WsfOrbitalEvent &	operator= (const WsfOrbitalEvent &)=delete
	~WsfOrbitalEvent () override=default
bool	ProcessInput (UtInput &aInput) override
virtual bool	Initialize (const UtCalendar &aEpoch, const wsf::space::OrbitalMissionContext &aContext)
bool	CanVerify () const
	Return whether this event can be verified.
virtual bool	VerifyCondition () const
virtual bool	EvaluatePreconditions (const wsf::space::OrbitalMissionContext &aContext) const
virtual bool	EvaluatePostconditions (const wsf::space::OrbitalMissionContext &aContext) const
virtual bool	ValidateParameterRanges (const std::string &aExecutingPlatformName) const
bool	IsComplete () const
	Return whether the event is complete.
bool	IsCanceled () const
	Return whether the event is canceled.
void	SetCanceled ()
	Mark the event as canceled.
bool	Execute (const UtCalendar &aEpoch, wsf::space::OrbitalMissionContext &aContext)
const char *	GetScriptClassName () const override
bool	IsFinite () const
void	SetFinite (bool aIsFinite)
	Set whether the event is finite.
bool	HasExecuted () const
	Return whether the event has executed at least once (i.e., Execute() has been called).
const wsf::space::OrbitalPropagatorCondition &	GetCondition () const
	Return the condition for event execution (const).
wsf::space::OrbitalPropagatorCondition &	GetCondition ()
	Return the condition for event execution (non-const).
WsfStringId	GetConditionString () const
	Return the condition string for event execution.
void	SetCondition (std::unique_ptr< wsf::space::OrbitalPropagatorCondition > aConditionPtr)
	Set the condition for execution.
const UtCalendar &	GetStartTime () const
	Return the time at which the event will begin executing.
void	SetStartTime (const UtCalendar &aStartTime)
	Set the start time to begin event execution.
const UtCalendar &	GetEvaluationTime () const
	Return the nominal time to execute the event impulsively.
UtTimeValue	GetDuration () const
	Return the full duration of the event. If the event is impulsive, this method returns 0.
void	SetDuration (const UtTimeValue &aDuration)
	Set the full duration of the event. A value of 0 implies and impulsive event; otherwise it is finite.
void	SetOnlyDuration (const UtTimeValue &aDuration)
UtTimeValue	GetUpdateInterval () const
	For finite events, return the interval at which the event is to be re-evaluated.
void	SetUpdateInterval (const UtTimeValue &aUpdateInterval)
	Set the update interval for which the event is to be re-evaluated.
virtual const WsfOrbitalEvent *	GetCurrentMissionEvent () const
virtual WsfOrbitalEvent *	GetCurrentMissionEvent ()
virtual WsfOrbitalEvent *	AdvanceMissionEvent (const UtCalendar &aEpoch, const wsf::space::OrbitalMissionContext &aContext)
virtual bool	IsSequence () const
	Is this MissionEvent a MissionEvent sequence (WsfMissionEventSequence)?
virtual double	GetRequiredDeltaV (const UtOrbitalPropagatorBase &aPropagator) const
	Return the minimum required delta-v needed to complete this event; the default is to return 0.0.
virtual double	GetDeltaV () const
	Get the delta V expended to execute this event; the default is to return 0.0.
virtual bool	GetNextExecutionTime (const UtCalendar &aCurrentTime, const UtOrbitalPropagatorBase &aPropagator, UtCalendar &aNextExecutionTime)
	For finite events, return the next time the event should be executed.
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 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 Member Functions
static WsfStringId	GetTypeId ()
Static Public Member Functions inherited from WsfOrbitalEvent
static WsfOrbitalEvent *	Create (const WsfScenario &aScenario, UtInput &aInput, bool aIgnoreSomeExceptions=false)

Protected Member Functions
bool	ExecuteEvent (const UtCalendar &aEpoch, wsf::space::OrbitalMissionContext &aContext) override
Protected Member Functions inherited from WsfOrbitalEvent
	WsfOrbitalEvent (const WsfScenario &aScenario)
virtual bool	InitializeVariables (const UtCalendar &aCurrentTime, const UtCalendar &aEvaluationTime, const wsf::space::OrbitalMissionContext &aContext)
virtual bool	InitializeTimes (const UtCalendar &aEpoch, const wsf::space::OrbitalMissionContext &aContext)
virtual bool	EvaluateCompletion (const UtCalendar &aEpoch, const UtOrbitalPropagatorBase &aPropagator)
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Static Protected Member Functions inherited from WsfOrbitalEvent
static WsfOrbitalEvent *	Create (const WsfScenario &aScenario, WsfStringId aType)
Protected Attributes inherited from WsfOrbitalEvent
ut::CloneablePtr< wsf::space::OrbitalPropagatorCondition >	mCondition {}
bool	mIsFinite
bool	mHasExecuted
bool	mIsComplete
bool	mIsCanceled
bool	mDebug
bool	mCanVerify
UtCalendar	mStartTime
	Can this event be verified without running in a simulation?
UtCalendar	mEvaluationTime
UtTimeValue	mDuration
UtTimeValue	mUpdateInterval
const WsfScenario &	mScenario

Constructor & Destructor Documentation

◆ WsfOrbitalStagingEvent() [1/2]

WsfOrbitalStagingEvent::WsfOrbitalStagingEvent ( const WsfScenario & aScenario )

explicit

References GetTypeId(), WsfObject::SetType(), and WsfOrbitalEvent::WsfOrbitalEvent().

Referenced by Clone(), and WsfOrbitalStagingEvent().

◆ WsfOrbitalStagingEvent() [2/2]

WsfOrbitalStagingEvent::WsfOrbitalStagingEvent ( const WsfOrbitalStagingEvent & aSrc )

References WsfOrbitalEvent::WsfOrbitalEvent(), and WsfOrbitalStagingEvent().

◆ ~WsfOrbitalStagingEvent()

WsfOrbitalStagingEvent::~WsfOrbitalStagingEvent ( )

override

Member Function Documentation

◆ Accept()

void WsfOrbitalStagingEvent::Accept ( WsfOrbitalEventVisitor * aVisitorPtr )

overridevirtual

Implements WsfOrbitalEvent.

References WsfOrbitalEventVisitor::VisitOrbitalStagingEvent().

◆ Clone()

WsfOrbitalEvent * WsfOrbitalStagingEvent::Clone ( ) const

overridevirtual

Make a copy of this object.

Implements WsfOrbitalEvent.

References WsfOrbitalEvent::WsfOrbitalEvent(), and WsfOrbitalStagingEvent().

◆ ExecuteEvent()

bool WsfOrbitalStagingEvent::ExecuteEvent	(	const UtCalendar &	aCurrentTime,
		wsf::space::OrbitalMissionContext &	aContext )

overrideprotectedvirtual

Perform any necessary event processing. For example, in the case of orbital maneuvers, the actual Maneuver(...) method is called and delta-V computations are performed.

Parameters

aCurrentTime	The current time to be used in the event execution.
aContext	The orbital mission context in which this event is executing.

Note: This is a template method called from within Execute(...).

Implements WsfOrbitalEvent.

References wsf::space::OrbitalMissionContext::PerformStagingOperation().

◆ GetScriptClassName()

const char * WsfOrbitalStagingEvent::GetScriptClassName ( ) const

inlineoverride

◆ GetTypeId()

WsfStringId WsfOrbitalStagingEvent::GetTypeId ( )

static

Referenced by WsfSpaceExtension::AddedToScenario(), and WsfOrbitalStagingEvent().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ WsfOrbitalStagingEvent() [1/2]

◆ WsfOrbitalStagingEvent() [2/2]

◆ ~WsfOrbitalStagingEvent()

Member Function Documentation

◆ Accept()

◆ Clone()

◆ ExecuteEvent()

◆ GetScriptClassName()

◆ GetTypeId()