1 /* *********************************************************************

2 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.

4 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.

5 *

6 * This Original Work is licensed under the European Union Public Licence

7 * (EUPL) v.1.2 and is subject to its terms as set out below.

8 *

9 * If a copy of the EUPL was not distributed with this file, You can obtain

10 * one at https://opensource.org/licenses/EUPL-1.2.

11 *

12 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be

13 * amended by the European Commission) shall be deemed incompatible for

14 * the purposes of the Work and the provisions of the compatibility

15 * clause in Article 5 of the EUPL shall not apply.

16 *

17 * If using the Work as, or as part of, a network application, by

18 * including the attribution notice(s) required under Article 5 of the EUPL

19 * in the end user terms of the application under an appropriate heading,

20 * such notice(s) shall fulfill the requirements of that article.

21 * ********************************************************************* */

22

23 #ifndef FIFTYONE_DEGREES_PROPERTY_META_DATA_HPP

24 #define FIFTYONE_DEGREES_PROPERTY_META_DATA_HPP

25

26 #include <string>

27 #include <vector>

28 #include "EntityMetaData.hpp"

29

30

31 namespace FiftyoneDegrees {

32 namespace Common {

37 class PropertyMetaData : public EntityMetaData<string> {

38 public:

48 PropertyMetaData();

49

56 PropertyMetaData(PropertyMetaData *property);

57

87 PropertyMetaData(

88 string name,

89 vector<string> dataFilesWherePresent,

90 string type,

91 string category,

92 string url,

93 bool available,

94 byte displayOrder,

95 bool isMandatory,

96 bool isList,

97 bool isObsolete,

98 bool show,

99 bool showValues,

100 string description,

101 string defaultValue,

102 byte componentId,

103 vector<uint32_t> evidenceProperties);

104

115 string getName() const;

116

122 vector<string> getDataFilesWherePresent() const;

123

128 string getType() const;

129

134 string getCategory() const;

135

140 string getUrl() const;

141

147 bool getAvailable() const;

148

153 int getDisplayOrder() const;

154

160 bool getIsMandatory() const;

161

167 bool getIsList() const;

168

174 bool getIsObsolete() const;

175

180 bool getShow() const;

181

187 bool getShowValues() const;

188

193 string getDescription() const;

194

201 string getDefaultValue() const;

202

208 byte getComponentId() const;

209

214 vector<uint32_t> getEvidenceProperties() const;

215

219 private:

221 vector<string> dataFilesWherePresent;

222

224 string type;

225

227 string category;

228

230 string url;

231

233 bool available;

234

236 byte displayOrder;

237

239 bool isMandatory;

240

242 bool isList;

243

245 bool isObsolete;

246

248 bool show;

249

251 bool showValues;

252

254 string description;

255

257 string defaultValue;

258

260 byte componentId;

261

264 vector<uint32_t> evidenceProperties;

265 };

266 }

267 }

268

269 #endif

FiftyoneDegrees::Common::PropertyMetaData::getDescription

string getDescription() const

Get the full description of the property.

FiftyoneDegrees

51Degrees base namespace.

Definition: ComponentMetaDataBuilderHash.hpp:33

FiftyoneDegrees::Common::PropertyMetaData::getComponentId

byte getComponentId() const

Get the component id of the property.

FiftyoneDegrees::Common::PropertyMetaData::getIsMandatory

bool getIsMandatory() const

Get whether or not the property is mandatory.

FiftyoneDegrees::Common::PropertyMetaData::PropertyMetaData

PropertyMetaData()

Default constructor, should not be used externally as it produces an invalid instance.

FiftyoneDegrees::Common::PropertyMetaData::getDataFilesWherePresent

vector< string > getDataFilesWherePresent() const

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

FiftyoneDegrees::Common::PropertyMetaData

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

Definition: PropertyMetaData.hpp:37

FiftyoneDegrees::Common::PropertyMetaData::getType

string getType() const

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

FiftyoneDegrees::Common::PropertyMetaData::getShow

bool getShow() const

Get whether or not the property should be displayed.

FiftyoneDegrees::Common::PropertyMetaData::getDisplayOrder

int getDisplayOrder() const

Get the order in which the property should be displayed.

FiftyoneDegrees::Common::EntityMetaData

Base class for any entity meta data.

Definition: EntityMetaData.hpp:46

FiftyoneDegrees::Common::PropertyMetaData::getName

string getName() const

Get the name of the property.

FiftyoneDegrees::Common::PropertyMetaData::getShowValues

bool getShowValues() const

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

FiftyoneDegrees::Common::PropertyMetaData::getAvailable

bool getAvailable() const

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

FiftyoneDegrees::Common::PropertyMetaData::getIsObsolete

bool getIsObsolete() const

Get whether or not the property is obsolete.

FiftyoneDegrees::Common::PropertyMetaData::getEvidenceProperties

vector< uint32_t > getEvidenceProperties() const

Get the evidence property indexes for the property.

FiftyoneDegrees::Common::PropertyMetaData::getCategory

string getCategory() const

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

FiftyoneDegrees::Common::PropertyMetaData::getUrl

string getUrl() const

Get the URL related to the property.

FiftyoneDegrees::Common::PropertyMetaData::getIsList

bool getIsList() const

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

FiftyoneDegrees::Common::PropertyMetaData::getDefaultValue

string getDefaultValue() const

Gets the default value as a string for the property.

51Degrees Device Detection C/C++ 4.4

PropertyMetaData.hpp