WhorlSim Class Reference

#include <WhorlSim.h>

Collaboration diagram for WhorlSim:

[legend]List of all members.

Public Types
enum	StringValue {   OFF, ON, s_atterrbiasObserver, s_AttitudeObserver,   s_DefaultObserver, s_triadObserver, s_QuaternionEKFObserver, s_DefaultController,   s_AngularRateController, s_MWCMGController, s_OpenLoopMWController, s_MRPTracking,   s_slidingModeControlMRPMW, s_GPSObserver, s_OrbitPropObserver, s_COENaaszController }
	Value-Definitions of the different string values. More...
Public Member Functions
	WhorlSim ()
	WhorlSim (Whorl *ptr_whorl)
virtual	~WhorlSim ()
int	Initialize (TiXmlHandle handle)
	Initialize a whorlsim object.
void	SetObserver (TiXmlHandle handle)
	Set Observer.
void	SetController (TiXmlHandle handle)
	Set Controller.
void	SetOrbitObserver (TiXmlHandle handle)
	Set Orbit Observer.
void	SetOrbitController (TiXmlHandle handle)
	Set Orbit Controller.
Vector	GetState ()
timeval	GetTime ()
void	Observe ()
void	Control ()
void	OrbitObserve ()
void	OrbitControl ()
Public Attributes
map< string, StringValue >	s_mapStringValues
	Map to associate the strings with the enum values.
Private Attributes
Whorl *	m_omniscient
Observer *	m_omnipresent
Controller *	m_omnipotent
OrbitObserver *	m_omnipresent2
OrbitController *	m_omnipotent2
string	m_observerName
string	m_controllerName
string	m_OrbitObserverName
string	m_OrbitControllerName

---

Member Enumeration Documentation

enum WhorlSim::StringValue

Value-Definitions of the different string values. Enumeration values: OFF  ON  s_atterrbiasObserver  s_AttitudeObserver  s_DefaultObserver  s_triadObserver  s_QuaternionEKFObserver  s_DefaultController  s_AngularRateController  s_MWCMGController  s_OpenLoopMWController  s_MRPTracking  s_slidingModeControlMRPMW  s_GPSObserver  s_OrbitPropObserver  s_COENaaszController  Definition at line 96 of file WhorlSim.h.

---

Constructor & Destructor Documentation

WhorlSim::WhorlSim (   )

Definition at line 15 of file WhorlSim.cpp.

WhorlSim::WhorlSim (  Whorl *  ptr_whorl  )

Definition at line 18 of file WhorlSim.cpp. References m_omniscient.

WhorlSim::~WhorlSim (   )  [virtual]

Definition at line 23 of file WhorlSim.cpp. References Whorl::GetHardwareFlag(), m_controllerName, m_observerName, m_omniscient, m_OrbitObserverName, OFF, ON, and s_mapStringValues.

---

Member Function Documentation

void WhorlSim::Control (   )  [inline]

Runs the controller Definition at line 87 of file WhorlSim.h. Referenced by main().

Vector WhorlSim::GetState (   )  [inline]

Get current state Definition at line 78 of file WhorlSim.h. References O_SESSAME::Vector.

timeval WhorlSim::GetTime (   )  [inline]

Get current time of estimate Definition at line 81 of file WhorlSim.h.

int WhorlSim::Initialize (  TiXmlHandle  handle  )

Initialize a whorlsim object. Initializes the simulator Definition at line 81 of file WhorlSim.cpp. References Whorl::GetHardwareFlag(), m_omniscient, OFF, ON, s_mapStringValues, SetController(), SetObserver(), SetOrbitController(), and SetOrbitObserver(). Referenced by main().

void WhorlSim::Observe (   )  [inline]

Runs the observer Definition at line 84 of file WhorlSim.h. Referenced by main().

void WhorlSim::OrbitControl (   )  [inline]

Runs the Orbit controller Definition at line 93 of file WhorlSim.h.

void WhorlSim::OrbitObserve (   )  [inline]

Runs the Orbit observer Definition at line 90 of file WhorlSim.h.

void WhorlSim::SetController (  TiXmlHandle  handle  )

Set Controller. Parameters: handle  XML handle with current whorl as starting node Definition at line 180 of file WhorlSim.cpp. References TiXmlHandle::Child(), TiXmlHandle::Element(), TiXmlHandle::FirstChild(), Whorl::GetSimulatorName(), m_controllerName, m_omnipotent, m_omniscient, OFF, s_AngularRateController, s_DefaultController, s_mapStringValues, s_MRPTracking, s_MWCMGController, s_OpenLoopMWController, and s_slidingModeControlMRPMW. Referenced by Initialize().

void WhorlSim::SetObserver (  TiXmlHandle  handle  )

Set Observer. Parameters: handle  XML handle with current whorl as starting node Definition at line 139 of file WhorlSim.cpp. References TiXmlHandle::Child(), TiXmlHandle::Element(), TiXmlHandle::FirstChild(), Whorl::GetSimulatorName(), m_observerName, m_omnipresent, m_omniscient, OFF, s_atterrbiasObserver, s_AttitudeObserver, s_DefaultObserver, s_mapStringValues, s_QuaternionEKFObserver, and s_triadObserver. Referenced by Initialize().

void WhorlSim::SetOrbitController (  TiXmlHandle  handle  )

Set Orbit Controller. Parameters: handle  XML handle with current whorl as starting node Definition at line 257 of file WhorlSim.cpp. References TiXmlHandle::Child(), TiXmlHandle::Element(), TiXmlHandle::FirstChild(), Whorl::GetSimulatorName(), m_omnipotent2, m_omniscient, m_OrbitControllerName, OFF, s_GPSObserver, and s_mapStringValues. Referenced by Initialize().

void WhorlSim::SetOrbitObserver (  TiXmlHandle  handle  )

Set Orbit Observer. Parameters: handle  XML handle with current whorl as starting node Definition at line 229 of file WhorlSim.cpp. References TiXmlHandle::Child(), TiXmlHandle::Element(), TiXmlHandle::FirstChild(), Whorl::GetSimulatorName(), m_omnipresent2, m_omniscient, m_OrbitObserverName, OFF, s_GPSObserver, s_mapStringValues, and s_OrbitPropObserver. Referenced by Initialize().

---

Member Data Documentation

string WhorlSim::m_controllerName [private]

Definition at line 128 of file WhorlSim.h. Referenced by SetController(), and ~WhorlSim().

string WhorlSim::m_observerName [private]

Definition at line 127 of file WhorlSim.h. Referenced by SetObserver(), and ~WhorlSim().

Controller* WhorlSim::m_omnipotent [private]

Definition at line 122 of file WhorlSim.h. Referenced by SetController().

OrbitController* WhorlSim::m_omnipotent2 [private]

Definition at line 125 of file WhorlSim.h. Referenced by SetOrbitController().

Observer* WhorlSim::m_omnipresent [private]

Definition at line 121 of file WhorlSim.h. Referenced by SetObserver().

OrbitObserver* WhorlSim::m_omnipresent2 [private]

Definition at line 124 of file WhorlSim.h. Referenced by SetOrbitObserver().

Whorl* WhorlSim::m_omniscient [private]

Definition at line 120 of file WhorlSim.h. Referenced by Initialize(), SetController(), SetObserver(), SetOrbitController(), SetOrbitObserver(), WhorlSim(), and ~WhorlSim().

string WhorlSim::m_OrbitControllerName [private]

Definition at line 131 of file WhorlSim.h. Referenced by SetOrbitController().

string WhorlSim::m_OrbitObserverName [private]

Definition at line 130 of file WhorlSim.h. Referenced by SetOrbitObserver(), and ~WhorlSim().

map<string, StringValue> WhorlSim::s_mapStringValues

Map to associate the strings with the enum values. Definition at line 114 of file WhorlSim.h. Referenced by Initialize(), SetController(), SetObserver(), SetOrbitController(), SetOrbitObserver(), and ~WhorlSim().

---

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

• WhorlSim.h
• WhorlSim.cpp

---