AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
RangeControllerObserverInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_RANGECONTROLLER_RANGECONTROLLEROBSERVERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_RANGECONTROLLER_RANGECONTROLLEROBSERVERINTERFACE_H_
18 
21 
22 namespace alexaClientSDK {
23 namespace avsCommon {
24 namespace sdkInterfaces {
25 namespace rangeController {
26 
32 public:
36  virtual ~RangeControllerObserverInterface() = default;
37 
41  struct RangeState {
43  double value;
44 
47 
49  std::chrono::milliseconds valueUncertainty;
50  };
51 
58  virtual void onRangeChanged(const RangeState& rangeState, AlexaStateChangeCauseType cause) = 0;
59 };
60 
61 } // namespace rangeController
62 } // namespace sdkInterfaces
63 } // namespace avsCommon
64 } // namespace alexaClientSDK
65 
66 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_RANGECONTROLLER_RANGECONTROLLEROBSERVERINTERFACE_H_
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface
Definition: RangeControllerObserverInterface.h:31
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::RangeState
Definition: RangeControllerObserverInterface.h:41
TimePoint.h
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::onRangeChanged
virtual void onRangeChanged(const RangeState &rangeState, AlexaStateChangeCauseType cause)=0
alexaClientSDK::avsCommon::sdkInterfaces::AlexaStateChangeCauseType
AlexaStateChangeCauseType
Definition: AlexaStateChangeCauseType.h:28
alexaClientSDK
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::RangeState::valueUncertainty
std::chrono::milliseconds valueUncertainty
The number of milliseconds that have elapsed since the range value was last confrimed.
Definition: RangeControllerObserverInterface.h:49
AlexaStateChangeCauseType.h
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::RangeState::timeOfSample
avsCommon::utils::timing::TimePoint timeOfSample
The time at which the range value was recorded.
Definition: RangeControllerObserverInterface.h:46
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::~RangeControllerObserverInterface
virtual ~RangeControllerObserverInterface()=default
alexaClientSDK::avsCommon::utils::timing::TimePoint
Definition: TimePoint.h:31
alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::RangeState::value
double value
A double to represent the range value of instance.
Definition: RangeControllerObserverInterface.h:43

AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0