O_SESSAME::AttitudeState Class Reference

#include <AttitudeState.h>

List of all members.

Public Member Functions

 AttitudeState ()
 Default Constructor.

virtual ~AttitudeState ()
 Default Deconstructor.

 AttitudeState (const Rotation &_Rot, AttitudeFrame *_pAttFrame=NULL)
 Creates an attitude state given a rotation and attitude frame (defaults to no frame).

 AttitudeState (const Rotation &_Rot, const Vector &_AngVel, AttitudeFrame *_pAttFrame=NULL)
 Creates an attitude state given a rotation, an angular velocity and attitude frame (defaults to no frame).

void SetAttitudeFrame (AttitudeFrame *_pNewAttitudeFrame)
 Set the reference frame of the stored attitude. Will convert the old rotation to the new attitude frame if one was specified.

AttitudeFrameGetAttitudeFrame () const
 Returns a pointer to the attitude reference frame.

void SetState (const Rotation &_Rotation, const Vector &_AngVel, AttitudeFrame *_attFrame=NULL)
 Set the attitude state given a rotation, an angular velocity and attitude frame (defaults to no frame).

Vector GetState (const RotationType &_rotType=Quaternion_Type, AttitudeFrame *_attFrame=NULL, const int &_Sequence=123) const
 Return the attitude state rotation in vector format.

void SetRotation (const Rotation &_Rot)
 Set the stored rotation.

void SetRotation (const Rotation &_Rot, AttitudeFrame *_pAttFrame)
 Set the stored rotation and corresponding reference frame.

Rotation GetRotation () const
 Returns the current rotation of the attitude state.

void SetAngularVelocity (const Vector &_angVel)
 Set the stored angular velocity state.

Vector GetAngularVelocity () const
 Returns the stored angular velocity state.

Rotation GetRotation2Orbital (const OrbitState &_orbState) const
 Calculates the rotation from the current attitude state to the specified orbit reference frame.


Private Attributes

Rotation m_AttitudeRotation
Vector m_AngularVelocity
AttitudeFramem_pAttitudeFrame


Constructor & Destructor Documentation

O_SESSAME::AttitudeState::AttitudeState  ) 
 

Default Constructor.

Definition at line 17 of file AttitudeState.cpp.

O_SESSAME::AttitudeState::~AttitudeState  )  [virtual]
 

Default Deconstructor.

Todo:
delete AttitudeState data members

Definition at line 21 of file AttitudeState.cpp.

O_SESSAME::AttitudeState::AttitudeState const Rotation _Rot,
AttitudeFrame _pAttFrame = NULL
 

Creates an attitude state given a rotation and attitude frame (defaults to no frame).

Parameters:
_Rot rotation to be stored
_pAttFrame pointer to the attitude reference frame

Definition at line 28 of file AttitudeState.cpp.

O_SESSAME::AttitudeState::AttitudeState const Rotation _Rot,
const Vector _AngVel,
AttitudeFrame _pAttFrame = NULL
 

Creates an attitude state given a rotation, an angular velocity and attitude frame (defaults to no frame).

Parameters:
_Rot rotation to be stored
_AngVel angular velocity (rad/s)
_pAttFrame pointer to the attitude reference frame

Definition at line 34 of file AttitudeState.cpp.


Member Function Documentation

void O_SESSAME::AttitudeState::SetAttitudeFrame AttitudeFrame _pNewAttitudeFrame  ) 
 

Set the reference frame of the stored attitude. Will convert the old rotation to the new attitude frame if one was specified.

Parameters:
_pNewAttitudeFrame pointer to the new reference frame

Definition at line 40 of file AttitudeState.cpp.

AttitudeFrame * O_SESSAME::AttitudeState::GetAttitudeFrame  )  const
 

Returns a pointer to the attitude reference frame.

Returns:
pointer to the attitude reference frame

Definition at line 46 of file AttitudeState.cpp.

void O_SESSAME::AttitudeState::SetState const Rotation _Rotation,
const Vector _AngVel,
AttitudeFrame _attFrame = NULL
 

Set the attitude state given a rotation, an angular velocity and attitude frame (defaults to no frame).

Parameters:
_Rot rotation to be stored
_AngVel angular velocity (rad/s)
_pAttFrame pointer to the attitude reference frame

Definition at line 67 of file AttitudeState.cpp.

Vector O_SESSAME::AttitudeState::GetState const RotationType _rotType = Quaternion_Type,
AttitudeFrame _attFrame = NULL,
const int &  _Sequence = 123
const
 

Return the attitude state rotation in vector format.

Parameters:
_rotType Rotation type to return the attitude state in (ie QUAT_TYPE, MRP_TYPE, etc.)
_attFrame corresponding reference frame to return the rotation in (if none is specified, returns the rotation in the stored reference frame)
_Sequence if the requested rotation type is EULER_ANGLE_TYPE, then specify the desired rotation sequence.
Returns:
full n x 1 vector of state values corresponding to the rotation and angular velocity components (n is the number of elements in specified rotation return type)

Definition at line 77 of file AttitudeState.cpp.

void O_SESSAME::AttitudeState::SetRotation const Rotation _Rot  ) 
 

Set the stored rotation.

Parameters:
_Rot rotation to be stored as the state.

Definition at line 51 of file AttitudeState.cpp.

void O_SESSAME::AttitudeState::SetRotation const Rotation _Rot,
AttitudeFrame _pAttFrame
 

Set the stored rotation and corresponding reference frame.

Parameters:
_Rot rotation to be stored as the state.
_pAttFrame reference frame of the specified attitude.

Definition at line 56 of file AttitudeState.cpp.

Rotation O_SESSAME::AttitudeState::GetRotation  )  const
 

Returns the current rotation of the attitude state.

Parameters:
Rotation of the attitude state.

Definition at line 62 of file AttitudeState.cpp.

void O_SESSAME::AttitudeState::SetAngularVelocity const Vector _angVel  ) 
 

Set the stored angular velocity state.

Parameters:
_angVel 3x1 Vector of angular velocities about reference frame (rad/s)

Definition at line 86 of file AttitudeState.cpp.

Vector O_SESSAME::AttitudeState::GetAngularVelocity  )  const
 

Returns the stored angular velocity state.

Returns:
3x1 Vector of angular velocities about reference frame (rad/s)

Definition at line 91 of file AttitudeState.cpp.

Rotation O_SESSAME::AttitudeState::GetRotation2Orbital const OrbitState _orbState  )  const
 

Calculates the rotation from the current attitude state to the specified orbit reference frame.

Todo:
Implement algorithm.
Parameters:
_orbState orbit state to use for specifying the reference orbital frame.
Returns:
Rotation from current attitude frame to orbital frame.

Definition at line 96 of file AttitudeState.cpp.


Member Data Documentation

Rotation O_SESSAME::AttitudeState::m_AttitudeRotation [private]
 

internally stored attitude state rotation

Definition at line 129 of file AttitudeState.h.

Vector O_SESSAME::AttitudeState::m_AngularVelocity [private]
 

internally stored angular velocity

Definition at line 130 of file AttitudeState.h.

AttitudeFrame* O_SESSAME::AttitudeState::m_pAttitudeFrame [private]
 

rotation reference frame

Definition at line 131 of file AttitudeState.h.


Generated on Wed Aug 6 12:59:12 2003 for Open-Sessame Framework by doxygen1.3