prmGainParameters Class Reference

#include <prmGainParameters.h>

Inheritance diagram for prmGainParameters:

Public Types
typedef mtsGenericObject	BaseType

Public Member Functions
	prmGainParameters ()
	~prmGainParameters ()
void	Assign (const prmGainParameters &that)
prmGainParameters &	operator= (const prmGainParameters &that)
std::string	ToString (void) const
virtual void	ToStream (std::ostream &out) const
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
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

Public Attributes
int	AxisNumber
double	PGain
double	IGain
double	DGain
double	AccelerationFF
double	VelocityFF
double	ILimit
double	ErrorLimit
double	Offset
double	DACLimit
double	OScale
double	FrictionFF

Detailed Description

So far all the memebers are public for sake of convenience Only use getters unless you know what you are doing.

Member Typedef Documentation

typedef mtsGenericObject prmGainParameters::BaseType

Constructor & Destructor Documentation

prmGainParameters::prmGainParameters ( )

inline

prmGainParameters::~prmGainParameters ( )

inline

Member Function Documentation

void prmGainParameters::Assign ( const prmGainParameters &  that )

inline

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

inlinevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

prmGainParameters& prmGainParameters::operator= ( const prmGainParameters &  that )

inline

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

inlinevirtual

Binary serialization

Reimplemented from mtsGenericObject.

virtual void prmGainParameters::ToStream ( std::ostream &  outputStream ) const

inlinevirtual

Human readable text output. This method only streams the data members of mtsGenericObject, i.e. the Timestamp and Valid flag. It should be called by any derived class re-implementing ToStream.

Reimplemented from mtsGenericObject.

std::string prmGainParameters::ToString ( void  ) const

inline

Member Data Documentation

double prmGainParameters::AccelerationFF

int prmGainParameters::AxisNumber

double prmGainParameters::DACLimit

double prmGainParameters::DGain

double prmGainParameters::ErrorLimit

double prmGainParameters::FrictionFF

double prmGainParameters::IGain

double prmGainParameters::ILimit

double prmGainParameters::Offset

double prmGainParameters::OScale

double prmGainParameters::PGain

double prmGainParameters::VelocityFF

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstParameterTypes/prmGainParameters.h