WhorlHistory Class Reference

#include <WhorlHistory.h>

List of all members.

---

Detailed Description

Class for storing a time history of Simulator states.

Definition at line 33 of file WhorlHistory.h.

Public Member Functions
	WhorlHistory (TiXmlHandle _handle, string _WhorlName)
	Constructs an empty Whorl history.
virtual	~WhorlHistory ()
	Default Deconstructor.
int	Initialize ()
	Initialze function.
int	Deinitialize ()
	Deinitialze function.
int	Parse (TiXmlHandle _handle, string _WhorlName)
	Parse Config file for logging parameters.
void	AppendHistory (ssfTime _Time, Vector _AttitudeState, Vector _AttitudeControl)
	Append the time, attitude, and other states of the Simulator to a file.
void	AppendHistory (ssfTime _Time, Vector _AttitudeState, Vector _AttitudeControl, Vector _MRP)
	Append the time, attitude, and other states of the Simulator to a file.
void	AppendHistory (ssfTime _Time, Vector _AttitudeState, Vector _AttitudeControl, Vector _MRP, Vector _ReferenceAttitudeState, Vector _ReferenceMRP, Vector _ControlError)
	Append the time, attitude, and other states of the Simulator to a file.
Private Attributes
ofstream *	m_File
	Member ofstream in WheelHistory.h of data file to be saved.
string	m_FilePath
	Member string in WheelHistory.h, path of file.
string	m_TestID
	Member string in WheelHistory.h, identify specific test which is in file name.
string	m_FileExtension
	Member string in WheelHistory.h, identify file extension for data to be saved as.
string	m_ObjectName
	Member string in WheelHistory.h, the name of the object having data saved.
string	m_FileName
	Member string in WheelHistory.h, Name of file.

---

Constructor & Destructor Documentation

WhorlHistory::WhorlHistory (  TiXmlHandle  _handle, string  _WhorlName )

Constructs an empty Whorl history. Parameters: _handle  is a TiXmlHanlde with the configuration parameters. _WhorlName  is a string with the name of the Simulator. Definition at line 18 of file WhorlHistory.cpp. References Initialize(), m_File, and Parse().

WhorlHistory::~WhorlHistory (   )  [virtual]

Default Deconstructor. Definition at line 26 of file WhorlHistory.cpp. References Deinitialize().

---

Member Function Documentation

void WhorlHistory::AppendHistory (  ssfTime  _Time, Vector  _AttitudeState, Vector  _AttitudeControl, Vector  _MRP, Vector  _ReferenceAttitudeState, Vector  _ReferenceMRP, Vector  _ControlError )

Append the time, attitude, and other states of the Simulator to a file. Parameters: _Time  is an ssfTime object that holds the time of wheel speed measurement. _AttitudeState  is a Vector for attitude representation 1x(1:4) quaternion 1x(5:7) angular rates [rad/s] _AttitudeControl  is a Vector for attitude control 1x3 [N-m] _MRP  is a Vector for attitude 1x3 Definition at line 129 of file WhorlHistory.cpp. References m_File, and O_SESSAME::Vector.

void WhorlHistory::AppendHistory (  ssfTime  _Time, Vector  _AttitudeState, Vector  _AttitudeControl, Vector  _MRP )

Append the time, attitude, and other states of the Simulator to a file. Parameters: _Time  is an ssfTime object that holds the time of wheel speed measurement. _AttitudeState  is a Vector for attitude representation 1x(1:4) quaternion 1x(5:7) angular rates [rad/s] _AttitudeControl  is a Vector for attitude control 1x3 [N-m] _MRP  is a Vector for attitude 1x3 Definition at line 97 of file WhorlHistory.cpp. References m_File, and O_SESSAME::Vector.

void WhorlHistory::AppendHistory (  ssfTime  _Time, Vector  _AttitudeState, Vector  _AttitudeControl )

Append the time, attitude, and other states of the Simulator to a file. Parameters: _Time  is an ssfTime object that holds the time of wheel speed measurement. _AttitudeState  is a Vector for attitude representation 1x(1:4) quaternion 1x(5:7) angular rates [rad/s] _AttitudeControl  is a Vector for attitude control 1x3 [N-m] Definition at line 70 of file WhorlHistory.cpp. References m_File, and O_SESSAME::Vector. Referenced by main().

int WhorlHistory::Deinitialize (   )

Deinitialze function. Definition at line 39 of file WhorlHistory.cpp. References m_File. Referenced by ~WhorlHistory().

int WhorlHistory::Initialize (   )

Initialze function. Definition at line 32 of file WhorlHistory.cpp. References m_File, and m_FileName. Referenced by WhorlHistory().

int WhorlHistory::Parse (  TiXmlHandle  _handle, string  _WhorlName )

Parse Config file for logging parameters. Parameters: _handle  is a TiXmlHanlde with the configuration parameters. _WhorlName  is a string with the name of the Simulator. Definition at line 50 of file WhorlHistory.cpp. References TiXmlHandle::Child(), TiXmlHandle::Element(), TiXmlHandle::FirstChild(), m_FileExtension, m_FileName, m_FilePath, m_ObjectName, and m_TestID. Referenced by WhorlHistory().

---

Member Data Documentation

ofstream* WhorlHistory::m_File [private]

Member ofstream in WheelHistory.h of data file to be saved. Definition at line 55 of file WhorlHistory.h. Referenced by AppendHistory(), Deinitialize(), Initialize(), and WhorlHistory().

string WhorlHistory::m_FileExtension [private]

Member string in WheelHistory.h, identify file extension for data to be saved as. Definition at line 64 of file WhorlHistory.h. Referenced by Parse().

string WhorlHistory::m_FileName [private]

Member string in WheelHistory.h, Name of file. Definition at line 70 of file WhorlHistory.h. Referenced by Initialize(), and Parse().

string WhorlHistory::m_FilePath [private]

Member string in WheelHistory.h, path of file. Definition at line 58 of file WhorlHistory.h. Referenced by Parse().

string WhorlHistory::m_ObjectName [private]

Member string in WheelHistory.h, the name of the object having data saved. Definition at line 67 of file WhorlHistory.h. Referenced by Parse().

string WhorlHistory::m_TestID [private]

Member string in WheelHistory.h, identify specific test which is in file name. Definition at line 61 of file WhorlHistory.h. Referenced by Parse().

---

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

• WhorlHistory.h
• WhorlHistory.cpp

---