prmMaskedVector< _elementType > Class Template Reference

#include <prmMaskedVector.h>

Inheritance diagram for prmMaskedVector< _elementType >:

Public Types
typedef size_t	size_type
typedef prmMaskedVector< _elementType >	ThisType
typedef mtsGenericObject	BaseType
typedef vctDynamicVector< _elementType >	DataType

Public Member Functions
	prmMaskedVector (void)
void	SetSize (const size_type size)
	prmMaskedVector (const size_type size)
	prmMaskedVector (const DataType &data, const vctBoolVec &mask)
	prmMaskedVector (const ThisType &otherVector)
	~prmMaskedVector ()
virtual std::string	ToString (void) const
void	ToStream (std::ostream &outputStream) const override
void	SerializeRaw (std::ostream &outputStream) const override
void	DeSerializeRaw (std::istream &inputStream) 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 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
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

Protected Member Functions
	CMN_DECLARE_MEMBER_AND_ACCESSORS (DataType, Data)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, Mask)

Member Typedef Documentation

BaseType

template<class _elementType>

typedef mtsGenericObject prmMaskedVector< _elementType >::BaseType

DataType

template<class _elementType>

typedef vctDynamicVector<_elementType> prmMaskedVector< _elementType >::DataType

size_type

template<class _elementType>

typedef size_t prmMaskedVector< _elementType >::size_type

ThisType

template<class _elementType>

typedef prmMaskedVector<_elementType> prmMaskedVector< _elementType >::ThisType

Constructor & Destructor Documentation

prmMaskedVector() [1/4]

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector ( void )

inline

Default constructor.

prmMaskedVector() [2/4]

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector ( const size_type size )

inline

Constructor with memory allocation for a given size.

prmMaskedVector() [3/4]

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector ( const DataType & data, const vctBoolVec & mask )

inline

prmMaskedVector() [4/4]

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector ( const ThisType & otherVector )

inline

Copy constructor.

~prmMaskedVector()

template<class _elementType>

prmMaskedVector< _elementType >::~prmMaskedVector ( )

inline

Default destructor, will call the destructor of the contained vector and free the memory.

Member Function Documentation

CMN_DECLARE_MEMBER_AND_ACCESSORS() [1/2]

template<class _elementType>

prmMaskedVector< _elementType >::CMN_DECLARE_MEMBER_AND_ACCESSORS ( DataType , Data  )

protected

Vector of values for this container

CMN_DECLARE_MEMBER_AND_ACCESSORS() [2/2]

template<class _elementType>

prmMaskedVector< _elementType >::CMN_DECLARE_MEMBER_AND_ACCESSORS ( vctBoolVec , Mask  )

protected

Masks for the cooresponding vector

DeSerializeRaw()

template<class _elementType>

void prmMaskedVector< _elementType >::DeSerializeRaw ( std::istream & inputStream )

inlineoverridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

SerializeRaw()

template<class _elementType>

void prmMaskedVector< _elementType >::SerializeRaw ( std::ostream & outputStream ) const

inlineoverridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

SetSize()

template<class _elementType>

void prmMaskedVector< _elementType >::SetSize ( const size_type size )

inline

Set vector same size for each element, this is required if the above constructor is not used Sets all elements to 0

ToStream()

template<class _elementType>

void prmMaskedVector< _elementType >::ToStream ( std::ostream & outputStream ) const

inlineoverridevirtual

To stream human readable output

Reimplemented from mtsGenericObject.

ToString()

template<class _elementType>

virtual std::string prmMaskedVector< _elementType >::ToString ( void ) const

inlinevirtual

To stream human readable output

---

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

• tmp/cisst-saw/cisst/cisstParameterTypes/prmMaskedVector.h