LinearActuator Class Reference

#include <LinearActuator.h>

Inheritance diagram for LinearActuator:

[legend]Collaboration diagram for LinearActuator:

[legend]List of all members.

---

Detailed Description

Class to interface with linear actuators

Definition at line 28 of file LinearActuator.h.

Public Member Functions
	LinearActuator ()
virtual	~LinearActuator ()
int	TravelDistanceLimits (double Param_Distance)
int	TravelDistanceChecks (double Param_Distance)
int	TravelPosition (double Param_Position)
int	SetVelocity (double velocity)
int	StartJog (int direction)
int	Stop ()
int	Initialize (int Action, char *port)
int	Deinitialize ()
double	GetCurrentPosition ()
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 Attributes
char *	name
Private Attributes
double	m_CurrentPosition
PhysicalLinearActuator	m_PhysicalLinearActuator

---

Constructor & Destructor Documentation

LinearActuator::LinearActuator (   )

Default Constructor Definition at line 22 of file LinearActuator.cpp.

LinearActuator::~LinearActuator (   )  [virtual]

Deconstructor Definition at line 26 of file LinearActuator.cpp.

---

Member Function Documentation

int LinearActuator::Deinitialize (   )  [virtual]

Deinitialize the linear actuator Reimplemented from Device. Definition at line 98 of file LinearActuator.cpp. References PhysicalLinearActuator::Deinitialize(), and m_PhysicalLinearActuator.

double LinearActuator::GetCurrentPosition (   )

Will return the current position of the linear actuator (inches) Definition at line 110 of file LinearActuator.cpp. References m_CurrentPosition, m_PhysicalLinearActuator, and PhysicalLinearActuator::QueryCurrentPosition().

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 Actuator::Initialize (   )  [virtual, inherited]

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

int LinearActuator::Initialize (  int  Action, char *  port )

Initialize the linear actuator(s) Definition at line 92 of file LinearActuator.cpp. References PhysicalLinearActuator::Initialize(), and m_PhysicalLinearActuator.

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.

int LinearActuator::SetVelocity (  double  velocity  )

velocity represents velocity in the range of 0-50 Definition at line 74 of file LinearActuator.cpp. References m_PhysicalLinearActuator, and PhysicalLinearActuator::SetVelocity().

int LinearActuator::StartJog (  int  direction  )

Start linear actuator jog Definition at line 80 of file LinearActuator.cpp. References m_PhysicalLinearActuator, and PhysicalLinearActuator::StartJog().

int LinearActuator::Stop (   )  [virtual]

Stop the linear actuator Implements Actuator. Definition at line 86 of file LinearActuator.cpp. References m_PhysicalLinearActuator, and PhysicalLinearActuator::Stop().

int LinearActuator::TravelDistanceChecks (  double  Param_Distance  )

Param_Distance double representing the desired travel distance (inches) Definition at line 42 of file LinearActuator.cpp. References PhysicalLinearActuator::LowerLimit, m_PhysicalLinearActuator, PhysicalLinearActuator::QueryCurrentPosition(), PhysicalLinearActuator::TravelDistance(), and PhysicalLinearActuator::UpperLimit.

int LinearActuator::TravelDistanceLimits (  double  Param_Distance  )

Param_Distance double representing the desired travel distance (inches) Definition at line 34 of file LinearActuator.cpp. References m_PhysicalLinearActuator, and PhysicalLinearActuator::TravelDistance().

int LinearActuator::TravelPosition (  double  Param_Position  )

Param_Position double representing the desired position to move to (inches) Definition at line 67 of file LinearActuator.cpp. References m_PhysicalLinearActuator, and PhysicalLinearActuator::TravelPosition().

---

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

double LinearActuator::m_CurrentPosition [private]

Member double representing the current position of the linear actuator in inches Definition at line 96 of file LinearActuator.h. Referenced by GetCurrentPosition().

PhysicalLinearActuator LinearActuator::m_PhysicalLinearActuator [private]

Member PhysicalLinearActuator object Definition at line 99 of file LinearActuator.h. Referenced by Deinitialize(), GetCurrentPosition(), Initialize(), SetVelocity(), StartJog(), Stop(), TravelDistanceChecks(), TravelDistanceLimits(), and TravelPosition().

char* Device::name [protected, inherited]

Definition at line 56 of file Device.h.

---

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

• LinearActuator.h
• LinearActuator.cpp

---