wsf::space::IntersectionCondition Class Reference

#include <WsfSpaceOrbitalPropagatorCondition.hpp>

Inheritance diagram for wsf::space::IntersectionCondition:

Collaboration diagram for wsf::space::IntersectionCondition:

Public Member Functions
	IntersectionCondition ()=default
double	GetRAAN () const
double	GetInclination () const
void	SetRAAN (double aRAAN)
void	SetInclination (double aInclination)
void	SetIntersectionRAAN_Inclination (double aRAAN, double aInclination)
bool	HandleSpecialCases (const UtOrbitalPropagatorBase &aPropagator, double &aTimeToCondition) const override
Public Member Functions inherited from wsf::space::OrbitalPropagatorOptimizingCondition
virtual bool	Objective (UtOrbitalPropagatorBase &aPropagator, const UtCalendar &aBaseEpoch, double aOffsetTime) const =0
virtual std::pair< bool, double >	InitialGuess (const UtOrbitalPropagatorBase &aPropagator) const =0
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
OrbitalPropagatorCondition *	Clone () const override=0
bool	ProcessInput (UtInput &aInput) override
unsigned	GetOrbitNumber () const
	Return the orbit number.
void	SetOrbitNumber (unsigned aOrbitNumber)
	Set the orbit number.
virtual bool	ValidateParameterRanges () const
virtual void	Accept (OrbitalPropagatorConditionVisitor &aVisitor)=0
	Accept a visitor.
virtual std::string	GetConditionString () const =0
	Return the string identifying the condition.
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)

Protected Member Functions
UtVec3d	OrbitNormal (double aRAAN, double aInclination) const
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Protected Attributes
double	mRAAN {0.0}
double	mInclination {0.0}
Protected Attributes inherited from wsf::space::OrbitalPropagatorCondition
unsigned	mOrbitNumber {0}

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Constructor & Destructor Documentation

IntersectionCondition()

wsf::space::IntersectionCondition::IntersectionCondition ( )

default

Member Function Documentation

GetInclination()

double wsf::space::IntersectionCondition::GetInclination ( ) const

inline

References mInclination.

GetRAAN()

double wsf::space::IntersectionCondition::GetRAAN ( ) const

inline

References mRAAN.

HandleSpecialCases()

bool wsf::space::IntersectionCondition::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 mInclination, wsf::space::OrbitalPropagatorCondition::mOrbitNumber, mRAAN, and OrbitNormal().

OrbitNormal()

UtVec3d wsf::space::IntersectionCondition::OrbitNormal ( double aRAAN, double aInclination ) const

protected

Referenced by HandleSpecialCases(), wsf::space::NorthernIntersectionCondition::Objective(), and wsf::space::SouthernIntersectionCondition::Objective().

SetInclination()

void wsf::space::IntersectionCondition::SetInclination

(

double

aInclination

)

References mInclination.

SetIntersectionRAAN_Inclination()

void wsf::space::IntersectionCondition::SetIntersectionRAAN_Inclination	(	double	aRAAN,
		double	aInclination )

References mInclination, and mRAAN.

SetRAAN()

void wsf::space::IntersectionCondition::SetRAAN

(

double

aRAAN

)

References mRAAN.

Member Data Documentation

mInclination

double wsf::space::IntersectionCondition::mInclination {0.0}

protected

Referenced by GetInclination(), HandleSpecialCases(), wsf::space::NorthernIntersectionCondition::InitialGuess(), wsf::space::SouthernIntersectionCondition::InitialGuess(), wsf::space::NorthernIntersectionCondition::Objective(), wsf::space::SouthernIntersectionCondition::Objective(), SetInclination(), and SetIntersectionRAAN_Inclination().

mRAAN

double wsf::space::IntersectionCondition::mRAAN {0.0}

protected

Referenced by GetRAAN(), HandleSpecialCases(), wsf::space::NorthernIntersectionCondition::InitialGuess(), wsf::space::SouthernIntersectionCondition::InitialGuess(), wsf::space::NorthernIntersectionCondition::Objective(), wsf::space::SouthernIntersectionCondition::Objective(), SetIntersectionRAAN_Inclination(), and SetRAAN().

---

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

• WsfSpaceOrbitalPropagatorCondition.hpp
• WsfSpaceOrbitalPropagatorCondition.cpp