\r\n

51Degrees Device Detection C/C++  4.4

A device detection library that is used natively or by 51Degrees products

Search

Documentation

• FiftyoneDegrees
• Common
• ComponentMetaData

FiftyoneDegrees::Common::ComponentMetaData Class Reference

Detailed Description

EntityMetaData relating to a component populated by an engine implementation.

Inheritance diagram for FiftyoneDegrees::Common::ComponentMetaData:

Collaboration diagram for FiftyoneDegrees::Common::ComponentMetaData:

Public Member Functions

Constructors
	ComponentMetaData () Default constructor, should not be used externally as it produces an invalid instance.
	ComponentMetaData (ComponentMetaData *component) Construct a new instance of ComponentMetaData from an existing instance. More...
	ComponentMetaData (byte componentId, string name, uint32_t defaultProfileId) Construct a new instance of ComponentMetaData. More...
Getters
int	getComponentIdAsInt () const Get the unique if of the component as an integer. More...
byte	getComponentId () const Get the unique id of the component. More...
string	getName () const Get the name of the component. More...
uint32_t	getDefaultProfileId () const Get the unique id for the default profile for this component. More...
Public Member Functions inherited from FiftyoneDegrees::Common::EntityMetaData< byte >
	EntityMetaData (byte key) Construct a new instance with the key provided. More...
byte	getKey () const Get the unique key for this entity instance. More...
const bool	operator== (const EntityMetaData< byte > other) const Returns true is the two entities share the same unique key. More...
const bool	operator!= (const EntityMetaData< byte > other) const Returns true is the two entities do not share the same unique key. More...

Constructor & Destructor Documentation

◆ ComponentMetaData() [1/2]

FiftyoneDegrees::Common::ComponentMetaData::ComponentMetaData

(

ComponentMetaData *

component

)

Construct a new instance of ComponentMetaData from an existing instance.

This copies the existing instance and does not hold a reference to it.

Parameters

component - to copy

◆ ComponentMetaData() [2/2]

FiftyoneDegrees::Common::ComponentMetaData::ComponentMetaData	(	byte	componentId,
		string	name,
		uint32_t	defaultProfileId
	)

Construct a new instance of ComponentMetaData.

This should only be used internally by the collection class.

Parameters

componentId - unique id of the component

name - the name of the component

defaultProfileId - unique id of the default profile for the component

Member Function Documentation

◆ getComponentId()

byte FiftyoneDegrees::Common::ComponentMetaData::getComponentId

(

)

const

Get the unique id of the component.

Returns

unique id

◆ getComponentIdAsInt()

int FiftyoneDegrees::Common::ComponentMetaData::getComponentIdAsInt

(

)

const

Get the unique if of the component as an integer.

Returns

unique id as int

◆ getDefaultProfileId()

uint32_t FiftyoneDegrees::Common::ComponentMetaData::getDefaultProfileId

(

)

const

Get the unique id for the default profile for this component.

Returns

default profile id

◆ getName()

string FiftyoneDegrees::Common::ComponentMetaData::getName

(

)

const

Get the name of the component.

Returns

name of the component

---

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

• /home/runner/work/device-detection-cxx/device-detection-cxx/common/device-detection-cxx/src/common-cxx/ComponentMetaData.hpp

Generated by doxygen 1.8.15