Raytrix Light Field SDK  4.0
Logo
Public Member Functions | List of all members
Rx::LFR::CMetaData Class Reference

Detailed Description

The LFR Meta Data class

Inherits Rx::CRxMetaData.

Public Member Functions

 CMetaData ()
 Default constructor. Does not allocate image memory. More...
 
 CMetaData (const CMetaData &xMetaData)
 Move constructor. More...
 
 ~CMetaData ()
 Destructor. Frees all used memory. More...
 
void AddApplicationDetail (const CRxString &sxAppName, const CRxString &sxAppVersion)
 Writes the application details to the meta data. More...
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, unsigned uData)
 Adds an element into the respective parameter map. More...
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, double dData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxString &sxData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxArrayUInt &xData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxArrayDouble &xData)
 
void AddElement (const CRxString &sxLabel, const CRxString &sxGroup, const CRxArrayString &xData)
 
void Clear ()
 Clears this object to its blank/initial state. More...
 
void GetElement (const CRxString &sxLabel, unsigned &uData) const
 
void GetElement (const CRxString &sxLabel, double &dData) const
 
void GetElement (const CRxString &sxLabel, CRxString &sxData) const
 
void GetElement (const CRxString &sxLabel, CRxArrayUInt &xData) const
 
void GetElement (const CRxString &sxLabel, CRxArrayDouble &xData) const
 
void GetElement (const CRxString &sxLabel, CRxArrayString &xData) const
 
size_t GetElementCount () const
 Gets the element count. More...
 
void GetElementInfos (size_t nIdx, CRxString &sxName, CRxString &sxType, CRxString &sxGroup) const
 Gets all information about the given element. More...
 
void GetElementInfos (const 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...
 
CMetaDataoperator= (CMetaData &&xMetaData)
 Move assignment operator. More...
 
void SetElement (const CRxString &sxLabel, unsigned uData)
 
void SetElement (const CRxString &sxLabel, double dData)
 
void SetElement (const CRxString &sxLabel, const CRxString &sxData)
 
void SetElement (const CRxString &sxLabel, const CRxArrayUInt &xData)
 
void SetElement (const CRxString &sxLabel, const CRxArrayDouble &xData)
 
void SetElement (const CRxString &sxLabel, const CRxArrayString &xData)
 
void UpdateFrom (const CCudaCompute &xCudaCompute)
 Updates the meta data from a CUDA compute instance. More...
 
void UpdateFrom (CCamera &xCamera)
 Updates the meta data from a camera instance. More...
 
void UpdateFrom (const CRxCalibMetaData &xCalibMetaData)
 Updates the meta data from a calibration meta data instance. More...
 

Constructor & Destructor Documentation

Rx::LFR::CMetaData::CMetaData ( )

Default constructor. Does not allocate image memory.

Rx::LFR::CMetaData::CMetaData ( const CMetaData xMetaData)

Move constructor.

Parameters
xMetaData[in,out] The meta data.
Rx::LFR::CMetaData::~CMetaData ( )

Destructor. Frees all used memory.

Member Function Documentation

void Rx::LFR::CMetaData::AddApplicationDetail ( const CRxString sxAppName,
const CRxString sxAppVersion 
)

Writes the application details to the meta data.

Parameters
sxAppNameName of the application.
sxAppVersionThe application version.
void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
unsigned  uData 
)
inherited

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.
void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
double  dData 
)
inherited
void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxString sxData 
)
inherited
void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxArrayUInt xData 
)
inherited
void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxArrayDouble xData 
)
inherited
void Rx::CRxMetaData::AddElement ( const CRxString sxLabel,
const CRxString sxGroup,
const CRxArrayString xData 
)
inherited
void Rx::CRxMetaData::Clear ( )
inherited

Clears this object to its blank/initial state.

void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
unsigned &  uData 
) const
inherited
void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
double &  dData 
) const
inherited
void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxString sxData 
) const
inherited
void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxArrayUInt xData 
) const
inherited
void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxArrayDouble xData 
) const
inherited
void Rx::CRxMetaData::GetElement ( const CRxString sxLabel,
CRxArrayString xData 
) const
inherited
size_t Rx::CRxMetaData::GetElementCount ( ) const
inherited

Gets the element count.

Returns
The element count.
void Rx::CRxMetaData::GetElementInfos ( size_t  nIdx,
CRxString sxName,
CRxString sxType,
CRxString sxGroup 
) const
inherited

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.
void Rx::CRxMetaData::GetElementInfos ( const CRxString sxName,
CRxString sxType,
CRxString sxGroup 
) const
inherited

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.
bool Rx::CRxMetaData::HasElement ( const CRxString sxLabel) const
inherited

Query if metadata has element with label sxLabel.

Parameters
sxLabelThe Label.
Returns
True if element, false if not.
CMetaData& Rx::LFR::CMetaData::operator= ( CMetaData &&  xMetaData)

Move assignment operator.

Parameters
xMetaData[in,out]The meta data.
Returns
The instance.
void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
unsigned  uData 
)
inherited
void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
double  dData 
)
inherited
void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxString sxData 
)
inherited
void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxArrayUInt xData 
)
inherited
void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxArrayDouble xData 
)
inherited
void Rx::CRxMetaData::SetElement ( const CRxString sxLabel,
const CRxArrayString xData 
)
inherited
void Rx::LFR::CMetaData::UpdateFrom ( const CCudaCompute xCudaCompute)

Updates the meta data from a CUDA compute instance.

Parameters
xCudaComputeThe CUDA compute instance.
void Rx::LFR::CMetaData::UpdateFrom ( CCamera xCamera)

Updates the meta data from a camera instance.

Parameters
xCamera[in,out] The camera.
void Rx::LFR::CMetaData::UpdateFrom ( const CRxCalibMetaData xCalibMetaData)

Updates the meta data from a calibration meta data instance.

Parameters
xCalibMetaDataInformation describing the calib meta.