wsf::space::RadiusCondition Class Reference

#include <WsfSpaceOrbitalPropagatorCondition.hpp>

Inheritance diagram for wsf::space::RadiusCondition:

Collaboration diagram for wsf::space::RadiusCondition:

Public Member Functions
	RadiusCondition ()=default
bool	ProcessInput (UtInput &aInput) override
UtLengthValue	GetRadius () const
void	SetRadius (const UtLengthValue &aRadius)
bool	ValidateParameterRanges () 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.
virtual bool	HandleSpecialCases (const UtOrbitalPropagatorBase &aPropagator, double &aTimeToCondition) const
Public Member Functions inherited from wsf::space::OrbitalPropagatorCondition
OrbitalPropagatorCondition *	Clone () const override=0
unsigned	GetOrbitNumber () const
	Return the orbit number.
void	SetOrbitNumber (unsigned aOrbitNumber)
	Set the orbit number.
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 Attributes
UtLengthValue	mRadius {}
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.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

RadiusCondition()

wsf::space::RadiusCondition::RadiusCondition ( )

default

Member Function Documentation

GetRadius()

UtLengthValue wsf::space::RadiusCondition::GetRadius ( ) const

inline

References mRadius.

Referenced by wsf::event::utils::PrintOrbitalManeuverData(), wsf::event::utilsCSV::PrintOrbitalManeuverData(), and wsf::space::script::UT_DEFINE_SCRIPT_METHOD().

ProcessInput()

bool wsf::space::RadiusCondition::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput

a reference to a UtInput object.

Returns

'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or an object derived from it) if the command was recognized but contains some sort of error.

Note

If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from wsf::space::OrbitalPropagatorCondition.

References mRadius.

SetRadius()

void wsf::space::RadiusCondition::SetRadius ( const UtLengthValue & aRadius )

inline

References mRadius.

ValidateParameterRanges()

bool wsf::space::RadiusCondition::ValidateParameterRanges ( ) const

overridevirtual

Validate any input parameters for the conditions. This method should be overridden for conditions that take parameters for which there are some restrictions on their values (e.g., the parameter must be positive). If the parameter is outside the allowed range, this method should print an error and return false.

Returns

true if all parameters are valid; false otherwise.

Reimplemented from wsf::space::OrbitalPropagatorCondition.

References WsfObject::GetType(), and mRadius.

Member Data Documentation

mRadius

UtLengthValue wsf::space::RadiusCondition::mRadius {}

protected

Referenced by GetRadius(), wsf::space::AscendingRadiusCondition::InitialGuess(), wsf::space::DescendingRadiusCondition::InitialGuess(), wsf::space::AscendingRadiusCondition::Objective(), wsf::space::DescendingRadiusCondition::Objective(), ProcessInput(), SetRadius(), and ValidateParameterRanges().

---

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

• WsfSpaceOrbitalPropagatorCondition.hpp
• WsfSpaceOrbitalPropagatorCondition.cpp