#include <prmActuatorState.h>

Inheritance diagram for prmActuatorState:

Public Types
typedef prmActuatorState	ThisType

typedef mtsGenericObject	BaseType

typedef unsigned int	size_type

Public Member Functions
	prmActuatorState ()

	prmActuatorState (size_type size)

void	SetSize (size_type size)

virtual	~prmActuatorState ()

void	ToStream (std::ostream &outputStream) const

void	SerializeRaw (std::ostream &outputStream) const

void	DeSerializeRaw (std::istream &inputStream)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (mtsDoubleVec, Position)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (mtsDoubleVec, Velocity)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, InMotion)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, MotorOff)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, SoftFwdLimitHit)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, SoftRevLimitHit)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, HardFwdLimitHit)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, HardRevLimitHit)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, HomeSwitchOn)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, IsHomed)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (bool, EStopON)

Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)

	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)

	mtsGenericObject (const mtsGenericObject &other)

virtual	~mtsGenericObject (void)

bool	SetTimestampIfAutomatic (double timestamp)

virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const

virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')

size_t	ScalarNumber (void) const

bool	ScalarNumberIsFixed (void) const

double	Scalar (const size_t index) const throw (std::out_of_range)

std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)

Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)

virtual const cmnClassServicesBase *	Services (void) const =0

bool	ReconstructFrom (const cmnGenericObject &other)

std::string	ToString (void) const

virtual cmnLogger::StreamBufType *	GetLogMultiplexer (void) const

virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)

virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Detailed Description

A container for Controlloer's Actuator states Position, Velocity, etc. for each actuator

Member Typedef Documentation

typedef mtsGenericObject prmActuatorState::BaseType

typedef unsigned int prmActuatorState::size_type

typedef prmActuatorState prmActuatorState::ThisType

Constructor & Destructor Documentation

prmActuatorState::prmActuatorState ( )

inline

default constructor - does nothing for now

prmActuatorState::prmActuatorState ( size_type size )

virtual prmActuatorState::~prmActuatorState ( )

inlinevirtual

constructor with all possible parameters

destructor

Member Function Documentation

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	mtsDoubleVec	,
		Position
	)

Set and Get methods for the the position.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	mtsDoubleVec	,
		Velocity
	)

Set and Get methods for the the Velocity.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		InMotion
	)

Set and Get methods for the the position.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		MotorOff
	)

Set and Get methods for the the position.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		SoftFwdLimitHit
	)

Set and Get methods for the forward SOFTWARE limits hit.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		SoftRevLimitHit
	)

Set and Get methods for the reverse SOFTWARE Limit.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		HardFwdLimitHit
	)

Set and Get methods for the forward HARDWARE limits hit.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		HardRevLimitHit
	)

Set and Get methods for the reverse HARDWARE Limit.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		HomeSwitchOn
	)

Set and Get methods for the HomeSwitch .

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		IsHomed
	)

Set and Get methods for state of homing variable on the controller.

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	bool	,
		EStopON
	)

Set and Get methods for the state of the estop button.

void prmActuatorState::DeSerializeRaw ( std::istream & inputStream )

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

void prmActuatorState::SerializeRaw ( std::ostream & outputStream ) const

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void prmActuatorState::SetSize ( size_type size )

void prmActuatorState::ToStream ( std::ostream & outputStream ) const

virtual

Human readable output to stream.

Reimplemented from mtsGenericObject.

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstParameterTypes/prmActuatorState.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation