alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T > Class Template Reference

#include <AlwaysTrueCommunicationValidator.h>

Inheritance diagram for alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >:

Collaboration diagram for alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >:

Public Member Functions
	AlwaysTrueCommunicationValidator ()=default
	~AlwaysTrueCommunicationValidator () override=default
CommunicationPropertyValidatorInterface methods
bool	validateWriteRequest (const std::string &propertyName, T newValue) override
Public Member Functions inherited from alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T >
virtual	~CommunicationPropertyValidatorInterface ()=default

Detailed Description

template<typename T>
class alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >

This is an implementation of the CommunicationPropertyValidatorInterface, that will always result to true. This class is meant to offer implementors a quick way to create Writable properties without creating a new CommunicationPropertyWriter if they don't want to validate the value being written.

Constructor & Destructor Documentation

AlwaysTrueCommunicationValidator()

template<typename T >

alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >::AlwaysTrueCommunicationValidator ( )

default

Default Constructor

~AlwaysTrueCommunicationValidator()

template<typename T >

alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >::~AlwaysTrueCommunicationValidator ( )

overridedefault

Default Destructor

Member Function Documentation

validateWriteRequest()

template<typename T >

bool alexaClientSDK::acsdkCommunication::AlwaysTrueCommunicationValidator< T >::validateWriteRequest ( const std::string &  propertyName, T  newValue  )

inlineoverridevirtual

Called when we want to write to a property. Used to validate before we write the newValue

Parameters

propertyName	The name of the property
newValue	The new value of the property

Returns

true if alright to write value, false otherwise.

Implements alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyValidatorInterface< T >.

---

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

• /workplace/avs-device-sdk/shared/acsdkCommunication/include/acsdkCommunication/AlwaysTrueCommunicationValidator.h