wsf::space::OrbitSize Class Reference

#include <WsfSpaceOrbitSize.hpp>

Public Member Functions
	OrbitSize (UtLengthValue aSemiMajorAxis=UtLengthValue{1.0e-12, UtUnitLength::cKILOMETERS}, double aGravitationalParameter=UtEarth::cGRAVITATIONAL_PARAMETER)
const UtLengthValue &	GetSemiMajorAxis () const
	Return the semi-major axis of the orbit.
const UtLengthValue &	GetCircularAltitude () const
	Return the circular altitude of the orbit.
const UtTimeValue &	GetOrbitalPeriod () const
	Return the orbital period.
double	GetRevolutionsPerDay () const
	Return the number of revolutions per day of the orbit.
void	SetSemiMajorAxis (const UtLengthValue &aSemiMajorAxis)
	Set the orbit size using the semi-major axis.
void	SetCircularAltitude (const UtLengthValue &aAltitude)
	Set the orbit size using the circular altitude.
void	SetOrbitalPeriod (const UtTimeValue &aPeriod)
	Set the orbit size using the orbital period.
void	SetRevolutionsPerDay (double aRevolutionsPerDay)
	Set the orbit size using the number of revolutions per day.
bool	SpecifiedAsSemiMajorAxis () const
	Return if the orbit size was specified using the semi-major axis.
bool	SpecifiedAsCircularAltitude () const
	Return if the orbit size was specified using the circular altitude.
bool	SpecifiedAsOrbitalPeriod () const
	Return if the orbit size was specified using the orbital period.
bool	SpecifiedAsRevsPerDay () const
	Return if the orbit size was specified using the number of revolutions per day.

Static Public Member Functions
static OrbitSize	FromSemiMajorAxis (UtLengthValue aSemiMajorAxis, double aGravitationalParameter=UtEarth::cGRAVITATIONAL_PARAMETER)
	Return an OrbitSize created from a semi-major axis.
static OrbitSize	FromCircularAltitude (UtLengthValue aAltitude, double aGravitationalParameter=UtEarth::cGRAVITATIONAL_PARAMETER)
	Return an OrbitSize created from a circular altitude.
static OrbitSize	FromOrbitalPeriod (UtTimeValue aPeriod, double aGravitationalParameter=UtEarth::cGRAVITATIONAL_PARAMETER)
	Return an OrbitSize created from an orbital period.
static OrbitSize	FromRevolutionsPerDay (double aRevolutionsPerDay, double aGravitationalParameter=UtEarth::cGRAVITATIONAL_PARAMETER)
	Return an OrbitSize created from a number of revolutions per day.

Detailed Description

This object provides the size of an orbit.

There are a number of equivalent ways of specifying the size of a circular orbit that are related via basic definitions or through Kepler's Third Law. This object supports the semi-major axis, the altitude, the orbital period and the number of revolutions per day.

Constructor & Destructor Documentation

OrbitSize()

wsf::space::OrbitSize::OrbitSize	(	UtLengthValue	aSemiMajorAxis = UtLengthValue{1.0e-12, UtUnitLength::cKILOMETERS},
		double	aGravitationalParameter = UtEarth::cGRAVITATIONAL_PARAMETER )

References SetSemiMajorAxis().

Referenced by FromCircularAltitude(), FromOrbitalPeriod(), FromRevolutionsPerDay(), and FromSemiMajorAxis().

Member Function Documentation

FromCircularAltitude()

OrbitSize wsf::space::OrbitSize::FromCircularAltitude ( UtLengthValue aAltitude, double aGravitationalParameter = UtEarth::cGRAVITATIONAL_PARAMETER )

static

Return an OrbitSize created from a circular altitude.

References OrbitSize(), and SetCircularAltitude().

FromOrbitalPeriod()

OrbitSize wsf::space::OrbitSize::FromOrbitalPeriod ( UtTimeValue aPeriod, double aGravitationalParameter = UtEarth::cGRAVITATIONAL_PARAMETER )

static

Return an OrbitSize created from an orbital period.

References OrbitSize(), and SetOrbitalPeriod().

FromRevolutionsPerDay()

OrbitSize wsf::space::OrbitSize::FromRevolutionsPerDay ( double aRevolutionsPerDay, double aGravitationalParameter = UtEarth::cGRAVITATIONAL_PARAMETER )

static

Return an OrbitSize created from a number of revolutions per day.

References OrbitSize(), and SetRevolutionsPerDay().

FromSemiMajorAxis()

OrbitSize wsf::space::OrbitSize::FromSemiMajorAxis ( UtLengthValue aSemiMajorAxis, double aGravitationalParameter = UtEarth::cGRAVITATIONAL_PARAMETER )

static

Return an OrbitSize created from a semi-major axis.

References OrbitSize().

GetCircularAltitude()

const UtLengthValue & wsf::space::OrbitSize::GetCircularAltitude ( ) const

inline

Return the circular altitude of the orbit.

GetOrbitalPeriod()

const UtTimeValue & wsf::space::OrbitSize::GetOrbitalPeriod ( ) const

inline

Return the orbital period.

GetRevolutionsPerDay()

double wsf::space::OrbitSize::GetRevolutionsPerDay ( ) const

inline

Return the number of revolutions per day of the orbit.

GetSemiMajorAxis()

const UtLengthValue & wsf::space::OrbitSize::GetSemiMajorAxis ( ) const

inline

Return the semi-major axis of the orbit.

SetCircularAltitude()

void wsf::space::OrbitSize::SetCircularAltitude

(

const UtLengthValue &

aAltitude

)

Set the orbit size using the circular altitude.

Referenced by FromCircularAltitude().

SetOrbitalPeriod()

void wsf::space::OrbitSize::SetOrbitalPeriod

(

const UtTimeValue &

aPeriod

)

Set the orbit size using the orbital period.

Referenced by FromOrbitalPeriod().

SetRevolutionsPerDay()

void wsf::space::OrbitSize::SetRevolutionsPerDay

(

double

aRevolutionsPerDay

)

Set the orbit size using the number of revolutions per day.

Referenced by FromRevolutionsPerDay().

SetSemiMajorAxis()

void wsf::space::OrbitSize::SetSemiMajorAxis

(

const UtLengthValue &

aSemiMajorAxis

)

Set the orbit size using the semi-major axis.

Referenced by OrbitSize().

SpecifiedAsCircularAltitude()

bool wsf::space::OrbitSize::SpecifiedAsCircularAltitude ( ) const

inline

Return if the orbit size was specified using the circular altitude.

SpecifiedAsOrbitalPeriod()

bool wsf::space::OrbitSize::SpecifiedAsOrbitalPeriod ( ) const

inline

Return if the orbit size was specified using the orbital period.

SpecifiedAsRevsPerDay()

bool wsf::space::OrbitSize::SpecifiedAsRevsPerDay ( ) const

inline

Return if the orbit size was specified using the number of revolutions per day.

SpecifiedAsSemiMajorAxis()

bool wsf::space::OrbitSize::SpecifiedAsSemiMajorAxis ( ) const

inline

Return if the orbit size was specified using the semi-major axis.

---

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

• WsfSpaceOrbitSize.hpp
• WsfSpaceOrbitSize.cpp