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_VALUE_META_DATA_HPP

24 #define FIFTYONE_DEGREES_VALUE_META_DATA_HPP

25

26 #include <string>

27 #include <vector>

28 #include "EntityMetaData.hpp"

29 #include "value.h"

30

31

32 namespace FiftyoneDegrees {

33 namespace Common {

40 class ValueMetaDataKey {

41 public:

51 ValueMetaDataKey();

52

60 ValueMetaDataKey(string propertyName, string valueName);

61

70 ValueMetaDataKey(

71 const string &propertyName,

72 const uint8_t *valueName,

73 long valueNameLength);

74

85 const string getPropertyName() const;

86

91 const string getValueName() const;

92

105 const bool operator< (ValueMetaDataKey other) const;

106

113 const bool operator== (ValueMetaDataKey other) const;

114

118 private:

120 string propertyName;

121

123 string valueName;

124 };

125

129 class ValueMetaData : public EntityMetaData<ValueMetaDataKey> {

130 public:

140 ValueMetaData();

141

148 ValueMetaData(ValueMetaData *value);

149

157 ValueMetaData(

158 ValueMetaDataKey key,

159 string description,

160 string url);

161

173 string getName() const;

174

179 string getDescription() const;

180

185 string getUrl() const;

186

191 std::vector<uint8_t> getUtf8ValueName() const;

192

196 private:

198 string description;

199

201 string url;

202 };

203 }

204 }

205

206 #endif

FiftyoneDegrees::Common::ValueMetaDataKey::getPropertyName

const string getPropertyName() const

Get the name of the property that the value keyed relates to.

FiftyoneDegrees::Common::ValueMetaData::getName

string getName() const

Get the name of the value.

FiftyoneDegrees::Common::ValueMetaData::getDescription

string getDescription() const

Get the full description of the value.

FiftyoneDegrees::Common::ValueMetaData::ValueMetaData

ValueMetaData()

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

FiftyoneDegrees

A C++ wrapper class for transform.h conversion routines.

Definition: ComponentMetaDataBuilderHash.hpp:33

FiftyoneDegrees::Common::ValueMetaDataKey::ValueMetaDataKey

ValueMetaDataKey()

Default constructor.

FiftyoneDegrees::Common::ValueMetaDataKey::getValueName

const string getValueName() const

Get the name of the value which is being keyed.

FiftyoneDegrees::Common::ValueMetaData::getUrl

string getUrl() const

Get the URL containing any extra information about the value.

FiftyoneDegrees::Common::ValueMetaData

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

Definition: ValueMetaData.hpp:129

FiftyoneDegrees::Common::ValueMetaDataKey::operator<

const bool operator<(ValueMetaDataKey other) const

Override the less than operator so the unique key can be used to order lists.

FiftyoneDegrees::Common::ValueMetaDataKey

Key used to store ValueMetaData in a Collection.

Definition: ValueMetaData.hpp:40

FiftyoneDegrees::Common::EntityMetaData

Base class for any entity meta data.

Definition: EntityMetaData.hpp:46

FiftyoneDegrees::Common::ValueMetaData::getUtf8ValueName

std::vector< uint8_t > getUtf8ValueName() const

Get the name of the value as a UTF-8 byte vector.

FiftyoneDegrees::Common::ValueMetaDataKey::operator==

const bool operator==(ValueMetaDataKey other) const

Override the equality operator so the unique key can be found in a generic collection.

51Degrees Device Detection C/C++ 4.5

ValueMetaData.hpp