alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes Struct Reference

#include <RangeControllerAttributes.h>

Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes:

Public Member Functions
	RangeControllerAttributes ()
	RangeControllerAttributes (const avsCommon::avs::CapabilityResources &capabilityResources, const utils::Optional< avsCommon::avs::resources::AlexaUnitOfMeasure > &unitOfMeasure, const std::vector< std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources >> &presets)
	RangeControllerAttributes (const avsCommon::avs::CapabilityResources &capabilityResources, const utils::Optional< avsCommon::avs::resources::AlexaUnitOfMeasure > &unitOfMeasure, const std::vector< std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources >> &presets, avsCommon::utils::Optional< avsCommon::avs::capabilitySemantics::CapabilitySemantics > semantics)

Public Attributes
const avsCommon::avs::CapabilityResources	capabilityResources
	A capability resource CapabilityResources. More...
const utils::Optional< avsCommon::avs::resources::AlexaUnitOfMeasure >	unitOfMeasure
	The unit of measure used for the range value. More...
std::vector< std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources > >	presets
avsCommon::utils::Optional< avsCommon::avs::capabilitySemantics::CapabilitySemantics >	semantics
	A semantics definition as an Optional CapabilitySemantics. More...

Detailed Description

Struct to hold the Range Controller attributes required for Capability Agent discovery.

See also

https://developer.amazon.com/docs/alexa/alexa-voice-service/alexa-rangecontroller.html#capability-assertion

Constructor & Destructor Documentation

RangeControllerAttributes() [1/3]

alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::RangeControllerAttributes ( )

inline

Default constructor.

Note

Avoid using this method. This was added only to enable the to use Optional::value().

RangeControllerAttributes() [2/3]

alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::RangeControllerAttributes ( const avsCommon::avs::CapabilityResources &  capabilityResources, const utils::Optional< avsCommon::avs::resources::AlexaUnitOfMeasure > &  unitOfMeasure, const std::vector< std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources >> &  presets  )

inline

Constructor to build the RangeControllerAttributes using provided values.

Parameters

capabilityResources	The capability resources.
unitOfMeasure	The unit of measure of range defined using AlexaUnitOfMeasure
presets	presets of the range controller.

RangeControllerAttributes() [3/3]

alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::RangeControllerAttributes ( const avsCommon::avs::CapabilityResources &  capabilityResources, const utils::Optional< avsCommon::avs::resources::AlexaUnitOfMeasure > &  unitOfMeasure, const std::vector< std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources >> &  presets, avsCommon::utils::Optional< avsCommon::avs::capabilitySemantics::CapabilitySemantics >  semantics  )

inline

Constructor to build the RangeControllerAttributes using provided values.

Parameters

capabilityResources	The capability resources.
unitOfMeasure	The unit of measure of range defined using AlexaUnitOfMeasure
presets	presets of the range controller.
semantics	The optional semantics definition.

Member Data Documentation

capabilityResources

const avsCommon::avs::CapabilityResources alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::capabilityResources

A capability resource CapabilityResources.

presets

std::vector<std::pair<double, avsCommon::sdkInterfaces::rangeController::PresetResources> > alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::presets

A vector of a pair defining the value of a preset using double and its preset resources using PresetResources.

semantics

avsCommon::utils::Optional<avsCommon::avs::capabilitySemantics::CapabilitySemantics> alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::semantics

A semantics definition as an Optional CapabilitySemantics.

unitOfMeasure

const utils::Optional<avsCommon::avs::resources::AlexaUnitOfMeasure> alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes::unitOfMeasure

The unit of measure used for the range value.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/RangeController/RangeControllerAttributes.h