WsfOrbitalConjunctionAssessment Class Reference

An object to search for possible conjunctions between two spacecraft. More...

#include <WsfOrbitalConjunctionAssessment.hpp>

Classes
struct	Options
	Specifies the options to use when performing the analysis. More...

Public Types
enum class	Status { cNO_CONJUNCTION = 0 , cCONJUNCTION_FOUND , cREACHED_FINAL_TIME }
	This indicates if a conjunction has been found. More...

Public Member Functions
	WsfOrbitalConjunctionAssessment (WsfLocalTrack &aPrimary, double aPrimarySize, WsfLocalTrack &aSecondary, double aSecondarySize, const Options &aOptions, const UtOrbitalPropagatorBase *aPropPtr)
Status	FindNext ()
bool	ReachedFinalTime () const
	Returns if the assessment has reached the end of the evaluation interval.
WsfOrbitalConjunctionRecord	CurrentConjunction () const
	Returns the current conjunction.
double	DefaultVariance () const
	Return the default variance set when this object was constructed.
double	DefaultObjectRadius () const
	Return the default object radius set when this object was constructed.

Detailed Description

An object to search for possible conjunctions between two spacecraft.

Member Enumeration Documentation

Status

enum class WsfOrbitalConjunctionAssessment::Status

strong

This indicates if a conjunction has been found.

Enumerator
cNO_CONJUNCTION
cCONJUNCTION_FOUND
cREACHED_FINAL_TIME

Constructor & Destructor Documentation

WsfOrbitalConjunctionAssessment()

WsfOrbitalConjunctionAssessment::WsfOrbitalConjunctionAssessment	(	WsfLocalTrack &	aPrimary,
		double	aPrimarySize,
		WsfLocalTrack &	aSecondary,
		double	aSecondarySize,
		const Options &	aOptions,
		const UtOrbitalPropagatorBase *	aPropPtr )

References cREACHED_FINAL_TIME, and if().

Member Function Documentation

CurrentConjunction()

WsfOrbitalConjunctionRecord WsfOrbitalConjunctionAssessment::CurrentConjunction

(

)

const

Returns the current conjunction.

References WsfOrbitalConjunctionRecord::mPrimary, and WsfOrbitalConjunctionRecord::mSecondary.

DefaultObjectRadius()

double WsfOrbitalConjunctionAssessment::DefaultObjectRadius ( ) const

inline

Return the default object radius set when this object was constructed.

DefaultVariance()

double WsfOrbitalConjunctionAssessment::DefaultVariance ( ) const

inline

Return the default variance set when this object was constructed.

FindNext()

WsfOrbitalConjunctionAssessment::Status WsfOrbitalConjunctionAssessment::FindNext

(

)

Find the next possible conjunction. This will search for the next conjunction for the two objects. After each call to the routine, the state of the assessment will advance to the next conjunction (if one is found) or the end of the interval if no further conjunctions are found. If the end of the interval is reached, this will return Status::cREACHED_FINAL_TIME. If a conjunction is found, this will return Status::cCONJUNCTION_FOUND. In the event a conjunction is found, CurrentConjunction() can be used to retrieve the encounter data.

Returns

- Status::cCONJUNCTION_FOUND if a conjunction was found before the end of the search interval; Status::cREACHED_FINAL_TIME otherwise.

References cCONJUNCTION_FOUND, cNO_CONJUNCTION, and cREACHED_FINAL_TIME.

ReachedFinalTime()

bool WsfOrbitalConjunctionAssessment::ReachedFinalTime ( ) const

inline

Returns if the assessment has reached the end of the evaluation interval.

References cREACHED_FINAL_TIME.

---

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

• WsfOrbitalConjunctionAssessment.hpp
• WsfOrbitalConjunctionAssessment.cpp