\r\n

51Degrees Device Detection C/C++  4.4

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

Search

Documentation

• FiftyoneDegrees
• Common
• ValueMetaData

FiftyoneDegrees::Common::ValueMetaData Class Reference

Detailed Description

Meta data relating to a value populated by an engine implementation.

Inheritance diagram for FiftyoneDegrees::Common::ValueMetaData:

Collaboration diagram for FiftyoneDegrees::Common::ValueMetaData:

Public Member Functions

Constructors
	ValueMetaData () Default constructor, should not be used externally as it produces an invalid instance.
	ValueMetaData (ValueMetaData *value) Construct a new instance of ValueMetaData from an existing instance. More...
	ValueMetaData (ValueMetaDataKey key, string description, string url) Create a new instance of ValueMetaData. More...
Getters
string	getName () const Get the name of the value. More...
string	getDescription () const Get the full description of the value. More...
string	getUrl () const Get the URL containing any extra information about the value. More...
Public Member Functions inherited from FiftyoneDegrees::Common::EntityMetaData< ValueMetaDataKey >
	EntityMetaData (ValueMetaDataKey key) Construct a new instance with the key provided. More...
ValueMetaDataKey	getKey () const Get the unique key for this entity instance. More...
const bool	operator== (const EntityMetaData< ValueMetaDataKey > other) const Returns true is the two entities share the same unique key. More...
const bool	operator!= (const EntityMetaData< ValueMetaDataKey > other) const Returns true is the two entities do not share the same unique key. More...

Constructor & Destructor Documentation

◆ ValueMetaData() [1/2]

FiftyoneDegrees::Common::ValueMetaData::ValueMetaData

(

ValueMetaData *

value

)

Construct a new instance of ValueMetaData from an existing instance.

This copies the existing instance and does not hold a reference to it.

Parameters

value - to copy

◆ ValueMetaData() [2/2]

FiftyoneDegrees::Common::ValueMetaData::ValueMetaData	(	ValueMetaDataKey	key,
		string	description,
		string	url
	)

Create a new instance of ValueMetaData.

This should only be used internally by the Collection class.

Parameters

key - containing the value and property names

description - full description of the value

url - relating to the value

Member Function Documentation

◆ getDescription()

string FiftyoneDegrees::Common::ValueMetaData::getDescription

(

)

const

Get the full description of the value.

Returns

description string

◆ getName()

string FiftyoneDegrees::Common::ValueMetaData::getName

(

)

const

Get the name of the value.

This is a string representation of the value itself.

Returns

value name

◆ getUrl()

string FiftyoneDegrees::Common::ValueMetaData::getUrl

(

)

const

Get the URL containing any extra information about the value.

Returns

URL string

---

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/ValueMetaData.hpp

Generated by doxygen 1.8.15