WsfEarthJ2Term Class Reference

#include <WsfEarthJ2Term.hpp>

Inheritance diagram for WsfEarthJ2Term:

Collaboration diagram for WsfEarthJ2Term:

Public Member Functions
	WsfEarthJ2Term ()
	WsfEarthJ2Term (const WsfEarthJ2Term &aOther)=default
	~WsfEarthJ2Term () override=default
bool	ProcessInput (UtInput &aInput) override
WsfEarthJ2Term *	Clone () const override
const char *	GetScriptClassName () const override
UtVec3d	ComputeAcceleration (double aMass, const UtCalendar &aTime, const UtVec3d &aPosition, const UtVec3d &aVelocity) const override
std::string	GetTermType () const override
	Return a string indicating the type of term.
double	GetGravitationalParameter () const
void	SetGravitationalParameter (double aMu)
double	GetEarthMeanRadius () const
void	SetEarthMeanRadius (double aMeanRadius)
double	GetJ2 () const
void	SetJ2 (double aJ2)
Public Member Functions inherited from WsfOrbitalDynamicsTerm
	WsfOrbitalDynamicsTerm ()
	WsfOrbitalDynamicsTerm (const WsfOrbitalDynamicsTerm &aOther)
WsfOrbitalDynamicsTerm &	operator= (const WsfOrbitalDynamicsTerm &aOther)=delete
const char *	GetScriptClassName () const override
virtual bool	Initialize (const WsfOrbitalDynamics &aDynamics)
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 Member Functions
static constexpr double	GetDefaultJ2Value ()

Static Public Attributes
static constexpr const char *	cTYPE {"earth_j2"}

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Member Functions inherited from WsfOrbitalDynamicsTerm
const WsfOrbitalDynamics *	GetDynamics () const
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Constructor & Destructor Documentation

WsfEarthJ2Term() [1/2]

WsfEarthJ2Term::WsfEarthJ2Term

(

)

References WsfOrbitalDynamicsTerm::WsfOrbitalDynamicsTerm().

Referenced by Clone(), and WsfEarthJ2Term().

WsfEarthJ2Term() [2/2]

WsfEarthJ2Term::WsfEarthJ2Term ( const WsfEarthJ2Term & aOther )

default

References WsfEarthJ2Term().

~WsfEarthJ2Term()

WsfEarthJ2Term::~WsfEarthJ2Term ( )

overridedefault

Member Function Documentation

Clone()

WsfEarthJ2Term * WsfEarthJ2Term::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 WsfOrbitalDynamicsTerm.

References WsfEarthJ2Term().

ComputeAcceleration()

UtVec3d WsfEarthJ2Term::ComputeAcceleration ( double aMass, const UtCalendar & aTime, const UtVec3d & aPosition, const UtVec3d & aVelocity ) const

overridevirtual

Return the acceleration in the ECI frame.

This routine computes the acceleration represented by this term that would be experienced by a body of the given aMass at the given aTime, aPosition and aVelocity. The given aPosition and aVelocity are in the ECI frame, and the returned acceleration is also in the ECI frame.

Parameters

aMass	- The mass of the object that would experience this dynamical term.
aTime	- The time at which the acceleration is being computed.
aPosition	- The position of the body that would experience this acceleration.
aVelocity	- The velocity of the body that would experience this acceleration.

Returns

- The acceleration corresponding to this dynamical term.

Implements WsfOrbitalDynamicsTerm.

References WsfOrbitalDynamicsTerm::GetDynamics().

GetDefaultJ2Value()

constexpr double WsfEarthJ2Term::GetDefaultJ2Value ( )

inlinestaticconstexpr

Referenced by UT_DEFINE_SCRIPT_METHOD().

GetEarthMeanRadius()

double WsfEarthJ2Term::GetEarthMeanRadius ( ) const

inline

GetGravitationalParameter()

double WsfEarthJ2Term::GetGravitationalParameter ( ) const

inline

GetJ2()

double WsfEarthJ2Term::GetJ2 ( ) const

inline

GetScriptClassName()

const char * WsfEarthJ2Term::GetScriptClassName ( ) const

inlineoverride

GetTermType()

std::string WsfEarthJ2Term::GetTermType ( ) const

inlineoverridevirtual

Return a string indicating the type of term.

Implements WsfOrbitalDynamicsTerm.

References cTYPE.

ProcessInput()

bool WsfEarthJ2Term::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 WsfObject.

SetEarthMeanRadius()

void WsfEarthJ2Term::SetEarthMeanRadius ( double aMeanRadius )

inline

SetGravitationalParameter()

void WsfEarthJ2Term::SetGravitationalParameter ( double aMu )

inline

SetJ2()

void WsfEarthJ2Term::SetJ2 ( double aJ2 )

inline

Member Data Documentation

cTYPE

const char* WsfEarthJ2Term::cTYPE {"earth_j2"}

staticconstexpr

Referenced by GetTermType(), and WsfOrbitalDynamicsTermTypes::WsfOrbitalDynamicsTermTypes().

---

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

• WsfEarthJ2Term.hpp
• WsfEarthJ2Term.cpp