#include <WsfAtmosphere.hpp>

Inheritance diagram for wsf::space::Atmosphere:

[legend]

Collaboration diagram for wsf::space::Atmosphere:

Public Member Functions
	Atmosphere ()
	Atmosphere (const Atmosphere &aOther)=default
virtual	~Atmosphere ()=default
Atmosphere *	Clone () const override=0
bool	ProcessInput (UtInput &aInput) override
const ut::CentralBody &	GetCentralBody () const
const char *	GetScriptClassName () const override
virtual double	GetDensity (const UtCalendar &aEpoch, const UtLLAPos &aLLA) const =0
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
ut::CloneablePtr< ut::CentralBody >	mCentralBodyPtr

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

◆ Atmosphere() [1/2]

wsf::space::Atmosphere::Atmosphere ( )

References mCentralBodyPtr.

Referenced by Atmosphere(), Clone(), wsf::space::JacchiaRobertsAtmosphere::JacchiaRobertsAtmosphere(), and wsf::space::PiecewiseExponentialAtmosphere::PiecewiseExponentialAtmosphere().

◆ Atmosphere() [2/2]

wsf::space::Atmosphere::Atmosphere ( const Atmosphere & aOther )

default

References Atmosphere().

◆ ~Atmosphere()

virtual wsf::space::Atmosphere::~Atmosphere ( )

virtualdefault

Member Function Documentation

◆ Clone()

Atmosphere * wsf::space::Atmosphere::Clone ( ) const

overridepure virtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

Implemented in wsf::space::JacchiaRobertsAtmosphere, and wsf::space::PiecewiseExponentialAtmosphere.

References Atmosphere(), and ProcessInput().

◆ GetCentralBody()

const ut::CentralBody & wsf::space::Atmosphere::GetCentralBody ( ) const

inline

References mCentralBodyPtr.

◆ GetDensity()

virtual double wsf::space::Atmosphere::GetDensity	(	const UtCalendar &	aEpoch,
		const UtLLAPos &	aLLA ) const

pure virtual

Return the model density for a given time and location.

This will return the density of the atmosphere (in kg / m^3) at the given aEpoch and given body-centric latitude, longitude and altitude, aLLA. This is the only state variable that subclasses of this class are required to implement.

Parameters

aEpoch	The date and time at which the density is being queried.
aLLA	The body-centric latitude, longitude and altitude at which the density is being queried.

Returns: The density (in kg / m^3).

Implemented in wsf::space::JacchiaRobertsAtmosphere, and wsf::space::PiecewiseExponentialAtmosphere.

◆ GetScriptClassName()

const char * wsf::space::Atmosphere::GetScriptClassName ( ) const

inlineoverride

◆ ProcessInput()

bool wsf::space::Atmosphere::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.

Reimplemented in wsf::space::JacchiaRobertsAtmosphere.

References mCentralBodyPtr.

Referenced by Clone(), and wsf::space::JacchiaRobertsAtmosphere::ProcessInput().