◆ EntityMetaData()
Construct a new instance with the key provided.
- Parameters
-
- key - of type K
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. - 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
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 () const
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
Member Function Documentation
◆ getKey()
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/runner/work/device-detection-cxx/device-detection-cxx/common/device-detection-cxx/src/common-cxx/EntityMetaData.hpp