O_SESSAME::OrbitStateRepresentation Class Reference
[Orbit State Represenations]

#include <OrbitStateRepresentation.h>

Inheritance diagram for O_SESSAME::OrbitStateRepresentation:

[legend]List of all members.

---

Detailed Description

Abstract base type of the orbit state representation.

The OrbitStateRepresentation class provides an interface to the group of orbit state representations. This representation can be position & velocity, keplerian elements, canonical parameters, or any other representation of an orbit state.

There can never be an actual instantiation of an OrbitStateRepresentation. This is an abstract data type (ADT) and just provides a required interface for the derived types. Don't try to use: OrbitStateRepresentation myOrbRep; Just use as a pointer to the derived types.

Example:

Definition at line 45 of file OrbitStateRepresentation.h.

Public Member Functions
virtual void	SetPositionVelocity (const Vector &_Position, const Vector &_Velocity)=0
	Set the orbit representation using position and velocity components.
virtual void	SetPositionVelocity (const Vector &_PositionVelocity)=0
	Set the orbit representation using position and velocity components.
virtual Vector	GetPositionVelocity () const=0
	Return the position and velocity vectors of the orbit state.
virtual void	GetPositionVelocity (Vector &_Position, Vector &_Velocity) const=0
	Return the position and velocity vectors of the orbit state by reference (through the input parameters).
virtual OrbitStateRepresentation *	NewPointer ()=0
	Return a pointer to a new instance of a derived orbit state representation type.
virtual OrbitStateRepresentation *	Clone ()=0
	Return a pointer to a copy of a derived instance orbit state representation type.
virtual void	SetState (const Vector &_Elements)=0
	Set the vector of the representation's state vector.
virtual Vector	GetState () const=0
	Return a vector of the representation's state vector.

---

Member Function Documentation

virtual void O_SESSAME::OrbitStateRepresentation::SetPositionVelocity (  const Vector &  _Position, const Vector &  _Velocity )  [pure virtual]

Set the orbit representation using position and velocity components. Parameters: _Position  3-element vector of position components. (km) _Velocity  3-element vector of vector components. (km/s) Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual void O_SESSAME::OrbitStateRepresentation::SetPositionVelocity (  const Vector &  _PositionVelocity  )  [pure virtual]

Set the orbit representation using position and velocity components. Parameters: _PositionVelocity  6-element vector of position & velocity components. (km, km/s) Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual Vector O_SESSAME::OrbitStateRepresentation::GetPositionVelocity (   )  const [pure virtual]

Return the position and velocity vectors of the orbit state. Returns: 6-element vector of position and velocity vector components. [km, km, km, km/s, km/s, km/s]^T Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual void O_SESSAME::OrbitStateRepresentation::GetPositionVelocity (  Vector &  _Position, Vector &  _Velocity )  const [pure virtual]

Return the position and velocity vectors of the orbit state by reference (through the input parameters). Parameters: _Position  a Vector through which to return the 3-element position vector. (km) _Velocity  a Vector through which to return the 3-element velocity vector. (km/s) Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual OrbitStateRepresentation* O_SESSAME::OrbitStateRepresentation::NewPointer (   )  [pure virtual]

Return a pointer to a new instance of a derived orbit state representation type. This is used to request memory for a new instance of a derived instance when the actual type of the derived object is unknown. By calling this function, the compiler links to the correct derived function to return a pointer and allocate memory of the correct type. Example: OrbitStateRepresentation* newOrbRep = oldOrbRep->NewPointer(); Returns: a pointer to a new allocation of memory for the appropriate representation. Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual OrbitStateRepresentation* O_SESSAME::OrbitStateRepresentation::Clone (   )  [pure virtual]

Return a pointer to a copy of a derived instance orbit state representation type. This is used to request memory for and copy of an instance of a derived representation when the actual type of the derived object is unknown. By calling this function, the compiler links to the correct derived function to return a pointer and allocate memory of the correct type and copy the data. Example: OrbitStateRepresentation* copyOldOrbRep = oldOrbRep->Clone(); Returns: a pointer to a copy of the appropriate representation. Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual void O_SESSAME::OrbitStateRepresentation::SetState (  const Vector &  _Elements  )  [pure virtual]

Set the vector of the representation's state vector. Warning: Depracted - Do Not Use - will be moved internally Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

virtual Vector O_SESSAME::OrbitStateRepresentation::GetState (   )  const [pure virtual]

Return a vector of the representation's state vector. Warning: Depracted - Do Not Use - will be moved internally Implemented in O_SESSAME::Keplerian, and O_SESSAME::PositionVelocity.

---