O_SESSAME::PositionVelocity Class Reference
[Orbit State Represenations]

#include <PositionVelocity.h>

Inheritance diagram for O_SESSAME::PositionVelocity:

[legend]List of all members.

---

Detailed Description

Position & Velocity representation of the orbital position.

The PositionVelocity class stores the position and velocity components of an orbital position. This should be used in an OrbitState object to also store the appropriate reference frame.

Example:

Definition at line 32 of file PositionVelocity.h.

Public Member Functions
	PositionVelocity ()
	Create an initially empty PositionVelocity orbit state representation.
	PositionVelocity (const Vector &_State)
	Create a PositionVelocity orbit state representation from a vector of the position & velocity elements.
	PositionVelocity (const Vector &_Position, const Vector &_Velocity)
	Create a PositionVelocity orbit state representation from the position & velocity vectors.
virtual	~PositionVelocity ()
	Default Deconstructor.
void	SetPositionVelocity (const Vector &_Position, const Vector &_Velocity)
	Set the PositionVelocity representation directly from the position and velocity vectors.
void	SetPositionVelocity (const Vector &_PositionVelocity)
	Set the PositionVelocity representation by converting the position and velocity vector.
Vector	GetPositionVelocity () const
	Return the stored position and velocity vector.
void	GetPositionVelocity (Vector &_Position, Vector &_Velocity) const
	Return the stored position and velocity vectors by reference.
virtual PositionVelocity *	NewPointer ()
	Return a pointer to a new instance of a PositionVelocity orbit state representation type.
virtual PositionVelocity *	Clone ()
	Return a pointer to a copy of the PositionVelocity orbit state representation instance.
virtual void	SetState (const Vector &_State)
	Set the vector of the representation's state vector.
virtual void	SetState (const Vector &_Position, const Vector &_Velocity)
virtual Vector	GetState () const
	Return a vector of the representation's state vector.
virtual void	GetState (Vector &_Position, Vector &_Velocity) const
Private Attributes
Vector	m_Elements

---

Constructor & Destructor Documentation

O_SESSAME::PositionVelocity::PositionVelocity (   )

Create an initially empty PositionVelocity orbit state representation. Definition at line 15 of file PositionVelocity.cpp.

O_SESSAME::PositionVelocity::PositionVelocity (  const Vector &  _State  )

Create a PositionVelocity orbit state representation from a vector of the position & velocity elements. Parameters: _State  6-element vector of the position and velocity components. (km, km/s) Definition at line 24 of file PositionVelocity.cpp.

O_SESSAME::PositionVelocity::PositionVelocity (  const Vector &  _Position, const Vector &  _Velocity )

Create a PositionVelocity orbit state representation from the position & velocity vectors. Parameters: _Position  3-element vector of the position components. (km) _Velocity  3-element vector of the velocity components. (km/s) Definition at line 29 of file PositionVelocity.cpp.

O_SESSAME::PositionVelocity::~PositionVelocity (   )  [virtual]

Default Deconstructor. Definition at line 20 of file PositionVelocity.cpp.

---

Member Function Documentation

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

Set the PositionVelocity representation directly from the position and velocity vectors. Parameters: _Position  3-element vector of position components. (km) _Velocity  3-element vector of vector components. (km/s) _TargetOrbFrame  Reference frame that the vector components are in. Implements O_SESSAME::OrbitStateRepresentation. Definition at line 59 of file PositionVelocity.cpp.

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

Set the PositionVelocity representation by converting the position and velocity vector. Parameters: _Position  6-element vector of position and velocity components. (km, km/s) _TargetOrbFrame  Reference frame that the vector components are in. Implements O_SESSAME::OrbitStateRepresentation. Definition at line 60 of file PositionVelocity.h.

Vector O_SESSAME::PositionVelocity::GetPositionVelocity (   )  const [virtual]

Return the stored position and velocity vector. Returns: 6-element vector of position and velocity vector components. [km, km, km, km/s, km/s, km/s]^T Implements O_SESSAME::OrbitStateRepresentation. Definition at line 65 of file PositionVelocity.h.

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

Return the stored position and velocity vectors by reference. 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) Implements O_SESSAME::OrbitStateRepresentation. Definition at line 71 of file PositionVelocity.h.

PositionVelocity * O_SESSAME::PositionVelocity::NewPointer (   )  [virtual]

Return a pointer to a new instance of a PositionVelocity orbit state representation type. This is used to request memory for a new instance of a PositionVelocity. It is necessary when attempting to get a pointer from the abstract data type OrbitStateRepresentation and the actual representation type isn't known. Returns: a pointer to a new allocation of memory for the PositionVelocity object. Implements O_SESSAME::OrbitStateRepresentation. Definition at line 65 of file PositionVelocity.cpp.

PositionVelocity * O_SESSAME::PositionVelocity::Clone (   )  [virtual]

Return a pointer to a copy of the PositionVelocity orbit state representation instance. This is used to request memory for a copy of this instance of PositionVelocity. It is necessary when attempting to get a pointer from the abstract data type OrbitStateRepresentation and the actual representation type isn't known. Returns: a pointer to a copy of the PositionVelocity object. Implements O_SESSAME::OrbitStateRepresentation. Definition at line 70 of file PositionVelocity.cpp.

void O_SESSAME::PositionVelocity::SetState (  const Vector &  _State  )  [virtual]

Set the vector of the representation's state vector. Warning: Depracted - Do Not Use - will be moved internally Implements O_SESSAME::OrbitStateRepresentation. Definition at line 34 of file PositionVelocity.cpp.

void O_SESSAME::PositionVelocity::SetState (  const Vector &  _Position, const Vector &  _Velocity )  [virtual]

Definition at line 39 of file PositionVelocity.cpp.

Vector O_SESSAME::PositionVelocity::GetState (   )  const [virtual]

Return a vector of the representation's state vector. Warning: Depracted - Do Not Use - will be moved internally Implements O_SESSAME::OrbitStateRepresentation. Definition at line 45 of file PositionVelocity.cpp.

void O_SESSAME::PositionVelocity::GetState (  Vector &  _Position, Vector &  _Velocity )  const [virtual]

Definition at line 50 of file PositionVelocity.cpp.

---

Member Data Documentation

Vector O_SESSAME::PositionVelocity::m_Elements [private]

6x1 vector of position and velocity vector components (km, km/s) Definition at line 98 of file PositionVelocity.h.

---