AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::settings::test::TimezoneSettingStub Class Reference
Inheritance diagram for alexaClientSDK::settings::test::TimezoneSettingStub:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::settings::test::TimezoneSettingStub:
Collaboration graph
[legend]

Public Member Functions

SetSettingResult setLocalChange (const std::string &value) override
 Set the value synchronously for simplicity. More...
 
bool setAvsChange (const std::string &value) override
 Just a stub that doesn't do anything. More...
 
bool clearData (const std::string &value) override
 Just a stub that doesn't do anything. More...
 
 TimezoneSettingStub (const std::string &value)
 Build setting object. More...
 
- 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

Stub a setting for test purpose.

Constructor & Destructor Documentation

◆ TimezoneSettingStub()

alexaClientSDK::settings::test::TimezoneSettingStub::TimezoneSettingStub ( const std::string &  value)
explicit

Build setting object.

Member Function Documentation

◆ clearData()

bool alexaClientSDK::settings::test::TimezoneSettingStub::clearData ( const std::string &  value)
override

Just a stub that doesn't do anything.

◆ setAvsChange()

bool alexaClientSDK::settings::test::TimezoneSettingStub::setAvsChange ( const std::string &  value)
override

Just a stub that doesn't do anything.

◆ setLocalChange()

SetSettingResult alexaClientSDK::settings::test::TimezoneSettingStub::setLocalChange ( const std::string &  value)
override

Set the value synchronously for simplicity.


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

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