alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder Class Reference

#include <RangeControllerAttributeBuilder.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder:

Collaboration diagram for alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder:

Public Member Functions
virtual	~RangeControllerAttributeBuilder ()=default
RangeControllerAttributeBuilderInterface Functions
RangeControllerAttributeBuilder &	withCapabilityResources (const avsCommon::avs::CapabilityResources &capabilityResources) override
RangeControllerAttributeBuilder &	withUnitOfMeasure (const avsCommon::avs::resources::AlexaUnitOfMeasure &unitOfMeasure) override
RangeControllerAttributeBuilder &	addPreset (const std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources > &preset) override
RangeControllerAttributeBuilder &	withSemantics (const avsCommon::avs::capabilitySemantics::CapabilitySemantics &semantics) override
avsCommon::utils::Optional< avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes >	build () override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface
virtual	~RangeControllerAttributeBuilderInterface ()=default
virtual RangeControllerAttributeBuilderInterface &	addPreset (const std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources > &preset)=0

Static Public Member Functions
static std::unique_ptr< RangeControllerAttributeBuilder >	create ()

Detailed Description

This class implements RangeControllerAttributeBuilderInterface to build RangeControllerAttributes.

Constructor & Destructor Documentation

~RangeControllerAttributeBuilder()

virtual alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::~RangeControllerAttributeBuilder ( )

virtualdefault

Destructor.

Member Function Documentation

addPreset()

RangeControllerAttributeBuilder& alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::addPreset ( const std::pair< double, avsCommon::sdkInterfaces::rangeController::PresetResources > &  preset )

override

build()

avsCommon::utils::Optional<avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes> alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::build ( )

overridevirtual

Builds a RangeControllerAttributes with the configured properties.

Returns

A non optional RangeControllerAttributes if the build succeeds; otherwise, an empty RangeControllerAttributes object.

Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface.

create()

static std::unique_ptr<RangeControllerAttributeBuilder> alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::create ( )

static

Create an instance of RangeControllerAttributeBuilder.

Returns

Returns a new instance of RangeControllerAttributeBuilder.

withCapabilityResources()

RangeControllerAttributeBuilder& alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::withCapabilityResources ( const avsCommon::avs::CapabilityResources &  capabilityResources )

overridevirtual

Configures builder to use capability resources.

Note

This will overwrite capability resources if it was used previously.

Parameters

capabilityResources

The capability resources represented using CapabilityResources.

Returns

This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface.

withSemantics()

RangeControllerAttributeBuilder& alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::withSemantics ( const avsCommon::avs::capabilitySemantics::CapabilitySemantics &  semantics )

overridevirtual

Configures the builder to use the specified semantics definition.

See also

https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/alexa-rangecontroller.html

Parameters

semantics

The CapabilitySemantics representing the semantics definition.

Returns

This builder, which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface.

withUnitOfMeasure()

RangeControllerAttributeBuilder& alexaClientSDK::capabilityAgents::rangeController::RangeControllerAttributeBuilder::withUnitOfMeasure ( const avsCommon::avs::resources::AlexaUnitOfMeasure &  unitOfMeasure )

overridevirtual

Configures builder to use a unit of measure used for instance of range controller.

Note

This will overwrite unitOfMeasure if it was used previously.

Parameters

unitOfMeasure

The unit of measure of range controller.

Returns

This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerAttributeBuilderInterface.

---

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

• /workplace/avs-device-sdk/CapabilityAgents/RangeController/include/RangeController/RangeControllerAttributeBuilder.h