51Degrees Device Detection C/C++  4.1

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

FiftyoneDegrees::Common::ValueMetaDataKey Class Reference

Detailed Description

Key used to store ValueMetaData in a Collection.

A value name is not unique, however it is unique within the collection of values for a single property. For this reason, the key consists of the property name and the value name.

Public Member Functions

Constructors

 ValueMetaDataKey ()
Default constructor. More...
 ValueMetaDataKey (string propertyName, string valueName)
Construct a new instance of ValueMetaDataKey from the unique combination of property and value names. More...

Getters

const string  getPropertyName () const
Get the name of the property that the value keyed relates to. More...
const string  getValueName () const
Get the name of the value which is being keyed. More...

Operators

const bool  operator< (ValueMetaDataKey other) const
Override the less than operator so the unique key can be used to order lists. More...
const bool  operator== (ValueMetaDataKey other) const
Override the equality operator so the unique key can be found in a generic collection. More...

Constructor & Destructor Documentation

◆ ValueMetaDataKey() [1/2]

FiftyoneDegrees::Common::ValueMetaDataKey::ValueMetaDataKey ( )

Default constructor.

This should not be used externally as it returns an invalid instance.

◆ ValueMetaDataKey() [2/2]

FiftyoneDegrees::Common::ValueMetaDataKey::ValueMetaDataKey ( string   propertyName,
string   valueName  
)

Construct a new instance of ValueMetaDataKey from the unique combination of property and value names.

Parameters
propertyName - the name of the property the value relates to
valueName - the name of the value

Member Function Documentation

◆ getPropertyName()

const string FiftyoneDegrees::Common::ValueMetaDataKey::getPropertyName ( ) const

Get the name of the property that the value keyed relates to.

Returns
name of the property

◆ getValueName()

const string FiftyoneDegrees::Common::ValueMetaDataKey::getValueName ( ) const

Get the name of the value which is being keyed.

Returns
name of the value

◆ operator<()

const bool FiftyoneDegrees::Common::ValueMetaDataKey::operator< ( ValueMetaDataKey   other ) const

Override the less than operator so the unique key can be used to order lists.

Parameters
other - the other key to compare
Returns
true if this key comes before the other key

◆ operator==()

const bool FiftyoneDegrees::Common::ValueMetaDataKey::operator== ( ValueMetaDataKey   other ) const

Override the equality operator so the unique key can be found in a generic collection.

Parameters
other - the other key to compare
Returns
true if both keys are equal

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