Actuator Class Reference

#include <Actuator.h>

Inheritance diagram for Actuator:

[legend]Collaboration diagram for Actuator:

[legend]List of all members.

Public Member Functions
virtual	~Actuator ()
virtual int	Stop ()=0
virtual int	Initialize ()
	Initializes the device for use.
virtual int	GetWheelCount ()
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
	Actuator ()
virtual int	Deinitialize ()
	Deinitializes the device from further use.
Protected Attributes
char *	name

---

Constructor & Destructor Documentation

Actuator::~Actuator (   )  [virtual]

Definition at line 24 of file Actuator.cpp.

Actuator::Actuator (   )  [protected]

Definition at line 19 of file Actuator.cpp.

---

Member Function Documentation

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

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 Device::c_bNotActive, and Device::SetActive(). Referenced by Device::~Device(), Relay::~Relay(), and Thruster::~Thruster().

Vector Device::GetLocation (   )  const [inherited]

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.

virtual int Actuator::GetWheelCount (   )  [inline, virtual]

Reimplemented in MomentumWheel. Definition at line 27 of file Actuator.h.

int Actuator::Initialize (   )  [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 from Device. Reimplemented in ControlMomentGyro, PhysicalControlMomentGyro, PhysicalMomentumWheel, Thruster, and Relay. Definition at line 28 of file Actuator.cpp. References Device::Initialize(). Referenced by MomentumWheel::MomentumWheel().

bool Device::IsActive (   )  [inherited]

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::Device().

void Device::SetLocation (  const Vector &  newDeviceLocation  )  [inherited]

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 Device::m_Location, and O_SESSAME::Vector.

virtual int Actuator::Stop (   )  [pure virtual]

Implemented in ControlMomentGyro, LinearActuator, MomentumWheel, PhysicalControlMomentGyro, PhysicalMomentumWheel, Thruster, and Relay.

---

Member Data Documentation

const bool Device::c_bActive = true [static, inherited]

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

const bool Device::c_bNotActive = false [static, inherited]

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

char* Device::name [protected, inherited]

Definition at line 56 of file Device.h.

---

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

• Actuator.h
• Actuator.cpp

---