Raytrix Light Field SDK  5.0
Rx::CRxMetaData Class Reference

Detailed Description

Handles a collection of meta data of different types.

Inherited by Rx::LFR::CMetaData.

Public Member Functions

 CRxMetaData ()
 Default constructor. More...
 
 CRxMetaData (const CRxMetaData &xData)
 Copy constructor. More...
 
 ~CRxMetaData ()
 Destructor. More...
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxArrayDouble &xData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxArrayString &xData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxArrayUInt &xData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxString &sxData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, double dData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, unsigned uData)
 Adds an element into the respective parameter map. More...
 
void Clear ()
 Clears this object to its blank/initial state. More...
 
void GetElement (const CRxString &sxLabel, CRxArrayDouble &xData) const
 
void GetElement (const CRxString &sxLabel, CRxArrayString &xData) const
 
void GetElement (const CRxString &sxLabel, CRxArrayUInt &xData) const
 
void GetElement (const CRxString &sxLabel, CRxString &sxData) const
 
void GetElement (const CRxString &sxLabel, double &dData) const
 
void GetElement (const CRxString &sxLabel, unsigned &uData) const
 
size_t GetElementCount () const
 Gets the element count. More...
 
void GetElementInfos (const CRxString &sxName, CRxString &sxType, CRxString &sxGroup) const
 Gets all information about the given element. More...
 
void GetElementInfos (size_t nIdx, CRxString &sxName, CRxString &sxType, CRxString &sxGroup) const
 Gets all information about the given element. More...
 
bool HasElement (const CRxString &sxLabel) const
 Query if metadata has element with label sxLabel. More...
 
CRxMetaDataoperator= (const CRxMetaData &xData)
 Assignment operator. More...
 
void SetElement (const CRxString &sxLabel, const CRxArrayDouble &xData)
 
void SetElement (const CRxString &sxLabel, const CRxArrayString &xData)
 
void SetElement (const CRxString &sxLabel, const CRxArrayUInt &xData)
 
void SetElement (const CRxString &sxLabel, const CRxString &sxData)
 
void SetElement (const CRxString &sxLabel, double dData)
 
void SetElement (const CRxString &sxLabel, unsigned uData)
 

Constructor & Destructor Documentation

◆ CRxMetaData() [1/2]

Rx::CRxMetaData::CRxMetaData ( )

Default constructor.

◆ CRxMetaData() [2/2]

Rx::CRxMetaData::CRxMetaData ( const CRxMetaData xData)

Copy constructor.

Parameters
xDataThe data.

◆ ~CRxMetaData()

Rx::CRxMetaData::~CRxMetaData ( )

Destructor.

Member Function Documentation

◆ AddElement() [1/6]

void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxArrayDouble xData 
)

◆ AddElement() [2/6]

void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxArrayString xData 
)

◆ AddElement() [3/6]

void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxArrayUInt xData 
)

◆ AddElement() [4/6]

void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxString sxData 
)

◆ AddElement() [5/6]

void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
double  dData 
)

◆ AddElement() [6/6]

void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
unsigned  uData 
)

Adds an element into the respective parameter map.

If an element already exists in the map it gets overwritten.

Parameters
sxLabelThe name of the element.
sxGroupThe group of the element.
uDataThe value of the element.

◆ Clear()

void Rx::CRxMetaData::Clear ( )

Clears this object to its blank/initial state.

◆ GetElement() [1/6]

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxArrayDouble xData 
) const

◆ GetElement() [2/6]

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxArrayString xData 
) const

◆ GetElement() [3/6]

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxArrayUInt xData 
) const

◆ GetElement() [4/6]

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxString sxData 
) const

◆ GetElement() [5/6]

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
double &  dData 
) const

◆ GetElement() [6/6]

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
unsigned &  uData 
) const

◆ GetElementCount()

size_t Rx::CRxMetaData::GetElementCount ( ) const

Gets the element count.

Returns
The element count.

◆ GetElementInfos() [1/2]

void Rx::CRxMetaData::GetElementInfos ( const CRxString sxName,
CRxString sxType,
CRxString sxGroup 
) const

Gets all information about the given element.

Parameters
sxName[in] The name of the element.
sxType[out] The type of the element.
sxGroup[out] The group of the element.

◆ GetElementInfos() [2/2]

void Rx::CRxMetaData::GetElementInfos ( size_t  nIdx,
CRxString sxName,
CRxString sxType,
CRxString sxGroup 
) const

Gets all information about the given element.

Parameters
nIdxThe index of the element.
sxName[out] The name of the element.
sxType[out] The type of the element.
sxGroup[out] The group of the element.

◆ HasElement()

bool Rx::CRxMetaData::HasElement ( const CRxString sxLabel) const

Query if metadata has element with label sxLabel.

Parameters
sxLabelThe Label.
Returns
True if element, false if not.

◆ operator=()

CRxMetaData& Rx::CRxMetaData::operator= ( const CRxMetaData xData)

Assignment operator.

Parameters
xDataThe data.
Returns
A shallow copy of this object.

◆ SetElement() [1/6]

void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxArrayDouble xData 
)

◆ SetElement() [2/6]

void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxArrayString xData 
)

◆ SetElement() [3/6]

void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxArrayUInt xData 
)

◆ SetElement() [4/6]

void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxString sxData 
)

◆ SetElement() [5/6]

void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
double  dData 
)

◆ SetElement() [6/6]

void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
unsigned  uData 
)