A condition indicating the point at which the propagator reaches apoapsis. More...

#include <WsfSpaceOrbitalPropagatorCondition.hpp>

Inheritance diagram for wsf::space::ApoapsisCondition:

[legend]

Collaboration diagram for wsf::space::ApoapsisCondition:

[legend]

Public Member Functions
	ApoapsisCondition ()
ApoapsisCondition *	Clone () const override
std::pair< bool, double >	InitialGuess (const UtOrbitalPropagatorBase &aPropagator) const override
bool	Objective (UtOrbitalPropagatorBase &aPropagator, const UtCalendar &aBaseEpoch, double aOffsetTime) const override
bool	HandleSpecialCases (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::OrbitalPropagatorOptimizingCondition
bool	GetTimeToCondition (const UtOrbitalPropagatorBase &aPropagator, double &aTimeToCondition) const final
	This template pattern method performs the search for the time at which the condition obtains.
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 {"apoapsis"}

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 reaches apoapsis.

Constructor & Destructor Documentation

◆ ApoapsisCondition()

wsf::space::ApoapsisCondition::ApoapsisCondition ( )

inline

References cTYPE, and WsfObject::SetType().

Referenced by Clone().

Member Function Documentation

◆ Accept()

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

overridevirtual

Accept a visitor.

Implements wsf::space::OrbitalPropagatorCondition.

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

◆ Clone()

ApoapsisCondition * wsf::space::ApoapsisCondition::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 ApoapsisCondition().

◆ GetConditionString()

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

inlineoverridevirtual

Return the string identifying the condition.

Implements wsf::space::OrbitalPropagatorCondition.

◆ HandleSpecialCases()

bool wsf::space::ApoapsisCondition::HandleSpecialCases	(	const UtOrbitalPropagatorBase &	aPropagator,
		double &	aTimeToCondition ) const

overridevirtual

Handle special cases of initial or final orbits for a condition. If there are special initial or final orbit classes that need to be handled separately, this method can be overridden to provide the requisite values. If the aPropagator or the condition instance is such that special handling is required, this value should set the time at which the condition obtains in aTimeToCondition, and return true. Otherwise, this method should return false. Typically such special cases are called for in equatorial, or circular orbits.

Parameters

aPropagator	- The propagator being examined for special cases.
aTimeToCondition	[out] - The time at which the condition obtains.

Returns: true if a special case was detected; false otherwise.

Reimplemented from wsf::space::OrbitalPropagatorOptimizingCondition.

References wsf::space::OrbitalPropagatorCondition::mOrbitNumber.

◆ InitialGuess()

std::pair< bool, double > wsf::space::ApoapsisCondition::InitialGuess ( const UtOrbitalPropagatorBase & aPropagator ) const

overridevirtual

Produce an initial guess for when the condition might obtain. The initial guess produced by this method is used to set the initial search area for the root. In some rare cases, it may be impossible to form an initial guess.

Parameters

aPropagator - The propagator for which an initial guess is to be returned.

Returns: - a pair, with a first member set to true if an initial guess was able to be computed, and a second member set to the time of the initial guess.

Implements wsf::space::OrbitalPropagatorOptimizingCondition.

References wsf::space::OrbitalPropagatorCondition::mOrbitNumber.

◆ Objective()

bool wsf::space::ApoapsisCondition::Objective	(	UtOrbitalPropagatorBase &	aPropagator,
		const UtCalendar &	aBaseEpoch,
		double	aOffsetTime ) const

overridevirtual

This function is the objective function whose root gives the time of the condition. The provided propagator will be advanced to aOffsetTime seconds after the provided aBaseEpoch and the resulting state will be used to evaluate the condition. The condition needs to be formulated so that a boolean is returned, where the value of the boolean indicates if aOffsetTime is in a region before or after the root. The condition can return either true or false for values before the root, and the choice is up to the convenience of the implementer.

Parameters

aPropagator	- The propagator for which the objective is being examined.
aBaseEpoch	- A base epoch from which the offset will be specified.
aOffsetTime	- The offset from the base epoch at which the objective will be computed.

Returns: If the given aOffsetTime is before the root.

Implements wsf::space::OrbitalPropagatorOptimizingCondition.

References vel.

Member Data Documentation

◆ cTYPE

const char* wsf::space::ApoapsisCondition::cTYPE {"apoapsis"}

staticconstexpr

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ApoapsisCondition()

Member Function Documentation

◆ Accept()

◆ Clone()

◆ GetConditionString()

◆ HandleSpecialCases()

◆ InitialGuess()

◆ Objective()

Member Data Documentation

◆ cTYPE