51Degrees Device Detection C/C++  4.2

A device detection library that is used natively or by 51Degrees products

Search

Documentation

• FiftyoneDegrees
• Common
• EntityMetaData

FiftyoneDegrees::Common::EntityMetaData< K > Class Template Reference

Detailed Description

template<class K>
class FiftyoneDegrees::Common::EntityMetaData< K >

Base class for any entity meta data.

All meta data classes should extend this class.

A meta data instance is immutable once it has been instantiated. An instance is also comparable to another via the == and != operators, provided the type K is properly implemented.

Template Parameters

K - key type for the entity which must be unique e.g. string is used for property meta data where the unique key is the name of the property. The type K must implement the < and == operators.

Inheritance diagram for FiftyoneDegrees::Common::EntityMetaData< K >:

Public Member Functions

Constructors
	EntityMetaData (K key) Construct a new instance with the key provided. More...
Getters
K	getKey () Get the unique key for this entity instance. More...
Operators
const bool	operator== (const EntityMetaData< K > other) const Returns true is the two entities share the same unique key. More...
const bool	operator!= (const EntityMetaData< K > other) const Returns true is the two entities do not share the same unique key. More...

Constructor & Destructor Documentation

◆ EntityMetaData()

template<class K>

FiftyoneDegrees::Common::EntityMetaData< K >::EntityMetaData

(

K

key

)

inline

Construct a new instance with the key provided.

Parameters

key - of type K

Member Function Documentation

◆ getKey()

template<class K>

K FiftyoneDegrees::Common::EntityMetaData< K >::getKey

(

)

inline

Get the unique key for this entity instance.

Returns

key of type K

◆ operator!=()

template<class K>

const bool FiftyoneDegrees::Common::EntityMetaData< K >::operator!=

(

const EntityMetaData< K >

other

)

const

inline

Returns true is the two entities do not share the same unique key.

Parameters

other - the other instance to compare

Returns

true if they are not equal

◆ operator==()

template<class K>

const bool FiftyoneDegrees::Common::EntityMetaData< K >::operator==

(

const EntityMetaData< K >

other

)

const

inline

Returns true is the two entities share the same unique key.

Parameters

other - the other instance to compare

Returns

true if they are equal

---

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

• /home/vsts/work/1/s/apis/device-detection-cxx/src/common-cxx/EntityMetaData.hpp

Generated by doxygen 1.8.15