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

#include <prmImageFrame.h>

Inheritance diagram for prmImageFrame:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmImageFrame (void)
 prmImageFrame (const prmImageFrame &other)
prmImageFrame & operator= (const prmImageFrame &other)
 ~prmImageFrame ()
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 GetChannels (size_t &placeHolder) const
size_t GetChannels (void) const
void SetChannels (const size_t &newValue)
const size_t & Channels (void) const
size_t & Channels (void)
void GetData (vctDynamicVector< char > &placeHolder) const
vctDynamicVector< char > GetData (void) const
void SetData (const vctDynamicVector< char > &newValue)
const vctDynamicVector< char > & Data (void) const
vctDynamicVector< char > & Data (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 prmImageFrame &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
size_t mChannels
vctDynamicVector< char > mData

Constructor & Destructor Documentation

◆ prmImageFrame() [1/2]

prmImageFrame::prmImageFrame ( void )

◆ prmImageFrame() [2/2]

prmImageFrame::prmImageFrame ( const prmImageFrame & other)

◆ ~prmImageFrame()

prmImageFrame::~prmImageFrame ( )

Member Function Documentation

◆ Channels() [1/2]

size_t & prmImageFrame::Channels ( void )

◆ Channels() [2/2]

const size_t & prmImageFrame::Channels ( void ) const

◆ Copy()

void prmImageFrame::Copy ( const prmImageFrame & source)

◆ Data() [1/2]

vctDynamicVector< char > & prmImageFrame::Data ( void )

◆ Data() [2/2]

const vctDynamicVector< char > & prmImageFrame::Data ( void ) const

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetChannels() [1/2]

void prmImageFrame::GetChannels ( size_t & placeHolder) const

◆ GetChannels() [2/2]

size_t prmImageFrame::GetChannels ( void ) const
inline

◆ GetData() [1/2]

void prmImageFrame::GetData ( vctDynamicVector< char > & placeHolder) const

◆ GetData() [2/2]

vctDynamicVector< char > prmImageFrame::GetData ( void ) const
inline

◆ GetHeight() [1/2]

void prmImageFrame::GetHeight ( size_t & placeHolder) const

◆ GetHeight() [2/2]

size_t prmImageFrame::GetHeight ( void ) const
inline

◆ GetWidth() [1/2]

void prmImageFrame::GetWidth ( size_t & placeHolder) const

◆ GetWidth() [2/2]

size_t prmImageFrame::GetWidth ( void ) const
inline

◆ Height() [1/2]

size_t & prmImageFrame::Height ( void )

◆ Height() [2/2]

const size_t & prmImageFrame::Height ( void ) const

◆ operator=()

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetChannels()

void prmImageFrame::SetChannels ( const size_t & newValue)

◆ SetData()

void prmImageFrame::SetData ( const vctDynamicVector< char > & newValue)

◆ SetHeight()

void prmImageFrame::SetHeight ( const size_t & newValue)

◆ SetWidth()

void prmImageFrame::SetWidth ( const size_t & newValue)

◆ ToStream()

void prmImageFrame::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 prmImageFrame::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 & prmImageFrame::Width ( void )

◆ Width() [2/2]

const size_t & prmImageFrame::Width ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mChannels

size_t prmImageFrame::mChannels
protected

◆ mData

vctDynamicVector<char> prmImageFrame::mData
protected

◆ mHeight

size_t prmImageFrame::mHeight
protected

◆ mWidth

size_t prmImageFrame::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 prmImageFrame::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