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

#include <prmDepthMap.h>

Inheritance diagram for prmDepthMap:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmDepthMap (void)
 prmDepthMap (const prmDepthMap &other)
prmDepthMap & operator= (const prmDepthMap &other)
 ~prmDepthMap ()
void GetWidth (size_t &placeHolder) const
size_t GetWidth (void) const
void SetWidth (const size_t &newValue)
const size_t & Width (void) const
size_t & Width (void)
void GetHeight (size_t &placeHolder) const
size_t GetHeight (void) const
void SetHeight (const size_t &newValue)
const size_t & Height (void) const
size_t & Height (void)
void GetPoints (vctDynamicVector< float > &placeHolder) const
vctDynamicVector< float > GetPoints (void) const
void SetPoints (const vctDynamicVector< float > &newValue)
const vctDynamicVector< float > & Points (void) const
vctDynamicVector< float > & Points (void)
void GetColor (vctDynamicVector< char > &placeHolder) const
vctDynamicVector< char > GetColor (void) const
void SetColor (const vctDynamicVector< char > &newValue)
const vctDynamicVector< char > & Color (void) const
vctDynamicVector< char > & Color (void)
void GetReferenceFrame (std::string &placeHolder) const
std::string GetReferenceFrame (void) const
void SetReferenceFrame (const std::string &newValue)
const std::string & ReferenceFrame (void) const
std::string & ReferenceFrame (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 prmDepthMap &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

size_t mWidth
size_t mHeight
vctDynamicVector< float > mPoints
vctDynamicVector< char > mColor
std::string mReferenceFrame

Constructor & Destructor Documentation

◆ prmDepthMap() [1/2]

prmDepthMap::prmDepthMap ( void )

◆ prmDepthMap() [2/2]

prmDepthMap::prmDepthMap ( const prmDepthMap & other)

◆ ~prmDepthMap()

prmDepthMap::~prmDepthMap ( )

Member Function Documentation

◆ Color() [1/2]

vctDynamicVector< char > & prmDepthMap::Color ( void )

◆ Color() [2/2]

const vctDynamicVector< char > & prmDepthMap::Color ( void ) const

◆ Copy()

void prmDepthMap::Copy ( const prmDepthMap & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetColor() [1/2]

void prmDepthMap::GetColor ( vctDynamicVector< char > & placeHolder) const

◆ GetColor() [2/2]

vctDynamicVector< char > prmDepthMap::GetColor ( void ) const
inline

◆ GetHeight() [1/2]

void prmDepthMap::GetHeight ( size_t & placeHolder) const

◆ GetHeight() [2/2]

size_t prmDepthMap::GetHeight ( void ) const
inline

◆ GetPoints() [1/2]

void prmDepthMap::GetPoints ( vctDynamicVector< float > & placeHolder) const

◆ GetPoints() [2/2]

vctDynamicVector< float > prmDepthMap::GetPoints ( void ) const
inline

◆ GetReferenceFrame() [1/2]

void prmDepthMap::GetReferenceFrame ( std::string & placeHolder) const

◆ GetReferenceFrame() [2/2]

std::string prmDepthMap::GetReferenceFrame ( void ) const
inline

◆ GetWidth() [1/2]

void prmDepthMap::GetWidth ( size_t & placeHolder) const

◆ GetWidth() [2/2]

size_t prmDepthMap::GetWidth ( void ) const
inline

◆ Height() [1/2]

size_t & prmDepthMap::Height ( void )

◆ Height() [2/2]

const size_t & prmDepthMap::Height ( void ) const

◆ operator=()

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

◆ Points() [1/2]

vctDynamicVector< float > & prmDepthMap::Points ( void )

◆ Points() [2/2]

const vctDynamicVector< float > & prmDepthMap::Points ( void ) const

◆ ReferenceFrame() [1/2]

std::string & prmDepthMap::ReferenceFrame ( void )

◆ ReferenceFrame() [2/2]

const std::string & prmDepthMap::ReferenceFrame ( void ) const

◆ ScalarNumber()

size_t prmDepthMap::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 prmDepthMap::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 prmDepthMap::SerializeRaw ( std::ostream & outputStream) const
overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetColor()

void prmDepthMap::SetColor ( const vctDynamicVector< char > & newValue)

◆ SetHeight()

void prmDepthMap::SetHeight ( const size_t & newValue)

◆ SetPoints()

void prmDepthMap::SetPoints ( const vctDynamicVector< float > & newValue)

◆ SetReferenceFrame()

void prmDepthMap::SetReferenceFrame ( const std::string & newValue)

◆ SetWidth()

void prmDepthMap::SetWidth ( const size_t & newValue)

◆ ToStream()

void prmDepthMap::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 prmDepthMap::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
overridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ Width() [1/2]

size_t & prmDepthMap::Width ( void )

◆ Width() [2/2]

const size_t & prmDepthMap::Width ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mColor

vctDynamicVector<char> prmDepthMap::mColor
protected

◆ mHeight

size_t prmDepthMap::mHeight
protected

◆ mPoints

vctDynamicVector<float> prmDepthMap::mPoints
protected

◆ mReferenceFrame

std::string prmDepthMap::mReferenceFrame
protected

◆ mWidth

size_t prmDepthMap::mWidth
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 prmDepthMap::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