Detailed Description

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

Examples: Hash/MetaData.cpp.

Inheritance diagram for FiftyoneDegrees::Common::PropertyMetaData:

Collaboration diagram for FiftyoneDegrees::Common::PropertyMetaData:

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.
	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.
Getters
string	getName () const
	Get the name of the property.
vector< string >	getDataFilesWherePresent () const
	Get the list of data file tiers where the property is available e.g.
string	getType () const
	Get the type of data which the property refers to e.g.
string	getCategory () const
	Get the category which the property belongs to e.g.
string	getUrl () const
	Get the URL related to the property.
bool	getAvailable () const
	Get whether or not the property is available in the active data set.
int	getDisplayOrder () const
	Get the order in which the property should be displayed.
bool	getIsMandatory () const
	Get whether or not the property is mandatory.
bool	getIsList () const
	Get whether or not the value of the property is a list.
bool	getIsObsolete () const
	Get whether or not the property is obsolete.
bool	getShow () const
	Get whether or not the property should be displayed.
bool	getShowValues () const
	Get whether or not the values of the property should be displayed.
string	getDescription () const
	Get the full description of the property.
string	getDefaultValue () const
	Gets the default value as a string for the property.
byte	getComponentId () const
	Get the component id of the property.
vector< uint32_t >	getEvidenceProperties () const
	Get the evidence property indexes for the property.
Public Member Functions inherited from FiftyoneDegrees::Common::EntityMetaData< string >
	EntityMetaData (string key)
	Construct a new instance with the key provided.
string	getKey () const
	Get the unique key for this entity instance.
const bool	operator== (const EntityMetaData< string > other) const
	Returns true is the two entities share the same unique key.
const bool	operator!= (const EntityMetaData< string > other) const
	Returns true is the two entities do not share the same unique key.

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

(

)

const

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

(

)

const

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

device.

Returns: string indicating the category

◆ getComponentId()

byte FiftyoneDegrees::Common::PropertyMetaData::getComponentId

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

Get the full description of the property.

Returns: description string

◆ getDisplayOrder()

int FiftyoneDegrees::Common::PropertyMetaData::getDisplayOrder

(

)

const

Get the order in which the property should be displayed.

Returns: display order

◆ getEvidenceProperties()

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

(

)

const

Get the evidence property indexes for the property.

Returns: indexes for evidence properties

◆ getIsList()

bool FiftyoneDegrees::Common::PropertyMetaData::getIsList

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

Get the name of the property.

Returns: string representing the property

◆ getShow()

bool FiftyoneDegrees::Common::PropertyMetaData::getShow

(

)

const

Get whether or not the property should be displayed.

Returns: true if the property should be displayed

◆ getShowValues()

bool FiftyoneDegrees::Common::PropertyMetaData::getShowValues

(

)

const

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

(

)

const

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

(

)

const

Get the URL related to the property.

Returns: URL string, empty if the property has none

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

PropertyMetaData.hpp

FiftyoneDegrees::Common::PropertyMetaData Class Reference

Detailed Description

Inheritance diagram for FiftyoneDegrees::Common::PropertyMetaData:

Collaboration diagram for FiftyoneDegrees::Common::PropertyMetaData:

Public Member Functions

Constructors

Getters

Public Member Functions inherited from FiftyoneDegrees::Common::EntityMetaData< string >

Constructor & Destructor Documentation

◆ PropertyMetaData() [1/2]

◆ PropertyMetaData() [2/2]

Member Function Documentation

◆ getAvailable()

◆ getCategory()

◆ getComponentId()

◆ getDataFilesWherePresent()

◆ getDefaultValue()

◆ getDescription()

◆ getDisplayOrder()

◆ getEvidenceProperties()

◆ getIsList()

◆ getIsMandatory()

◆ getIsObsolete()

◆ getName()

◆ getShow()

◆ getShowValues()

◆ getType()

◆ getUrl()