Relay Class Reference

#include <instrument.h>

Inheritance diagram for Relay:

[legend]Collaboration diagram for Relay:

[legend]List of all members.

Public Member Functions
	Relay ()
	Relay (cfgBody &cfgdat)
	~Relay ()
int	Stop ()
void	PowerOn (BYTE signal, int bank)
void	PowerOff ()
int	Initialize ()
	Initializes the device for use.
void	SetDeviceName (const char DeviceName)
char	GetDeviceName () const
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
virtual int	Deinitialize ()
	Deinitializes the device from further use.
Protected Attributes
char *	name
Private Attributes
PhysicalRelay	m_PhysicalRelay
DAQCard *	m_DAQCard
int	m_Device

---

Constructor & Destructor Documentation

Relay::Relay (   )

Default Constructor Definition at line 18 of file instrument.cpp.

Relay::Relay (  cfgBody &  cfgdat  )

Constructor which accepts config parsing info| Not used yet Definition at line 22 of file instrument.cpp. References getCmdIndex(), Initialize(), cfgBody::keys, m_Device, and cfgBody::vals.

Relay::~Relay (   )

Deconstructor Definition at line 37 of file instrument.cpp. References Device::Deinitialize(), and Stop().

---

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(), and Thruster::~Thruster().

char Relay::GetDeviceName (   )  const

Get the device name

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, inherited]

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

int Relay::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 Actuator. Definition at line 43 of file instrument.cpp. References PhysicalRelay::Initialize(), and m_PhysicalRelay. Referenced by Relay().

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 Relay::PowerOff (   )

Shutdown device| No argument Required Definition at line 54 of file instrument.cpp. References m_PhysicalRelay, and PhysicalRelay::PowerOff(). Referenced by main().

void Relay::PowerOn (  BYTE  signal, int  bank )

Start the device| Naming convention Device #=byte, 1=1, 2=2, 3=4, 4=8, 5=16, 6=32 Definition at line 49 of file instrument.cpp. References m_PhysicalRelay, and PhysicalRelay::PowerOn(). Referenced by main().

void Relay::SetDeviceName (  const char  DeviceName  )

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.

int Relay::Stop (   )  [virtual]

Implements Actuator. Definition at line 59 of file instrument.cpp. Referenced by ~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().

DAQCard* Relay::m_DAQCard [private]

Pointer to an instance of the DAQ card Definition at line 63 of file instrument.h.

int Relay::m_Device [private]

The index number used to reference the thruster Definition at line 66 of file instrument.h. Referenced by Relay().

PhysicalRelay Relay::m_PhysicalRelay [private]

The physical object Definition at line 60 of file instrument.h. Referenced by Initialize(), PowerOff(), and PowerOn().

char* Device::name [protected, inherited]

Definition at line 56 of file Device.h.

---

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

• instrument.h
• instrument.cpp

---