ModeControllerAttributeBuilder.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_CAPABILITYAGENTS_MODECONTROLLER_INCLUDE_MODECONTROLLER_MODECONTROLLERATTRIBUTEBUILDER_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_MODECONTROLLER_INCLUDE_MODECONTROLLER_MODECONTROLLERATTRIBUTEBUILDER_H_

#include <unordered_map>

#include <AVSCommon/AVS/CapabilitySemantics/CapabilitySemantics.h>
#include <AVSCommon/SDKInterfaces/ModeController/ModeControllerAttributeBuilderInterface.h>
#include <AVSCommon/Utils/Optional.h>

namespace alexaClientSDK {
namespace capabilityAgents {
namespace modeController {

class ModeControllerAttributeBuilder
        : public avsCommon::sdkInterfaces::modeController::ModeControllerAttributeBuilderInterface {
public:
    virtual ~ModeControllerAttributeBuilder() = default;

    static std::unique_ptr<ModeControllerAttributeBuilder> create();

    ModeControllerAttributeBuilder& withCapabilityResources(
        const avsCommon::avs::CapabilityResources& capabilityResources) override;
    ModeControllerAttributeBuilder& addMode(
        const std::string& mode,
        const avsCommon::sdkInterfaces::modeController::ModeResources& modeResources) override;
    ModeControllerAttributeBuilder& setOrdered(bool ordered) override;
    ModeControllerAttributeBuilder& withSemantics(
        const avsCommon::avs::capabilitySemantics::CapabilitySemantics& semantics) override;
    avsCommon::utils::Optional<avsCommon::sdkInterfaces::modeController::ModeControllerAttributes> build() override;

private:
    ModeControllerAttributeBuilder();

    bool m_invalidAttribute;

    avsCommon::avs::CapabilityResources m_capabilityResources;

    std::unordered_map<std::string, avsCommon::sdkInterfaces::modeController::ModeResources> m_modes;

    bool m_ordered;

    avsCommon::utils::Optional<avsCommon::avs::capabilitySemantics::CapabilitySemantics> m_semantics;
};

}  // namespace modeController
}  // namespace capabilityAgents
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_MODECONTROLLER_INCLUDE_MODECONTROLLER_MODECONTROLLERATTRIBUTEBUILDER_H_