Device Class Reference

#include <Device.h>

Inheritance diagram for Device:

[legend]Collaboration diagram for Device:

[legend]List of all members.

Public Member Functions
	Device (Device &_rdevDevice)
	Create a copy of object type Device.
virtual	~Device ()
	Uninitializes and removes Device from memory.
bool	IsActive ()
	Returns the current state of m_bActiveState.
Vector	GetLocation () const
	Returns the physical location of the device with respect to whorl body coordinates.
void	SetLocation (const Vector &newDeviceLocation)
	Specify the physical location of the device with respect to whorl body coordinates.
Static Public Attributes
const bool	c_bNotActive = false
	a constant bool that is equal to false.
const bool	c_bActive = true
	a constant bool that is equal to true.
Protected Member Functions
	Device ()
	Create an object of type Device.
virtual int	Initialize ()
	Initializes the device for use.
virtual int	Deinitialize ()
	Deinitializes the device from further use.
Protected Attributes
char *	name
Private Member Functions
int	SetActive (bool _bActiveState)
	Sets the value of m_bActiveState to _bActiveState.
Private Attributes
bool	m_bActiveState
	the current state of the device as to whether or not it's been initialized.
Vector	m_Location
	physical location of the device with respect to the whorl body coordinates

---

Constructor & Destructor Documentation

Device::Device (  Device &  _rdevDevice  )

Create a copy of object type Device. Author: Andrew Turner Date: March 25, 1999 This constructor copies the m_bActiveState External Methods Called: SetActive(bool) Assumptions: None Definition at line 36 of file Device.cpp. References IsActive(), and SetActive().

Device::~Device (   )  [virtual]

Uninitializes and removes Device from memory. Author: Andrew Turner Date: March 25, 1999 This constructor calls Device::Deinitialize Assumptions: None Definition at line 47 of file Device.cpp. References Deinitialize().

Device::Device (   )  [protected]

Create an object of type Device. Author: Andrew Turner Date: March 25, 1999 This constructor is called to create an object of type Device and sets the initial state to c_bNotActive Assumptions: The default state of a device is c_bNotActive Definition at line 24 of file Device.cpp. References c_bNotActive, and SetActive().

---

Member Function Documentation

int Device::Deinitialize (   )  [protected, virtual]

Deinitializes the device from further use. Author: Andrew Turner Date: March 25, 1999 Prevents the device from being used. External Methods Called: SetActive(bool) Assumptions: None Reimplemented in ControlMomentGyro, LinearActuator, MomentumWheel, PhysicalControlMomentGyro, and PhysicalMomentumWheel. Definition at line 113 of file Device.cpp. References c_bNotActive, and SetActive(). Referenced by ~Device(), Relay::~Relay(), and Thruster::~Thruster().

Vector Device::GetLocation (   )  const

Returns the physical location of the device with respect to whorl body coordinates. Returns: Physical center of the device [x,y,z]^T (meters). Definition at line 75 of file Device.cpp. References O_SESSAME::Vector.

int Device::Initialize (   )  [protected, virtual]

Initializes the device for use. Author: Andrew Turner Date: March 25, 1999 Allows the device to be used now that it is Active External Methods Called: SetActive(bool) Assumptions: None Reimplemented in ControlMomentGyro, PhysicalControlMomentGyro, PhysicalMomentumWheel, Thruster, Actuator, Relay, DMUAccelerometer, DMURateGyro, PhysicalTiltSensor, and TiltSensor. Definition at line 100 of file Device.cpp. References c_bActive, and SetActive(). Referenced by Actuator::Initialize(), and Magnetometer::Magnetometer().

bool Device::IsActive (   )

Returns the current state of m_bActiveState. Author: Andrew Turner Date: March 25, 1999 This member function is used to inspect the state of the device External Methods Called: None Assumptions: None Definition at line 59 of file Device.cpp. Referenced by Device().

int Device::SetActive (  bool  _bActiveState  )  [private]

Sets the value of m_bActiveState to _bActiveState. Author: Andrew Turner Date: March 25, 1999 This member function is used to set the current state of the device External Methods Called: None Assumptions: None Definition at line 87 of file Device.cpp. References m_bActiveState. Referenced by Deinitialize(), Device(), and Initialize().

void Device::SetLocation (  const Vector &  newDeviceLocation  )

Specify the physical location of the device with respect to whorl body coordinates. Parameters: newDeviceLocation  Physical center of the device [x,y,z]^T (meters). Definition at line 67 of file Device.cpp. References m_Location, and O_SESSAME::Vector.

---

Member Data Documentation

const bool Device::c_bActive = true [static]

a constant bool that is equal to true. Used for setting the active state Definition at line 50 of file Device.h. Referenced by Initialize().

const bool Device::c_bNotActive = false [static]

a constant bool that is equal to false. Used for setting the active state. Definition at line 48 of file Device.h. Referenced by Deinitialize(), and Device().

bool Device::m_bActiveState [private]

the current state of the device as to whether or not it's been initialized. Definition at line 63 of file Device.h. Referenced by SetActive().

Vector Device::m_Location [private]

physical location of the device with respect to the whorl body coordinates Reimplemented in TiltSensor. Definition at line 65 of file Device.h. Referenced by SetLocation().

char* Device::name [protected]

Definition at line 56 of file Device.h.

---

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

• Device.h
• Device.cpp

---