WsfSunMonopoleTerm Class Reference

#include <WsfSunMonopoleTerm.hpp>

Inheritance diagram for WsfSunMonopoleTerm:

Collaboration diagram for WsfSunMonopoleTerm:

Public Member Functions
	WsfSunMonopoleTerm ()
	WsfSunMonopoleTerm (const WsfSunMonopoleTerm &aOther)=default
	~WsfSunMonopoleTerm () override=default
WsfSunMonopoleTerm *	Clone () const override
const char *	GetScriptClassName () const override
bool	ProcessInput (UtInput &aInput) override
bool	Initialize (const WsfOrbitalDynamics &aDynamics) 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)
UtVec3d	GetSunLocationECI (const UtCalendar &aEpoch) const
Public Member Functions inherited from WsfOrbitalDynamicsTerm
	WsfOrbitalDynamicsTerm ()
	WsfOrbitalDynamicsTerm (const WsfOrbitalDynamicsTerm &aOther)
WsfOrbitalDynamicsTerm &	operator= (const WsfOrbitalDynamicsTerm &aOther)=delete
const char *	GetScriptClassName () const override
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 {"sun_monopole"}

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

WsfSunMonopoleTerm() [1/2]

WsfSunMonopoleTerm::WsfSunMonopoleTerm

(

)

References WsfOrbitalDynamicsTerm::WsfOrbitalDynamicsTerm().

Referenced by Clone(), and WsfSunMonopoleTerm().

WsfSunMonopoleTerm() [2/2]

WsfSunMonopoleTerm::WsfSunMonopoleTerm ( const WsfSunMonopoleTerm & aOther )

default

References WsfSunMonopoleTerm().

~WsfSunMonopoleTerm()

WsfSunMonopoleTerm::~WsfSunMonopoleTerm ( )

overridedefault

Member Function Documentation

Clone()

WsfSunMonopoleTerm * WsfSunMonopoleTerm::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 WsfSunMonopoleTerm().

ComputeAcceleration()

UtVec3d WsfSunMonopoleTerm::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 GetSunLocationECI().

GetGravitationalParameter()

double WsfSunMonopoleTerm::GetGravitationalParameter ( ) const

inline

GetScriptClassName()

const char * WsfSunMonopoleTerm::GetScriptClassName ( ) const

inlineoverride

GetSunLocationECI()

UtVec3d WsfSunMonopoleTerm::GetSunLocationECI

(

const UtCalendar &

aEpoch

)

const

References WsfDE_File::cEARTH, WsfDE_File::cSUN, WsfOrbitalDynamicsTerm::GetDynamics(), and WsfOrbitalDynamics::GetTimeConstants().

Referenced by ComputeAcceleration().

GetTermType()

std::string WsfSunMonopoleTerm::GetTermType ( ) const

inlineoverridevirtual

Return a string indicating the type of term.

Implements WsfOrbitalDynamicsTerm.

References cTYPE.

Initialize()

bool WsfSunMonopoleTerm::Initialize ( const WsfOrbitalDynamics & aDynamics )

overridevirtual

Initialize the term.

This is called when the owning WsfOrbitalDynamics is initialized. This enables terms that might need to inspect their owning dynamics.

Parameters

aDynamics

- the dynamics to which this term belongs.

Reimplemented from WsfOrbitalDynamicsTerm.

References WsfDE_FileManager::Get(), WsfDE_FileManager::GetOrLoadFile(), WsfOrbitalDynamics::GetSimulation(), and WsfOrbitalDynamicsTerm::Initialize().

ProcessInput()

bool WsfSunMonopoleTerm::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.

SetGravitationalParameter()

void WsfSunMonopoleTerm::SetGravitationalParameter ( double aMu )

inline

Member Data Documentation

cTYPE

const char* WsfSunMonopoleTerm::cTYPE {"sun_monopole"}

staticconstexpr

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

---

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

• WsfSunMonopoleTerm.hpp
• WsfSunMonopoleTerm.cpp