Detailed Description
Meta data relating to a value populated by an engine implementation.
Inheritance diagram for FiftyoneDegrees::Common::ValueMetaData:
Collaboration diagram for FiftyoneDegrees::Common::ValueMetaData:
Public Member Functions | |
Constructors | |
| ValueMetaData () | |
| Default constructor, should not be used externally as it produces an invalid instance. | |
| ValueMetaData (ValueMetaData *value) | |
| Construct a new instance of ValueMetaData from an existing instance. | |
| ValueMetaData (ValueMetaDataKey key, string description, string url) | |
| Create a new instance of ValueMetaData. | |
Getters | |
| string | getName () const |
| Get the name of the value. | |
| string | getDescription () const |
| Get the full description of the value. | |
| string | getUrl () const |
| Get the URL containing any extra information about the value. | |
| std::vector< uint8_t > | getUtf8ValueName () const |
| Get the name of the value as a UTF-8 byte vector. | |
Public Member Functions inherited from FiftyoneDegrees::Common::EntityMetaData< ValueMetaDataKey > | |
| EntityMetaData (ValueMetaDataKey key) | |
| Construct a new instance with the key provided. | |
| ValueMetaDataKey | getKey () const |
| Get the unique key for this entity instance. | |
| const bool | operator== (const EntityMetaData< ValueMetaDataKey > other) const |
| Returns true is the two entities share the same unique key. | |
| const bool | operator!= (const EntityMetaData< ValueMetaDataKey > other) const |
| Returns true is the two entities do not share the same unique key. | |
Constructor & Destructor Documentation
◆ ValueMetaData() [1/2]
| FiftyoneDegrees::Common::ValueMetaData::ValueMetaData | ( | ValueMetaData * | value | ) |
Construct a new instance of ValueMetaData from an existing instance.
This copies the existing instance and does not hold a reference to it.
- Parameters
-
value to copy
◆ ValueMetaData() [2/2]
| FiftyoneDegrees::Common::ValueMetaData::ValueMetaData | ( | ValueMetaDataKey | key, |
| string | description, | ||
| string | url ) |
Create a new instance of ValueMetaData.
This should only be used internally by the Collection class.
- Parameters
-
key containing the value and property names description full description of the value url relating to the value
Member Function Documentation
◆ getDescription()
| string FiftyoneDegrees::Common::ValueMetaData::getDescription | ( | ) | const |
Get the full description of the value.
- Returns
- description string, empty if the value has none
◆ getName()
| string FiftyoneDegrees::Common::ValueMetaData::getName | ( | ) | const |
Get the name of the value.
This is a string representation of the value itself.
- Returns
- value name
◆ getUrl()
| string FiftyoneDegrees::Common::ValueMetaData::getUrl | ( | ) | const |
Get the URL containing any extra information about the value.
- Returns
- URL string, empty if the value has none
◆ getUtf8ValueName()
| std::vector< uint8_t > FiftyoneDegrees::Common::ValueMetaData::getUtf8ValueName | ( | ) | const |
Get the name of the value as a UTF-8 byte vector.
- Returns
- value name as UTF-8 bytes
The documentation for this class was generated from the following file: