Mix-in that add metadata capabilitie to objects.
More...
#include <nxwriter.h>
|
| void | AddMetadata (const std::string &strKey, const std::string &strValue) |
| |
| void | AddMetadata (const std::string &strKey, const char *pszValue) |
| |
| void | AddMetadata (const std::string &strKey, int iValue) |
| |
| void | AddMetadata (const std::string &strKey, long lValue) |
| |
| void | AddMetadata (const std::string &strKey, double dValue) |
| |
| bool | HasMetadata (const std::string &strKey) const |
| |
| bool | GetMetadata (const std::string &strKey, std::string *pstrValue, bool bThrow=true) const |
| |
| bool | GetStringMetadata (const std::string &strKey, std::string *pstrValue, bool bThrow=true) const |
| |
| std::string | StringMetadata (const std::string &strKey) const |
| |
| bool | GetIntegerMetadata (const std::string &strKey, int *piValue, bool bThrow=true) const |
| |
| int | IntegerMetadata (const std::string &strKey) const |
| |
| bool | GetLongIntegerMetadata (const std::string &strKey, long *plValue, bool bThrow=true) const |
| |
| long | LongIntegerMetadata (const std::string &strKey) const |
| |
| bool | GetDoubleMetadata (const std::string &strKey, double *pdValue, bool bThrow=true) const |
| |
| double | DoubleMetadata (const std::string &strKey) const |
| |
| Type | GetMetadataType (const std::string &strKey, bool bThrow=true) const |
| |
| std::list< std::string > | MetadataKeys () const |
| | Returns the metadata keys std::list. More...
|
| |
| void | ClearMetadata () |
| | Clear all metadata. More...
|
| |
Mix-in that add metadata capabilitie to objects.
◆ Type
| Enumerator |
|---|
| NONE | |
| STRING | |
| INT | |
| LONGINT | |
| DOUBLE | |
◆ AddMetadata() [1/5]
| void nxcpp::MMetadata::AddMetadata |
( |
const std::string & |
strKey, |
|
|
const std::string & |
strValue |
|
) |
| |
Add std::string metadata
- Parameters
-
| strKey | metadata name |
| strValue | metadata value |
◆ AddMetadata() [2/5]
| void nxcpp::MMetadata::AddMetadata |
( |
const std::string & |
strKey, |
|
|
const char * |
pszValue |
|
) |
| |
Add C-ansi std::string metadata
- Parameters
-
| strKey | metadata name |
| pszValue | metadata value |
◆ AddMetadata() [3/5]
| void nxcpp::MMetadata::AddMetadata |
( |
const std::string & |
strKey, |
|
|
int |
iValue |
|
) |
| |
Add integer matedata
- Parameters
-
| strKey | metadata name |
| iValue | metadata value |
◆ AddMetadata() [4/5]
| void nxcpp::MMetadata::AddMetadata |
( |
const std::string & |
strKey, |
|
|
long |
lValue |
|
) |
| |
Add integer matedata
- Parameters
-
| strKey | metadata name |
| lValue | metadata value |
◆ AddMetadata() [5/5]
| void nxcpp::MMetadata::AddMetadata |
( |
const std::string & |
strKey, |
|
|
double |
dValue |
|
) |
| |
Add float metadata
- Parameters
-
| strKey | metadata name |
| dValue | metadata value |
◆ ClearMetadata()
| void nxcpp::MMetadata::ClearMetadata |
( |
| ) |
|
◆ DoubleMetadata()
| double nxcpp::MMetadata::DoubleMetadata |
( |
const std::string & |
strKey | ) |
const |
Get long float (double-type) metadata
- Parameters
-
- Returns
- metadata value
- Exceptions
-
| Throw | an exception if the key is not found |
◆ GetDoubleMetadata()
| bool nxcpp::MMetadata::GetDoubleMetadata |
( |
const std::string & |
strKey, |
|
|
double * |
pdValue, |
|
|
bool |
bThrow = true |
|
) |
| const |
Get long float (double-type) metadata
- Parameters
-
| strKey | metadata name |
| [out] | pdValue | pointer output value |
| bThrow | if true throw a exception in case of no data |
- Returns
- true if metadata was found, otherwise false (if bThrow == false)
◆ GetIntegerMetadata()
| bool nxcpp::MMetadata::GetIntegerMetadata |
( |
const std::string & |
strKey, |
|
|
int * |
piValue, |
|
|
bool |
bThrow = true |
|
) |
| const |
Get integer metadata
- Parameters
-
| strKey | metadata name |
| [out] | piValue | pointer output value |
| bThrow | if true throw a exception in case of no data |
- Returns
- true if metadata was found, otherwise false (if bThrow == false)
◆ GetLongIntegerMetadata()
| bool nxcpp::MMetadata::GetLongIntegerMetadata |
( |
const std::string & |
strKey, |
|
|
long * |
plValue, |
|
|
bool |
bThrow = true |
|
) |
| const |
Get long integer metadata
- Parameters
-
| strKey | metadata name |
| [out] | plValue | pointer output value |
| bThrow | if true throw a exception in case of no data |
- Returns
- true if metadata was found, otherwise false (if bThrow == false)
◆ GetMetadata()
| bool nxcpp::MMetadata::GetMetadata |
( |
const std::string & |
strKey, |
|
|
std::string * |
pstrValue, |
|
|
bool |
bThrow = true |
|
) |
| const |
Get metadata as std::string Implicitely convert integer and float metadata as string value
- Parameters
-
| strKey | metadata name |
| [out] | pstrValue | Value as string |
| bThrow | if true throw a exception in case of no data |
- Returns
- true if metadata was found, otherwise false (if bThrow == false)
◆ GetMetadataType()
| Type nxcpp::MMetadata::GetMetadataType |
( |
const std::string & |
strKey, |
|
|
bool |
bThrow = true |
|
) |
| const |
Get type of a metadata from its key name
- Parameters
-
| strKey | metadata name |
| bThrow | if true throw a exception in case of no data |
- Returns
- MMetadata::Type value
◆ GetStringMetadata()
| bool nxcpp::MMetadata::GetStringMetadata |
( |
const std::string & |
strKey, |
|
|
std::string * |
pstrValue, |
|
|
bool |
bThrow = true |
|
) |
| const |
Get string metadata
- Parameters
-
| strKey | metadata name |
| [out] | pstrValue | pointer output value |
| bThrow | if true throw a exception in case of no data |
- Returns
- true if metadata was found, otherwise false (if bThrow == false)
◆ HasMetadata()
| bool nxcpp::MMetadata::HasMetadata |
( |
const std::string & |
strKey | ) |
const |
Check metadata
- Parameters
-
◆ IntegerMetadata()
| int nxcpp::MMetadata::IntegerMetadata |
( |
const std::string & |
strKey | ) |
const |
Get integer metadata
- Parameters
-
- Returns
- metadata value
- Exceptions
-
| Throw | an exception if the key is not found |
◆ LongIntegerMetadata()
| long nxcpp::MMetadata::LongIntegerMetadata |
( |
const std::string & |
strKey | ) |
const |
Get long integer metadata
- Parameters
-
- Returns
- metadata value
- Exceptions
-
| Throw | an exception if the key is not found |
◆ MetadataKeys()
| std::list<std::string> nxcpp::MMetadata::MetadataKeys |
( |
| ) |
const |
Returns the metadata keys std::list.
◆ StringMetadata()
| std::string nxcpp::MMetadata::StringMetadata |
( |
const std::string & |
strKey | ) |
const |
Get string metadata
- Parameters
-
- Returns
- metadata value
- Exceptions
-
| Throw | an exception if the key is not found |
The documentation for this class was generated from the following file:
- /home/poirier/filer2/dev/nexuscpp/include/nexuscpp/nxwriter.h