prmActuatorState Class Reference

#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 ()
	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)
void	ToStream (std::ostream &outputStream) const override
void	SerializeRaw (std::ostream &outputStream) const override
void	DeSerializeRaw (std::istream &inputStream) override
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
mtsGenericObject &	operator= (const mtsGenericObject &other)
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
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 CISST_THROW(std
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

BaseType

typedef mtsGenericObject prmActuatorState::BaseType

size_type

typedef unsigned int prmActuatorState::size_type

ThisType

typedef prmActuatorState prmActuatorState::ThisType

Constructor & Destructor Documentation

prmActuatorState() [1/2]

prmActuatorState::prmActuatorState ( )

inline

default constructor - does nothing for now

prmActuatorState() [2/2]

prmActuatorState::prmActuatorState

(

size_type

size

)

~prmActuatorState()

virtual prmActuatorState::~prmActuatorState ( )

inlinevirtual

constructor with all possible parameters *‍/ inline prmActuatorState(const prmPosition & position, const mtsStateIndex & stateIndex): PositionMember(position), StateIndexMember(stateIndex) {}

/*! destructor 

Member Function Documentation

CMN_DECLARE_MEMBER_AND_ACCESSORS() [1/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	bool	,
		EStopON	)

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

CMN_DECLARE_MEMBER_AND_ACCESSORS() [2/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	mtsDoubleVec	,
		Position	)

Set and Get methods for the the position.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [3/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	mtsDoubleVec	,
		Velocity	)

Set and Get methods for the the Velocity.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [4/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		HardFwdLimitHit	)

Set and Get methods for the forward HARDWARE limits hit.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [5/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		HardRevLimitHit	)

Set and Get methods for the reverse HARDWARE Limit.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [6/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		HomeSwitchOn	)

Set and Get methods for the HomeSwitch .

CMN_DECLARE_MEMBER_AND_ACCESSORS() [7/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		InMotion	)

Set and Get methods for the the position.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [8/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		IsHomed	)

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

CMN_DECLARE_MEMBER_AND_ACCESSORS() [9/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		MotorOff	)

Set and Get methods for the the position.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [10/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		SoftFwdLimitHit	)

Set and Get methods for the forward SOFTWARE limits hit.

CMN_DECLARE_MEMBER_AND_ACCESSORS() [11/11]

prmActuatorState::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		SoftRevLimitHit	)

Set and Get methods for the reverse SOFTWARE Limit.

DeSerializeRaw()

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

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

SerializeRaw()

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

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

SetSize()

void prmActuatorState::SetSize

(

size_type

size

)

ToStream()

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

overridevirtual

Human readable output to stream.

Reimplemented from mtsGenericObject.

---

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

• tmp/cisst-saw/cisst/cisstParameterTypes/prmActuatorState.h