ERC CISST - cisst software

---

prmMaskedVector< _elementType > Class Template Reference

Inheritance diagram for prmMaskedVector< _elementType >:

[legend]Collaboration diagram for prmMaskedVector< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class prmMaskedVector< _elementType >

Definition at line 36 of file prmMaskedVector.h.

Public Types

• typedef prmMaskedVector< _elementType > ThisType
• typedef vctDynamicVector<
  _elementType > DataType

Public Member Functions

• prmMaskedVector (void)
• void SetSize (size_type size)
• prmMaskedVector (size_type size)
• prmMaskedVector (const ThisType &otherVector)
• bool Allocate (const mtsGenericObject *model)
• ~prmMaskedVector ()
• virtual std::string ToString (void) const
• virtual void ToStream (std::ostream &outputStream) const

Protected Types

• typedef unsigned int size_type

Protected Member Functions

• CMN_DECLARE_MEMBER_AND_ACCESSORS (DataType, Data)

• CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, Mask)

---

Member Typedef Documentation

template<class _elementType>

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

This type.

Definition at line 44 of file prmMaskedVector.h.

template<class _elementType>

typedef unsigned int prmMaskedVector< _elementType >::size_type [protected]

Type used to define the size of the vector.

Definition at line 50 of file prmMaskedVector.h.

---

Constructor & Destructor Documentation

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector

(

void

)

[inline]

Default constructor.

Definition at line 65 of file prmMaskedVector.h.

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector

(

size_type

size

)

[inline]

Constructor with memory allocation for a given size.

Definition at line 82 of file prmMaskedVector.h.

References prmMaskedVector< _elementType >::SetSize().

template<class _elementType>

prmMaskedVector< _elementType >::prmMaskedVector

(

const ThisType &

otherVector

)

[inline]

Copy constructor.

Definition at line 93 of file prmMaskedVector.h.

template<class _elementType>

prmMaskedVector< _elementType >::~prmMaskedVector

(

)

[inline]

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

Definition at line 116 of file prmMaskedVector.h.

---

Member Function Documentation

template<class _elementType>

prmMaskedVector< _elementType >::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	DataType	,
		Data
	)			[protected]

Vector of values for this container

template<class _elementType>

prmMaskedVector< _elementType >::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBoolVec	,
		Mask
	)			[protected]

Masks for the cooresponding vector

template<class _elementType>

void prmMaskedVector< _elementType >::SetSize

(

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

Definition at line 73 of file prmMaskedVector.h.

Referenced by prmMaskedVector< _elementType >::prmMaskedVector().

template<class _elementType>

bool prmMaskedVector< _elementType >::Allocate

(

const mtsGenericObject *

model

)

[inline]

Allocate memory based on an existing object of the same type. The object is provided via a cmnGenericObject pointer. If a dynamic cast to this type is not possible, this method returns false.

Definition at line 103 of file prmMaskedVector.h.

template<class _elementType>

virtual std::string prmMaskedVector< _elementType >::ToString

(

void

)

const [inline, virtual]

To stream human readable output

Reimplemented from cmnGenericObject.

Definition at line 119 of file prmMaskedVector.h.

References prmMaskedVector< _elementType >::ToStream().

template<class _elementType>

virtual void prmMaskedVector< _elementType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

To stream human readable output

Reimplemented from mtsGenericObject.

Definition at line 126 of file prmMaskedVector.h.

References mtsGenericObject::ToStream().

Referenced by prmMaskedVector< _elementType >::ToString().

---

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

• prmMaskedVector.h

---