alexaClientSDK::avsCommon::avs::CapabilityTag Struct Reference

#include <CapabilityTag.h>

Inheritance diagram for alexaClientSDK::avsCommon::avs::CapabilityTag:

Collaboration diagram for alexaClientSDK::avsCommon::avs::CapabilityTag:

Public Member Functions
	CapabilityTag (const std::string &nameSpace, const std::string &name, const std::string &endpointId, const utils::Optional< std::string > &instanceId=utils::Optional< std::string >())
	CapabilityTag (const CapabilityTag &other)=default
Comparison operators.
Compare the current capability tag against a second object. Parameters rhs The object to compare against this. Returns true if the comparison holds; false otherwise.
bool	operator< (const CapabilityTag &rhs) const
bool	operator== (const CapabilityTag &rhs) const
bool	operator!= (const CapabilityTag &rhs) const

Public Attributes
const std::string	nameSpace
	The namespace value of this message. More...
const std::string	name
	The name value of this message. More...
const std::string	endpointId
	The endpoint id of this message. More...
const utils::Optional< std::string >	instance
	The capability instance relative to this message if applicable; otherwise, an empty object. More...

Detailed Description

Structure containing values for namespace, name, endpointId and optionally instance which are intended for identifying AVS Messages (Directives, Events, State, and Exceptions).

Constructor & Destructor Documentation

CapabilityTag() [1/2]

alexaClientSDK::avsCommon::avs::CapabilityTag::CapabilityTag	(	const std::string &	nameSpace,
		const std::string &	name,
		const std::string &	endpointId,
		const utils::Optional< std::string > &	instanceId = utils::Optional< std::string >()
	)

Constructor.

Parameters

namespace	The namespace value for this message.
name	The name for this message.
endpointId	The endpoint id used to identify the target / source endpoint.
instanceId	Optional value for specifying an specific capability instance. This field should be left empty if the capability does not support multiple instances.

CapabilityTag() [2/2]

alexaClientSDK::avsCommon::avs::CapabilityTag::CapabilityTag ( const CapabilityTag &  other )

default

Copy constructor.

Parameters

other

Object used to initialize the new object.

Member Function Documentation

operator!=()

bool alexaClientSDK::avsCommon::avs::CapabilityTag::operator!=

(

const CapabilityTag &

rhs

)

const

operator<()

bool alexaClientSDK::avsCommon::avs::CapabilityTag::operator<

(

const CapabilityTag &

rhs

)

const

operator==()

bool alexaClientSDK::avsCommon::avs::CapabilityTag::operator==

(

const CapabilityTag &

rhs

)

const

Member Data Documentation

endpointId

const std::string alexaClientSDK::avsCommon::avs::CapabilityTag::endpointId

The endpoint id of this message.

instance

const utils::Optional<std::string> alexaClientSDK::avsCommon::avs::CapabilityTag::instance

The capability instance relative to this message if applicable; otherwise, an empty object.

name

const std::string alexaClientSDK::avsCommon::avs::CapabilityTag::name

The name value of this message.

nameSpace

const std::string alexaClientSDK::avsCommon::avs::CapabilityTag::nameSpace

The namespace value of this message.

---

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

• /workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/CapabilityTag.h