WsfConstellation Class Reference

#include <WsfConstellation.hpp>

Public Member Functions
	WsfConstellation (const WsfConstellationManager &aManager, const WsfConstellationOptions &aOptions)
bool	IsGeneral () const
	Return if this constellation was created with a general design.
bool	IsWalkerDelta () const
	Return if this constellation was created with a Walker Delta design.
bool	IsWalkerStar () const
	Return if this constellation was created with a Walker Star design.
unsigned int	GetTotalSats () const
unsigned int	GetNumPlanes () const
	Return the number of orbital planes in the design of this constellation.
unsigned int	GetSatsPerPlane () const
	Return the number of members per orbital plane in the design of this constellation.
unsigned int	GetWalkerF () const
UtAngleValue	GetAnomalyAlias () const
	Return the inter-plane phasing angle for the design of this constellation.
UtAngleValue	GetRAAN_Range () const
	Return the range in RAAN for the orbital planes for this constellation.
std::string	GetName () const
	Return the constellation's name.
std::string	GetPlatformType () const
	Return the platform type of the members of this constellation.
UtLengthValue	GetSemiMajorAxis () const
	Return the semi-major axis of the orbits in this constellation.
UtLengthValue	GetCircularAltitude () const
	Return the circular altitude of the orbits in this constellation.
UtTimeValue	GetOrbitalPeriod () const
	Return the orbital period of the orbits in this constellation.
double	GetRevolutionsPerDay () const
	Return the number of revolutions per day of the orbits in this constellation.
UtAngleValue	GetInclination () const
	Return the inclination of the orbits in this constellation.
UtAngleValue	GetInitialRAAN () const
	Return the RAAN of the zeroth orbital plane for this constellation.
UtAngleValue	GetInitialAnomaly () const
	Return the initial true anomaly of the zeroth member of the zeroth plane in this constellation.
std::string	GetMemberName (unsigned int aPlane, unsigned int aMember) const
WsfPlatform *	GetMember (unsigned int aPlane, unsigned int aMember) const

Constructor & Destructor Documentation

WsfConstellation()

WsfConstellation::WsfConstellation	(	const WsfConstellationManager &	aManager,
		const WsfConstellationOptions &	aOptions )

Member Function Documentation

GetAnomalyAlias()

UtAngleValue WsfConstellation::GetAnomalyAlias ( ) const

inline

Return the inter-plane phasing angle for the design of this constellation.

GetCircularAltitude()

UtLengthValue WsfConstellation::GetCircularAltitude ( ) const

inline

Return the circular altitude of the orbits in this constellation.

GetInclination()

UtAngleValue WsfConstellation::GetInclination ( ) const

inline

Return the inclination of the orbits in this constellation.

GetInitialAnomaly()

UtAngleValue WsfConstellation::GetInitialAnomaly ( ) const

inline

Return the initial true anomaly of the zeroth member of the zeroth plane in this constellation.

GetInitialRAAN()

UtAngleValue WsfConstellation::GetInitialRAAN ( ) const

inline

Return the RAAN of the zeroth orbital plane for this constellation.

GetMember()

WsfPlatform * WsfConstellation::GetMember	(	unsigned int	aPlane,
		unsigned int	aMember ) const

Return a constellation member platform.

Return the WsfPlatform for the constellation member in the given aPlane and given aMember position in that plane. This will return either the member platform if it exists, or a nullptr, if that member platform does not exist.

Parameters

aPlane	- The orbital plane of the member.
aMember	- The position in the given aPlane of the member.

Returns

- The platform if it exists; nullptr otherwise.

References GetMemberName().

GetMemberName()

std::string WsfConstellation::GetMemberName	(	unsigned int	aPlane,
		unsigned int	aMember ) const

Return the name of a constellation member.

Return the name of the member at the given aPlane and at the given position, aMember. This returns the name of what the member would be whether or not that member currently exists in the simulation.

Parameters

aPlane	- The orbital plane of the member.
aMember	- The position in the given aPlane of the member.

Returns

- The name of the member platform that would take that position in the constellation.

References GetName().

Referenced by GetMember().

GetName()

std::string WsfConstellation::GetName ( ) const

inline

Return the constellation's name.

Referenced by GetMemberName().

GetNumPlanes()

unsigned int WsfConstellation::GetNumPlanes ( ) const

inline

Return the number of orbital planes in the design of this constellation.

GetOrbitalPeriod()

UtTimeValue WsfConstellation::GetOrbitalPeriod ( ) const

inline

Return the orbital period of the orbits in this constellation.

GetPlatformType()

std::string WsfConstellation::GetPlatformType ( ) const

inline

Return the platform type of the members of this constellation.

GetRAAN_Range()

UtAngleValue WsfConstellation::GetRAAN_Range ( ) const

inline

Return the range in RAAN for the orbital planes for this constellation.

GetRevolutionsPerDay()

double WsfConstellation::GetRevolutionsPerDay ( ) const

inline

Return the number of revolutions per day of the orbits in this constellation.

GetSatsPerPlane()

unsigned int WsfConstellation::GetSatsPerPlane ( ) const

inline

Return the number of members per orbital plane in the design of this constellation.

GetSemiMajorAxis()

UtLengthValue WsfConstellation::GetSemiMajorAxis ( ) const

inline

Return the semi-major axis of the orbits in this constellation.

GetTotalSats()

unsigned int WsfConstellation::GetTotalSats ( ) const

inline

Return the total number of members in the design of this constellation.

This returns the number of members in the design of this constellation, not the current number of member platforms that exist in the simulation.

Returns

- The number of members in the design of this constellation.

GetWalkerF()

unsigned int WsfConstellation::GetWalkerF ( ) const

inline

Return the Walker inter-plane phasing parameter.

The return value is only meaningful when this constellation has a Walker Delta or Walker Star design. Constellations with a general design will always return 0 in this method.

Returns

- The Walker inter-plane phasing parameter, or 0 for general constellations.

IsGeneral()

bool WsfConstellation::IsGeneral ( ) const

inline

Return if this constellation was created with a general design.

IsWalkerDelta()

bool WsfConstellation::IsWalkerDelta ( ) const

inline

Return if this constellation was created with a Walker Delta design.

IsWalkerStar()

bool WsfConstellation::IsWalkerStar ( ) const

inline

Return if this constellation was created with a Walker Star design.

---

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

• WsfConstellation.hpp
• WsfConstellation.cpp