51Degrees Device Detection C/C++  4.1

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

FiftyoneDegrees::Common::PropertyMetaData Class Reference

Detailed Description

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

Examples
Hash/MetaData.cpp.

Inheritance diagram for FiftyoneDegrees::Common::PropertyMetaData:

[legend]

Collaboration diagram for FiftyoneDegrees::Common::PropertyMetaData:

[legend]

Public Member Functions

Constructors

 PropertyMetaData ()
Default constructor, should not be used externally as it produces an invalid instance.
 PropertyMetaData (PropertyMetaData *property)
Construct a new instance of PropertyMetaData from an existing instance. More...
 PropertyMetaData (string name, vector< string > dataFilesWherePresent, string type, string category, string url, bool available, byte displayOrder, bool isMandatory, bool isList, bool isObsolete, bool show, bool showValues, string description, string defaultValue, byte componentId, vector< uint32_t > evidenceProperties)
Construct a new instance of PropertyMetaData. More...

Getters

string  getName ()
Get the name of the property. More...
vector< string >  getDataFilesWherePresent ()
Get the list of data file tiers where the property is available e.g. More...
string  getType ()
Get the type of data which the property refers to e.g. More...
string  getCategory ()
Get the category which the property belongs to e.g. More...
string  getUrl ()
Get the URL related to the property. More...
bool  getAvailable ()
Get whether or not the property is available in the active data set. More...
int  getDisplayOrder ()
Get the order in which the property should be displayed. More...
bool  getIsMandatory ()
Get whether or not the property is mandatory. More...
bool  getIsList ()
Get whether or not the value of the property is a list. More...
bool  getIsObsolete ()
Get whether or not the property is obsolete. More...
bool  getShow ()
Get whether or not the property should be displayed. More...
bool  getShowValues ()
Get whether or not the values of the property should be displayed. More...
string  getDescription ()
Get the full description of the property. More...
string  getDefaultValue ()
Gets the default value as a string for the property. More...
byte  getComponentId ()
Get the component id of the property. More...
vector< uint32_t >  getEvidenceProperties ()
Get the evidence property indexes for the property. More...

Constructor & Destructor Documentation

◆ PropertyMetaData() [1/2]

FiftyoneDegrees::Common::PropertyMetaData::PropertyMetaData ( PropertyMetaData *   property )

Construct a new instance of PropertyMetaData from an existing instance.

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

Parameters
property - to copy

◆ PropertyMetaData() [2/2]

FiftyoneDegrees::Common::PropertyMetaData::PropertyMetaData ( string   name,
vector< string >   dataFilesWherePresent,
string   type,
string   category,
string   url,
bool   available,
byte   displayOrder,
bool   isMandatory,
bool   isList,
bool   isObsolete,
bool   show,
bool   showValues,
string   description,
string   defaultValue,
byte   componentId,
vector< uint32_t >   evidenceProperties  
)

Construct a new instance of PropertyMetaData.

This should only be used internally by the Collection class.

Parameters
name - of the property
dataFilesWherePresent - names of data files where the property is available
type - string indicating the variable type e.g. int
category - name of the category which the property belongs to
url - relating to the property
available - bool indicating whether the property is available in the dataset
displayOrder - the order of importance to use when displaying the property
isMandatory - true if the property is mandatory
isList - true if the value of the property is a list
isObsolete - true if the property is obsolete
show - true if the property should be displayed
showValues - true if the values for the property should be displayed
description - the full description of the property
defaultValue - string representation of the default value in the dataset for this property. Used when loading the default value from the value meta data collection.
componentId - the unique id of the component which the property belongs to
evidenceProperties - list of indexes in the properties collection for this property's evidence properties

Member Function Documentation

◆ getAvailable()

bool FiftyoneDegrees::Common::PropertyMetaData::getAvailable ( )

Get whether or not the property is available in the active data set.

Returns
true if the property is available, otherwise false.

◆ getCategory()

string FiftyoneDegrees::Common::PropertyMetaData::getCategory ( )

Get the category which the property belongs to e.g.

device.

Returns
string indicating the category

◆ getComponentId()

byte FiftyoneDegrees::Common::PropertyMetaData::getComponentId ( )

Get the component id of the property.

This can be used to get the component meta data from the component meta data collection.

Returns
component id

◆ getDataFilesWherePresent()

vector<string> FiftyoneDegrees::Common::PropertyMetaData::getDataFilesWherePresent ( )

Get the list of data file tiers where the property is available e.g.

Premium or Enterprise.

Returns
vector containing data file names

◆ getDefaultValue()

string FiftyoneDegrees::Common::PropertyMetaData::getDefaultValue ( )

Gets the default value as a string for the property.

This can be used along with the property itself to get the value meta data from the value meta data collection.

Returns
default value string

◆ getDescription()

string FiftyoneDegrees::Common::PropertyMetaData::getDescription ( )

Get the full description of the property.

Returns
description string

◆ getDisplayOrder()

int FiftyoneDegrees::Common::PropertyMetaData::getDisplayOrder ( )

Get the order in which the property should be displayed.

Returns
display order

◆ getEvidenceProperties()

vector<uint32_t> FiftyoneDegrees::Common::PropertyMetaData::getEvidenceProperties ( )

Get the evidence property indexes for the property.

Returns
indexes for evidence properties

◆ getIsList()

bool FiftyoneDegrees::Common::PropertyMetaData::getIsList ( )

Get whether or not the value of the property is a list.

If so, the a result can contain multiple values for this property.

Returns
true if the value of the property is a list

◆ getIsMandatory()

bool FiftyoneDegrees::Common::PropertyMetaData::getIsMandatory ( )

Get whether or not the property is mandatory.

This means that it must be populated in the data set.

Returns
true if the property is mandatory

◆ getIsObsolete()

bool FiftyoneDegrees::Common::PropertyMetaData::getIsObsolete ( )

Get whether or not the property is obsolete.

If so, the values may not be exported in the data set.

Returns
true if the property is obsolete

◆ getName()

string FiftyoneDegrees::Common::PropertyMetaData::getName ( )

Get the name of the property.

Returns
string representing the property
Examples
Hash/MetaData.cpp.

◆ getShow()

bool FiftyoneDegrees::Common::PropertyMetaData::getShow ( )

Get whether or not the property should be displayed.

Returns
true if the property should be displayed

◆ getShowValues()

bool FiftyoneDegrees::Common::PropertyMetaData::getShowValues ( )

Get whether or not the values of the property should be displayed.

Returns
true if the values of the property should be displayed

◆ getType()

string FiftyoneDegrees::Common::PropertyMetaData::getType ( )

Get the type of data which the property refers to e.g.

int

Returns
string indicating the variable type

◆ getUrl()

string FiftyoneDegrees::Common::PropertyMetaData::getUrl ( )

Get the URL related to the property.

Returns
URL string

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