AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::settings::test::MockSetting< ValueT > Class Template Reference

#include <MockSetting.h>

Inheritance diagram for alexaClientSDK::settings::test::MockSetting< ValueT >:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::settings::test::MockSetting< ValueT >:
Collaboration graph
[legend]

Public Member Functions

 MockSetting (const ValueT &value)
 
Mock SettingInterface methods
 MOCK_METHOD1_T (setLocalChange, SetSettingResult(const ValueT &value))
 
 MOCK_METHOD1_T (setAvsChange, bool(const ValueT &value))
 
 MOCK_METHOD1_T (clearData, bool(const ValueT &value))
 
- Public Member Functions inherited from alexaClientSDK::settings::SettingInterface< ValueT >
virtual ~SettingInterface ()=default
 
virtual SetSettingResult setLocalChange (const ValueType &value)=0
 
virtual bool setAvsChange (const ValueType &value)=0
 
virtual bool clearData (const ValueType &value)=0
 
ValueType get () const
 
ValueType getDefault () const
 
bool addObserver (std::shared_ptr< ObserverType > observer)
 
void removeObserver (std::shared_ptr< ObserverType > &observer)
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::settings::SettingInterface< ValueT >
using ValueType = ValueT
 Define the setting value type. More...
 
using ObserverType = SettingObserverInterface< SettingInterface< ValueType > >
 Define the observer type for this setting. More...
 
- Protected Types inherited from alexaClientSDK::settings::SettingInterface< ValueT >
using GuardedValue = avsCommon::utils::GuardedValue< ValueType >
 Alias for GuardedValue with the templated value ValueType. More...
 
using LogEntry = avsCommon::utils::logger::LogEntry
 Alias to make log entries less verbose. More...
 
- Protected Member Functions inherited from alexaClientSDK::settings::SettingInterface< ValueT >
 SettingInterface (const ValueType &value)
 
void notifyObservers (SettingNotifications notification)
 
- Protected Attributes inherited from alexaClientSDK::settings::SettingInterface< ValueT >
std::mutex m_observerMutex
 Mutex used to guard observers. More...
 
std::unordered_set< std::shared_ptr< ObserverType > > m_observers
 Set of all observers of this setting. More...
 
std::conditional< std::is_scalar< ValueType >::value, std::atomic< ValueType >, GuardedValue >::type m_value
 The setting value. (is_trivially_copyable is not supported on gcc4.8) More...
 
const ValueType m_defaultValue
 The default setting value. More...
 

Detailed Description

template<typename ValueT>
class alexaClientSDK::settings::test::MockSetting< ValueT >

Mock class that implements SettingInterface.

Constructor & Destructor Documentation

◆ MockSetting()

template<typename ValueT >
alexaClientSDK::settings::test::MockSetting< ValueT >::MockSetting ( const ValueT &  value)
explicit

Constructor.

Parameters
valueInitial value of this setting.

Member Function Documentation

◆ MOCK_METHOD1_T() [1/3]

template<typename ValueT >
alexaClientSDK::settings::test::MockSetting< ValueT >::MOCK_METHOD1_T ( setLocalChange  ,
SetSettingResult(const ValueT &value)   
)

◆ MOCK_METHOD1_T() [2/3]

template<typename ValueT >
alexaClientSDK::settings::test::MockSetting< ValueT >::MOCK_METHOD1_T ( setAvsChange  ,
bool(const ValueT &value)   
)

◆ MOCK_METHOD1_T() [3/3]

template<typename ValueT >
alexaClientSDK::settings::test::MockSetting< ValueT >::MOCK_METHOD1_T ( clearData  ,
bool(const ValueT &value)   
)

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

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