DeviceInfo.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_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_DEVICEINFO_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_DEVICEINFO_H_

#include <string>

#include <AVSCommon/SDKInterfaces/Endpoints/EndpointIdentifier.h>
#include <AVSCommon/Utils/Configuration/ConfigurationNode.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {

class DeviceInfo {
public:
    static std::shared_ptr<DeviceInfo> createFromConfiguration(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationRoot);

    static std::unique_ptr<DeviceInfo> create(
        const avsCommon::utils::configuration::ConfigurationNode& configurationRoot);

    static std::unique_ptr<DeviceInfo> create(
        const std::string& clientId,
        const std::string& productId,
        const std::string& deviceSerialNumber,
        const std::string& manufacturerName,
        const std::string& description,
        const std::string& friendlyName = "",
        const std::string& deviceType = "",
        const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier& endpointId = "",
        const std::string& registrationKey = "",
        const std::string& productIdKey = "");

    std::string getClientId() const;

    std::string getProductId() const;

    std::string getDeviceSerialNumber() const;

    std::string getManufacturerName() const;

    std::string getDeviceDescription() const;

    std::string getFriendlyName() const;

    std::string getDeviceType() const;

    sdkInterfaces::endpoints::EndpointIdentifier getDefaultEndpointId() const;

    std::string getRegistrationKey() const;

    std::string getProductIdKey() const;

    bool operator==(const DeviceInfo& rhs);

    bool operator!=(const DeviceInfo& rhs);

private:
    DeviceInfo(
        const std::string& clientId,
        const std::string& productId,
        const std::string& deviceSerialNumber,
        const std::string& manufacturerName,
        const std::string& description,
        const std::string& friendlyName,
        const std::string& deviceType,
        const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier& endpointId,
        const std::string& registrationKey,
        const std::string& productIdKey);

    std::string m_clientId;

    std::string m_productId;

    std::string m_deviceSerialNumber;

    std::string m_manufacturer;

    std::string m_deviceDescription;

    std::string m_friendlyName;

    std::string m_deviceType;

    sdkInterfaces::endpoints::EndpointIdentifier m_defaultEndpointId;

    std::string m_registrationKey;

    std::string m_productIdKey;
};

inline std::string DeviceInfo::getManufacturerName() const {
    return m_manufacturer;
}

inline std::string DeviceInfo::getDeviceDescription() const {
    return m_deviceDescription;
}

inline sdkInterfaces::endpoints::EndpointIdentifier DeviceInfo::getDefaultEndpointId() const {
    return m_defaultEndpointId;
}

}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_DEVICEINFO_H_