Detailed Description
Meta data relating to a profile populated by an engine implementation.
Inheritance diagram for FiftyoneDegrees::Common::ProfileMetaData:
Collaboration diagram for FiftyoneDegrees::Common::ProfileMetaData:
Public Member Functions | |
Constructors | |
| ProfileMetaData () | |
| Default constructor, should not be used externally as it produces an invalid instance. | |
| ProfileMetaData (ProfileMetaData *profile) | |
| Construct a new instance of ProfileMetaData from an existing instance. | |
| ProfileMetaData (uint32_t profileId, byte componentId) | |
| Create a new instance of ProfileMetaData. | |
Getters | |
| uint32_t | getProfileId () const |
| Get the unique id of the profile. | |
| byte | getComponentId () const |
| Get the unique id of the component the profile relates to. | |
Public Member Functions inherited from FiftyoneDegrees::Common::EntityMetaData< uint32_t > | |
| EntityMetaData (uint32_t key) | |
| Construct a new instance with the key provided. | |
| uint32_t | getKey () const |
| Get the unique key for this entity instance. | |
| const bool | operator== (const EntityMetaData< uint32_t > other) const |
| Returns true is the two entities share the same unique key. | |
| const bool | operator!= (const EntityMetaData< uint32_t > other) const |
| Returns true is the two entities do not share the same unique key. | |
Constructor & Destructor Documentation
◆ ProfileMetaData() [1/2]
| FiftyoneDegrees::Common::ProfileMetaData::ProfileMetaData | ( | ProfileMetaData * | profile | ) |
Construct a new instance of ProfileMetaData from an existing instance.
This copies the existing instance and does not hold a reference to it.
- Parameters
-
profile to copy
◆ ProfileMetaData() [2/2]
| FiftyoneDegrees::Common::ProfileMetaData::ProfileMetaData | ( | uint32_t | profileId, |
| byte | componentId ) |
Create a new instance of ProfileMetaData.
This should only be used internally by the Collection class.
- Parameters
-
profileId the unique id of the profile componentId the unique id of the component the profile relates to
Member Function Documentation
◆ getComponentId()
| byte FiftyoneDegrees::Common::ProfileMetaData::getComponentId | ( | ) | const |
Get the unique id of the component the profile relates to.
- Returns
- unique component id
◆ getProfileId()
| uint32_t FiftyoneDegrees::Common::ProfileMetaData::getProfileId | ( | ) | const |
Get the unique id of the profile.
- Returns
- unique id
The documentation for this class was generated from the following file: