wsf::space::EclipseEntryCondition Class Reference

A condition indicating the point at which the propagator enters into eclipse. More...

#include <WsfSpaceOrbitalPropagatorCondition.hpp>

Inheritance diagram for wsf::space::EclipseEntryCondition:

Collaboration diagram for wsf::space::EclipseEntryCondition:

Public Member Functions
	EclipseEntryCondition ()
EclipseEntryCondition *	Clone () const override
bool	GetTimeToCondition (const UtOrbitalPropagatorBase &aPropagator, double &aTimeToCondition) const override
void	Accept (OrbitalPropagatorConditionVisitor &aVisitor) override
	Accept a visitor.
std::string	GetConditionString () const override
	Return the string identifying the condition.
Public Member Functions inherited from wsf::space::OrbitalPropagatorCondition
bool	ProcessInput (UtInput &aInput) override
unsigned	GetOrbitNumber () const
	Return the orbit number.
void	SetOrbitNumber (unsigned aOrbitNumber)
	Set the orbit number.
virtual bool	ValidateParameterRanges () 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 {"eclipse_entry"}

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from wsf::space::OrbitalPropagatorCondition
unsigned	mOrbitNumber {0}

Detailed Description

A condition indicating the point at which the propagator enters into eclipse.

Constructor & Destructor Documentation

EclipseEntryCondition()

wsf::space::EclipseEntryCondition::EclipseEntryCondition ( )

inline

References cTYPE, and WsfObject::SetType().

Referenced by Clone().

Member Function Documentation

Accept()

void wsf::space::EclipseEntryCondition::Accept ( OrbitalPropagatorConditionVisitor & aVisitor )

overridevirtual

Accept a visitor.

Implements wsf::space::OrbitalPropagatorCondition.

References wsf::space::OrbitalPropagatorConditionVisitor::Accept().

Clone()

EclipseEntryCondition * wsf::space::EclipseEntryCondition::Clone ( ) const

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::space::OrbitalPropagatorCondition.

References EclipseEntryCondition().

GetConditionString()

std::string wsf::space::EclipseEntryCondition::GetConditionString ( ) const

inlineoverridevirtual

Return the string identifying the condition.

Implements wsf::space::OrbitalPropagatorCondition.

GetTimeToCondition()

bool wsf::space::EclipseEntryCondition::GetTimeToCondition ( const UtOrbitalPropagatorBase & aPropagator, double & aTimeToCondition ) const

overridevirtual

Get the time at which the condition is satisfied. This method computes the time in seconds from the current time of the aPropagator at which the condition is satisfied. If the method is able to compute such a time, the aTimeToCondition is set to the appropriate value and this method returns true. If the method is unable to determine when the condition obtains, then the method returns false.

Parameters

aPropagator	- The propagator for which the time to the condition being satisfied is desired.
aTimeToCondition	[out] - The time in seconds from the current time of the provided aPropagator at which the condition is satisfied.

Returns

true if the time was able to be determined; false otherwise.

Implements wsf::space::OrbitalPropagatorCondition.

References wsf::space::OrbitalPropagatorCondition::GetOrbitNumber(), and ok.

Member Data Documentation

cTYPE

const char* wsf::space::EclipseEntryCondition::cTYPE {"eclipse_entry"}

staticconstexpr

Referenced by EclipseEntryCondition(), wsf::space::OrbitalPropagatorConditionTypes::OrbitalPropagatorConditionTypes(), and WsfOrbitalEvent::VerifyCondition().

---

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

• WsfSpaceOrbitalPropagatorCondition.hpp
• WsfSpaceOrbitalPropagatorCondition.cpp