prmIMUSensors Class Reference

#include <prmIMUSensors.h>

Inheritance diagram for prmIMUSensors:

Public Member Functions
	prmIMUSensors (void)
	prmIMUSensors (const prmIMUSensors &other)
	~prmIMUSensors ()
void	GetAccel (vct3 &placeHolder) const
void	SetAccel (const vct3 &newValue)
const vct3 &	Accel (void) const
vct3 &	Accel (void)
void	GetGyro (vct3 &placeHolder) const
void	SetGyro (const vct3 &newValue)
const vct3 &	Gyro (void) const
vct3 &	Gyro (void)
void	GetMag (vct3 &placeHolder) const
void	SetMag (const vct3 &newValue)
const vct3 &	Mag (void) const
vct3 &	Mag (void)
void	GetTemp (double &placeHolder) const
void	SetTemp (const double &newValue)
const double &	Temp (void) const
double &	Temp (void)
void	GetPressure (double &placeHolder) const
void	SetPressure (const double &newValue)
const double &	Pressure (void) const
double &	Pressure (void)
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
void	ToStream (std::ostream &outputStream) const
void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
void	Copy (const prmIMUSensors &source)
void	SerializeBinary (std::ostream &outputStream) const throw (std::runtime_error)
void	DeSerializeBinary (std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) throw (std::runtime_error)
void	SerializeText (std::ostream &outputStream, const char delimiter= ',') const throw (std::runtime_error)
std::string	SerializeDescription (const char delimiter= ',', const std::string &userDescription="") const
void	DeSerializeText (std::istream &inputStream, const char delimiter= ',') throw (std::runtime_error)
std::string	HumanReadable (void) const
bool	ScalarNumberIsFixed (void) const
size_t	ScalarNumber (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 mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
bool	SetTimestampIfAutomatic (double timestamp)
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
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

Protected Attributes
vct3	mAccel
vct3	mGyro
vct3	mMag
double	mTemp
double	mPressure

Constructor & Destructor Documentation

prmIMUSensors::prmIMUSensors

(

void

)

prmIMUSensors::prmIMUSensors

(

const prmIMUSensors &

other

)

prmIMUSensors::~prmIMUSensors

(

)

Member Function Documentation

const vct3& prmIMUSensors::Accel

(

void

)

const

vct3& prmIMUSensors::Accel

(

void

)

void prmIMUSensors::Copy

(

const prmIMUSensors &

source

)

void prmIMUSensors::DeSerializeBinary	(	std::istream &	inputStream,
		const cmnDataFormat &	localFormat,
		const cmnDataFormat &	remoteFormat
	)
throw	(	std::runtime_error
	)

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

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

void prmIMUSensors::DeSerializeText	(	std::istream &	inputStream,
		const char	delimiter = ','
	)
throw	(	std::runtime_error
	)

void prmIMUSensors::GetAccel

(

vct3 &

placeHolder

)

const

void prmIMUSensors::GetGyro

(

vct3 &

placeHolder

)

const

void prmIMUSensors::GetMag

(

vct3 &

placeHolder

)

const

void prmIMUSensors::GetPressure

(

double &

placeHolder

)

const

void prmIMUSensors::GetTemp

(

double &

placeHolder

)

const

const vct3& prmIMUSensors::Gyro

(

void

)

const

vct3& prmIMUSensors::Gyro

(

void

)

std::string prmIMUSensors::HumanReadable

(

void

)

const

const vct3& prmIMUSensors::Mag

(

void

)

const

vct3& prmIMUSensors::Mag

(

void

)

const double& prmIMUSensors::Pressure

(

void

)

const

double& prmIMUSensors::Pressure

(

void

)

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

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

size_t prmIMUSensors::ScalarNumber ( void  ) const

virtual

Methods for data visualization. Derived classes should override the following methods in order to be properly processed by the data visualizer of the global component manager.

Return a number of data (which can be visualized, i.e., type-casted to double)

Reimplemented from mtsGenericObject.

bool prmIMUSensors::ScalarNumberIsFixed ( void  ) const

virtual

Indicates if this object has a fixed number of scalars. This is used for arrays of object in order to optimize random access for a given scalar. When defining an object with a fixed number of scalars, overloading this method to return true allows some optimizations.

Reimplemented from mtsGenericObject.

void prmIMUSensors::SerializeBinary	(	std::ostream &	outputStream	)	const
throw	(	std::runtime_error
	)

std::string prmIMUSensors::SerializeDescription	(	const char	delimiter = ',',
		const std::string &	userDescription = ""
	)		const

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

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void prmIMUSensors::SerializeText	(	std::ostream &	outputStream,
		const char	delimiter = ','
	)		const
throw	(	std::runtime_error
	)

void prmIMUSensors::SetAccel

(

const vct3 &

newValue

)

void prmIMUSensors::SetGyro

(

const vct3 &

newValue

)

void prmIMUSensors::SetMag

(

const vct3 &

newValue

)

void prmIMUSensors::SetPressure

(

const double &

newValue

)

void prmIMUSensors::SetTemp

(

const double &

newValue

)

const double& prmIMUSensors::Temp

(

void

)

const

double& prmIMUSensors::Temp

(

void

)

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

virtual

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.

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

virtual

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

vct3 prmIMUSensors::mAccel

protected

vct3 prmIMUSensors::mGyro

protected

vct3 prmIMUSensors::mMag

protected

double prmIMUSensors::mPressure

protected

double prmIMUSensors::mTemp

protected

---

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

• /home/adeguet1/catkin_ws/build_release/cisst/include/cisstParameterTypes/prmIMUSensors.h