Detailed Description

Construct a new instance of MetaData.

This should only be used internally by engines.

Parameters: manager - shared pointer to the manager instance to get data from

Inheritance diagram for FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash:

Collaboration diagram for FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash:

Public Member Functions

Constructors and Destructors
	MetaDataHash (shared_ptr< fiftyoneDegreesResourceManager > manager) Construct a new instance of MetaData. More...
	~MetaDataHash () Free any data and handles used for the meta data. More...
Common::MetaData Implementation
Collection< byte, ComponentMetaData > *	getComponents () const Get a new Collection instance of all component meta data keyed on the unique id of the component. More...
Collection< string, PropertyMetaData > *	getProperties () const Get a new Collection instance of all property meta data keyed on the name of the property. More...
Collection< uint32_t, ProfileMetaData > *	getProfiles () const Get a new Collection instance of all profile meta data keyed on the unique id of the profile. More...
Collection< ValueMetaDataKey, ValueMetaData > *	getValues () const Get a new Collection instance of all value meta data keyed on the name of the value and the property it relates to. More...
Collection< ValueMetaDataKey, ValueMetaData > *	getValuesForProperty (PropertyMetaData *property) const Get a new Collection instance of value meta data relating to the specified property, keyed on the name of the value and the property. More...
Collection< ValueMetaDataKey, ValueMetaData > *	getValuesForProfile (ProfileMetaData *profile) const Get a new Collection instance of value meta data for the specified profile, keyed on the name of the value and the property it relates to. More...
ComponentMetaData *	getComponentForProfile (ProfileMetaData *profile) const Get the Component which the specified profile relates to. More...
ComponentMetaData *	getComponentForProperty (PropertyMetaData *property) const Get the Component which the specified property relates to. More...
ProfileMetaData *	getDefaultProfileForComponent (ComponentMetaData *component) const Get the default profile for the specified component. More...
ValueMetaData *	getDefaultValueForProperty (PropertyMetaData *property) const Get the default value for the specified component. More...
Collection< string, PropertyMetaData > *	getPropertiesForComponent (ComponentMetaData *component) const Get a new Collection instance of the property meta data relating to the specified component, keyed on the name of the property. More...
Collection< string, PropertyMetaData > *	getEvidencePropertiesForProperty (PropertyMetaData *property) const Get the properties which are required to fetch extra evidence for a specified property. More...
PropertyMetaData *	getPropertyForValue (ValueMetaData *value) const Get the property which the value relates to. More...
Public Member Functions inherited from FiftyoneDegrees::Common::MetaData
	MetaData (shared_ptr< fiftyoneDegreesResourceManager > manager) Construct a new instance of MetaData. More...
virtual	~MetaData () Free any data and handles used for the meta data.

Constructor & Destructor Documentation

◆ MetaDataHash()

FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::MetaDataHash

(

shared_ptr< fiftyoneDegreesResourceManager >

manager

)

Construct a new instance of MetaData.

This should only be used internally by engines.

Parameters: manager - shared pointer to the manager instance to get data from

◆ ~MetaDataHash()

FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::~MetaDataHash

(

)

Free any data and handles used for the meta data.

Member Function Documentation

◆ getComponentForProfile()

ComponentMetaData* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getComponentForProfile

(

ProfileMetaData *

profile

)

const

virtual

Get the Component which the specified profile relates to.

Parameters: profile - to get the component for

Returns: component the profile relates to

Implements FiftyoneDegrees::Common::MetaData.

◆ getComponentForProperty()

ComponentMetaData* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getComponentForProperty

(

PropertyMetaData *

property

)

const

virtual

Get the Component which the specified property relates to.

Parameters: property - to get the component for

Returns: component the property relates to

Implements FiftyoneDegrees::Common::MetaData.

◆ getComponents()

Collection<byte, ComponentMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getComponents

(

)

const

virtual

Get a new Collection instance of all component meta data keyed on the unique id of the component.

Returns: all components

Implements FiftyoneDegrees::Common::MetaData.

◆ getDefaultProfileForComponent()

ProfileMetaData* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getDefaultProfileForComponent

(

ComponentMetaData *

component

)

const

virtual

Get the default profile for the specified component.

This is the profile that will be used if there is no match.

Parameters: component - to get the default profile for

Returns: default profile for the component

Implements FiftyoneDegrees::Common::MetaData.

◆ getDefaultValueForProperty()

ValueMetaData* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getDefaultValueForProperty

(

PropertyMetaData *

property

)

const

virtual

Get the default value for the specified component.

This is the value that will be used if a profile does not contain a value for the property.

Parameters: property - to get the default value for

Returns: default value for the property

Implements FiftyoneDegrees::Common::MetaData.

◆ getEvidencePropertiesForProperty()

Collection<string, PropertyMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getEvidencePropertiesForProperty

(

PropertyMetaData *

property

)

const

virtual

Get the properties which are required to fetch extra evidence for a specified property.

If a property is not available (i.e. not set as a required property on engine construction) this will always be empty.

Parameters: property - to get the evidence properties for

Returns: evidence properties for the property

Implements FiftyoneDegrees::Common::MetaData.

◆ getProfiles()

Collection<uint32_t, ProfileMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getProfiles

(

)

const

virtual

Get a new Collection instance of all profile meta data keyed on the unique id of the profile.

Returns: all profiles

Implements FiftyoneDegrees::Common::MetaData.

◆ getProperties()

Collection<string, PropertyMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getProperties

(

)

const

virtual

Get a new Collection instance of all property meta data keyed on the name of the property.

Returns: all properties

Implements FiftyoneDegrees::Common::MetaData.

◆ getPropertiesForComponent()

Collection<string, PropertyMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getPropertiesForComponent

(

ComponentMetaData *

component

)

const

virtual

Get a new Collection instance of the property meta data relating to the specified component, keyed on the name of the property.

These are the properties which a profile relating to the component will contain.

Parameters: component - to get the properties for

Returns: properties for the component

Implements FiftyoneDegrees::Common::MetaData.

◆ getPropertyForValue()

PropertyMetaData* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getPropertyForValue

(

ValueMetaData *

value

)

const

virtual

Get the property which the value relates to.

Parameters: value - to get the property for

Returns: property the value relates to

Implements FiftyoneDegrees::Common::MetaData.

◆ getValues()

Collection<ValueMetaDataKey, ValueMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getValues

(

)

const

virtual

Get a new Collection instance of all value meta data keyed on the name of the value and the property it relates to.

Returns: all values

Implements FiftyoneDegrees::Common::MetaData.

◆ getValuesForProfile()

Collection<ValueMetaDataKey, ValueMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getValuesForProfile

(

ProfileMetaData *

profile

)

const

virtual

Get a new Collection instance of value meta data for the specified profile, keyed on the name of the value and the property it relates to.

Parameters: profile - to get the values for

Returns: values for the profile

Implements FiftyoneDegrees::Common::MetaData.

◆ getValuesForProperty()

Collection<ValueMetaDataKey, ValueMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getValuesForProperty

(

PropertyMetaData *

property

)

const

virtual

Get a new Collection instance of value meta data relating to the specified property, keyed on the name of the value and the property.

Parameters: property - to get the values for

Returns: values for the property

Implements FiftyoneDegrees::Common::MetaData.

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/hash/MetaDataHash.hpp

51Degrees Device Detection C/C++ 4.4

FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash Class Reference

Detailed Description

Inheritance diagram for FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash:

Collaboration diagram for FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash:

Public Member Functions

Constructors and Destructors

Common::MetaData Implementation

Public Member Functions inherited from FiftyoneDegrees::Common::MetaData

Constructor & Destructor Documentation

◆ MetaDataHash()

◆ ~MetaDataHash()

Member Function Documentation

◆ getComponentForProfile()

◆ getComponentForProperty()

◆ getComponents()

◆ getDefaultProfileForComponent()

◆ getDefaultValueForProperty()

◆ getEvidencePropertiesForProperty()

◆ getProfiles()

◆ getProperties()

◆ getPropertiesForComponent()

◆ getPropertyForValue()

◆ getValues()

◆ getValuesForProfile()

◆ getValuesForProperty()