cisst-saw
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
prmIMUSensors Class Reference

#include <prmIMUSensors.h>

Inheritance diagram for prmIMUSensors:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmIMUSensors (void)
 prmIMUSensors (const prmIMUSensors &other)
prmIMUSensors & operator= (const prmIMUSensors &other)
 ~prmIMUSensors ()
void GetAccel (vct3 &placeHolder) const
vct3 GetAccel (void) const
void SetAccel (const vct3 &newValue)
const vct3 & Accel (void) const
vct3 & Accel (void)
void GetGyro (vct3 &placeHolder) const
vct3 GetGyro (void) const
void SetGyro (const vct3 &newValue)
const vct3 & Gyro (void) const
vct3 & Gyro (void)
void GetMag (vct3 &placeHolder) const
vct3 GetMag (void) const
void SetMag (const vct3 &newValue)
const vct3 & Mag (void) const
vct3 & Mag (void)
void GetTemp (double &placeHolder) const
double GetTemp (void) const
void SetTemp (const double &newValue)
const double & Temp (void) const
double & Temp (void)
void GetPressure (double &placeHolder) const
double GetPressure (void) const
void SetPressure (const double &newValue)
const double & Pressure (void) const
double & Pressure (void)
void SerializeRaw (std::ostream &outputStream) const override
void DeSerializeRaw (std::istream &inputStream) override
void ToStream (std::ostream &outputStream) const override
void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
void Copy (const prmIMUSensors &source)
bool ScalarNumberIsFixed (void) const override
size_t ScalarNumber (void) const 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 bool FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
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

Public Attributes

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string SerializeDescription (const char delimiter=',', const std::string &userDescription="") const
void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string HumanReadable (void) const

Protected Attributes

vct3 mAccel
vct3 mGyro
vct3 mMag
double mTemp
double mPressure

Constructor & Destructor Documentation

◆ prmIMUSensors() [1/2]

prmIMUSensors::prmIMUSensors ( void )

◆ prmIMUSensors() [2/2]

prmIMUSensors::prmIMUSensors ( const prmIMUSensors & other)

◆ ~prmIMUSensors()

prmIMUSensors::~prmIMUSensors ( )

Member Function Documentation

◆ Accel() [1/2]

vct3 & prmIMUSensors::Accel ( void )

◆ Accel() [2/2]

const vct3 & prmIMUSensors::Accel ( void ) const

◆ Copy()

void prmIMUSensors::Copy ( const prmIMUSensors & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetAccel() [1/2]

void prmIMUSensors::GetAccel ( vct3 & placeHolder) const

◆ GetAccel() [2/2]

vct3 prmIMUSensors::GetAccel ( void ) const
inline

◆ GetGyro() [1/2]

void prmIMUSensors::GetGyro ( vct3 & placeHolder) const

◆ GetGyro() [2/2]

vct3 prmIMUSensors::GetGyro ( void ) const
inline

◆ GetMag() [1/2]

void prmIMUSensors::GetMag ( vct3 & placeHolder) const

◆ GetMag() [2/2]

vct3 prmIMUSensors::GetMag ( void ) const
inline

◆ GetPressure() [1/2]

void prmIMUSensors::GetPressure ( double & placeHolder) const

◆ GetPressure() [2/2]

double prmIMUSensors::GetPressure ( void ) const
inline

◆ GetTemp() [1/2]

void prmIMUSensors::GetTemp ( double & placeHolder) const

◆ GetTemp() [2/2]

double prmIMUSensors::GetTemp ( void ) const
inline

◆ Gyro() [1/2]

vct3 & prmIMUSensors::Gyro ( void )

◆ Gyro() [2/2]

const vct3 & prmIMUSensors::Gyro ( void ) const

◆ Mag() [1/2]

vct3 & prmIMUSensors::Mag ( void )

◆ Mag() [2/2]

const vct3 & prmIMUSensors::Mag ( void ) const

◆ operator=()

prmIMUSensors & prmIMUSensors::operator= ( const prmIMUSensors & other)

◆ Pressure() [1/2]

double & prmIMUSensors::Pressure ( void )

◆ Pressure() [2/2]

const double & prmIMUSensors::Pressure ( void ) const

◆ ScalarNumber()

size_t prmIMUSensors::ScalarNumber ( void ) const
overridevirtual

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.

◆ ScalarNumberIsFixed()

bool prmIMUSensors::ScalarNumberIsFixed ( void ) const
overridevirtual

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.

◆ SerializeRaw()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetAccel()

void prmIMUSensors::SetAccel ( const vct3 & newValue)

◆ SetGyro()

void prmIMUSensors::SetGyro ( const vct3 & newValue)

◆ SetMag()

void prmIMUSensors::SetMag ( const vct3 & newValue)

◆ SetPressure()

void prmIMUSensors::SetPressure ( const double & newValue)

◆ SetTemp()

void prmIMUSensors::SetTemp ( const double & newValue)

◆ Temp() [1/2]

double & prmIMUSensors::Temp ( void )

◆ Temp() [2/2]

const double & prmIMUSensors::Temp ( void ) const

◆ ToStream()

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

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.

◆ ToStreamRaw()

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

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

◆ HumanReadable

void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string prmIMUSensors::HumanReadable(void) const

◆ mAccel

vct3 prmIMUSensors::mAccel
protected

◆ mGyro

vct3 prmIMUSensors::mGyro
protected

◆ mMag

vct3 prmIMUSensors::mMag
protected

◆ mPressure

double prmIMUSensors::mPressure
protected

◆ mTemp

double prmIMUSensors::mTemp
protected

◆ SerializeDescription

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string prmIMUSensors::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const
The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0