dl::V2::IImage::IMetadataKey Class Reference

#include <dlapi.h>

Public Types
enum class	Type {   UNKNOWN = 0 , INT , FLOAT , DOUBLE ,   STRING , BOOL }

Public Member Functions
virtual unsigned int	id () const =0
virtual const char *	key () const =0
virtual Type	type () const =0
virtual const char *	value () const =0
	Returns the value of the metadata key as received from the camera (in string-encoded format).
virtual int	asInt () const =0
	Returns the value of the metadata key as an integer.
virtual float	asFloat () const =0
	Returns the value of the metadata key as a floating-point number.
virtual double	asDouble () const =0
	Returns the value of the metadata key as a double-precision floating-point number.
virtual const char *	asString () const =0
	Returns the value of the metadata key as a string.
virtual bool	asBool () const =0
	Returns the value of the metadata key as a boolean.

Member Enumeration Documentation

Type

enum class dl::V2::IImage::IMetadataKey::Type

strong

Enumerator
UNKNOWN	The type of the metadata key is unknown.
INT	The metadata key is an integer.
FLOAT	The metadata key is a floating-point number.
DOUBLE	The metadata key is a double-precision floating-point number.
STRING	The metadata key is a string.
BOOL	The metadata key is a boolean value.

                                {
                    UNKNOWN = 0,    
                    INT,            
                    FLOAT,          
                    DOUBLE,         
                    STRING,         
                    BOOL,           
                };

Member Function Documentation

asBool()

virtual bool dl::V2::IImage::IMetadataKey::asBool ( ) const

pure virtual

Returns the value of the metadata key as a boolean.

Returns

true if the key is true, false otherwise.

asDouble()

virtual double dl::V2::IImage::IMetadataKey::asDouble ( ) const

pure virtual

Returns the value of the metadata key as a double-precision floating-point number.

Returns

The double value of the metadata key. 0.0 if the key is not a double.

asFloat()

virtual float dl::V2::IImage::IMetadataKey::asFloat ( ) const

pure virtual

Returns the value of the metadata key as a floating-point number.

Returns

The floating-point value of the metadata key. 0.0 if the key is not a float.

asInt()

virtual int dl::V2::IImage::IMetadataKey::asInt ( ) const

pure virtual

Returns the value of the metadata key as an integer.

Returns

The integer value of the metadata key. 0 if the key is not an integer.

asString()

virtual const char * dl::V2::IImage::IMetadataKey::asString ( ) const

pure virtual

Returns the value of the metadata key as a string.

Returns

A pointer to the string value of the metadata key. nullptr if the key is not a string.

id()

virtual unsigned int dl::V2::IImage::IMetadataKey::id ( ) const

pure virtual

key()

virtual const char * dl::V2::IImage::IMetadataKey::key ( ) const

pure virtual

type()

virtual Type dl::V2::IImage::IMetadataKey::type ( ) const

pure virtual

value()

virtual const char * dl::V2::IImage::IMetadataKey::value ( ) const

pure virtual

Returns the value of the metadata key as received from the camera (in string-encoded format).

Returns

A pointer to the string value of the metadata key.

---

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

• C:/Users/arobi/Perforce/nightly/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h