◆ MetaData()
FiftyoneDegrees::Common::MetaData::MetaData | ( | 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
Member Function Documentation
◆ getComponentForProfile()
virtual ComponentMetaData* FiftyoneDegrees::Common::MetaData::getComponentForProfile ( ProfileMetaData * profile ) pure virtualGet the Component which the specified profile relates to.
- Parameters
-
- profile - to get the component for
- Returns
- component the profile relates to
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getComponentForProperty()
virtual ComponentMetaData* FiftyoneDegrees::Common::MetaData::getComponentForProperty ( PropertyMetaData * property ) pure virtualGet the Component which the specified property relates to.
- Parameters
-
- property - to get the component for
- Returns
- component the property relates to
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getComponents()
virtual Collection<byte, ComponentMetaData>* FiftyoneDegrees::Common::MetaData::getComponents ( ) pure virtualGet a new Collection instance of all component meta data keyed on the unique id of the component.
- Returns
- all components
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getDefaultProfileForComponent()
virtual ProfileMetaData* FiftyoneDegrees::Common::MetaData::getDefaultProfileForComponent ( ComponentMetaData * component ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getDefaultValueForProperty()
virtual ValueMetaData* FiftyoneDegrees::Common::MetaData::getDefaultValueForProperty ( PropertyMetaData * property ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getEvidencePropertiesForProperty()
virtual Collection<string, PropertyMetaData>* FiftyoneDegrees::Common::MetaData::getEvidencePropertiesForProperty ( PropertyMetaData * property ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getProfiles()
virtual Collection<uint32_t, ProfileMetaData>* FiftyoneDegrees::Common::MetaData::getProfiles ( ) pure virtualGet a new Collection instance of all profile meta data keyed on the unique id of the profile.
- Returns
- all profiles
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getProperties()
virtual Collection<string, PropertyMetaData>* FiftyoneDegrees::Common::MetaData::getProperties ( ) pure virtualGet a new Collection instance of all property meta data keyed on the name of the property.
- Returns
- all properties
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
- Examples
- Hash/MetaData.cpp.
◆ getPropertiesForComponent()
virtual Collection<string, PropertyMetaData>* FiftyoneDegrees::Common::MetaData::getPropertiesForComponent ( ComponentMetaData * component ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getPropertyForValue()
virtual PropertyMetaData* FiftyoneDegrees::Common::MetaData::getPropertyForValue ( ValueMetaData * value ) pure virtualGet the property which the value relates to.
- Parameters
-
- value - to get the property for
- Returns
- property the value relates to
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getString()
string FiftyoneDegrees::Common::MetaData::getString ( fiftyoneDegreesCollection * strings, uint32_t offset ) protectedGet a string from the collection and copy it to a C++ string instance.
This method releases the collection item before returning.
- Parameters
-
- strings - pointer to the collection containing the string
- offset - of the string in the collection
- Returns
- copy of the requested string from the collection
◆ getValues()
virtual Collection<ValueMetaDataKey, ValueMetaData>* FiftyoneDegrees::Common::MetaData::getValues ( ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getValuesForProfile()
virtual Collection<ValueMetaDataKey, ValueMetaData>* FiftyoneDegrees::Common::MetaData::getValuesForProfile ( ProfileMetaData * profile ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
◆ getValuesForProperty()
virtual Collection<ValueMetaDataKey, ValueMetaData>* FiftyoneDegrees::Common::MetaData::getValuesForProperty ( PropertyMetaData * property ) pure virtualGet 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
Implemented in FiftyoneDegrees::DeviceDetection::Hash::MetaDataHash.
Field Documentation
◆ manager
shared_ptr<fiftyoneDegreesResourceManager> FiftyoneDegrees::Common::MetaData::manager protectedA shared pointer to the manager is passed around and referenced by all instances that hold open a resource handle.
This acts as a counter to ensure that the pointer to the manager remains valid until the last handle is freed. The shared pointer also handles freeing the pointer once no references remain. See resource.h for more information.
The documentation for this class was generated from the following file:- /home/vsts/work/1/s/apis/device-detection-cxx/src/common-cxx/MetaData.hpp