51Degrees Device Detection C/C++  4.1

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

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

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:

[legend]

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

[legend]

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

CollectionbyteComponentMetaData > *  getComponents ()
Get a new Collection instance of all component meta data keyed on the unique id of the component. More...
Collection< string, PropertyMetaData > *  getProperties ()
Get a new Collection instance of all property meta data keyed on the name of the property. More...
Collection< uint32_t, ProfileMetaData > *  getProfiles ()
Get a new Collection instance of all profile meta data keyed on the unique id of the profile. More...
CollectionValueMetaDataKeyValueMetaData > *  getValues ()
Get a new Collection instance of all value meta data keyed on the name of the value and the property it relates to. More...
CollectionValueMetaDataKeyValueMetaData > *  getValuesForProperty (PropertyMetaData *property)
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...
CollectionValueMetaDataKeyValueMetaData > *  getValuesForProfile (ProfileMetaData *profile)
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)
Get the Component which the specified profile relates to. More...
ComponentMetaData *  getComponentForProperty (PropertyMetaData *property)
Get the Component which the specified property relates to. More...
ProfileMetaData *  getDefaultProfileForComponent (ComponentMetaData *component)
Get the default profile for the specified component. More...
ValueMetaData *  getDefaultValueForProperty (PropertyMetaData *property)
Get the default value for the specified component. More...
Collection< string, PropertyMetaData > *  getPropertiesForComponent (ComponentMetaData *component)
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)
Get the properties which are required to fetch extra evidence for a specified property. More...
PropertyMetaData *  getPropertyForValue (ValueMetaData *value)
Get the property which the value relates to. More...

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 )
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 )
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.

◆ getDefaultProfileForComponent()

ProfileMetaData* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getDefaultProfileForComponent ( ComponentMetaData *   component )
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 )
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 )
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.

◆ getPropertiesForComponent()

Collection<string, PropertyMetaData>* FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash::getPropertiesForComponent ( ComponentMetaData *   component )
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.


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