Arp::Device::Interface::Services::IDeviceSettingsService Class Reference

Use this service to read and write device settings. More...

#include <IDeviceSettingsService.hpp>

Inheritance diagram for Arp::Device::Interface::Services::IDeviceSettingsService:

Public Types
typedef std::shared_ptr< IDeviceSettingsService >	Ptr
typedef delegate< void(IRscWriteEnumerator< RscString< 512 >> &)>	ReadValuesSettingsDelegate
typedef delegate< void(IRscReadEnumerator< DeviceSettingResult > &)>	ReadValuesResultDelegate
typedef delegate< void(IRscWriteEnumerator< DeviceSettingItem > &)>	WriteValuesSettingItemsDelegate
typedef delegate< void(IRscReadEnumerator< AccessErrorCode > &)>	WriteValuesResultDelegate
Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	IDeviceSettingsService (void)
	Constructs an IDeviceSettingsService instance. More...
virtual	~IDeviceSettingsService (void)
	Destructs this instance and frees all resouces. More...
virtual DeviceSettingResult	ReadValue (const RscString< 512 > &setting)=0
	Read a single setting More...
virtual void	ReadValues (ReadValuesSettingsDelegate settingsDelegate, ReadValuesResultDelegate resultDelegate)=0
	Read a list of settings More...
virtual AccessErrorCode	WriteValue (const DeviceSettingItem &settingItem)=0
	Write a single setting More...
virtual void	WriteValues (WriteValuesSettingItemsDelegate settingItemsDelegate, WriteValuesResultDelegate resultDelegate)=0
	Write a list of settings More...
Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces. More...

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of the service More...

Detailed Description

Use this service to read and write device settings.

Constructor & Destructor Documentation

IDeviceSettingsService()

IDeviceSettingsService::IDeviceSettingsService ( void  )

inline

Constructs an IDeviceSettingsService instance.

~IDeviceSettingsService()

IDeviceSettingsService::~IDeviceSettingsService ( void  )

inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

ReadValue()

virtual DeviceSettingResult Arp::Device::Interface::Services::IDeviceSettingsService::ReadValue ( const RscString< 512 > &  setting )

pure virtual

Read a single setting

Parameters

setting

String for select the item

Returns

result as Arp.Device.Interface.Services.DeviceSettingResult

ReadValues()

virtual void Arp::Device::Interface::Services::IDeviceSettingsService::ReadValues ( ReadValuesSettingsDelegate  settingsDelegate, ReadValuesResultDelegate  resultDelegate  )

pure virtual

Read a list of settings

Parameters

settings

Arry of string for select the items

Returns

result as arry of Arp.Device.Interface.Services.DeviceSettingResult

WriteValue()

virtual AccessErrorCode Arp::Device::Interface::Services::IDeviceSettingsService::WriteValue ( const DeviceSettingItem &  settingItem )

pure virtual

Write a single setting

Parameters

settingItem

Arp.Device.Interface.Services.DeviceSettingItem with string for select the item and the new value

Returns

result as Arp.Device.Interface.Services.AccessErrorCode

WriteValues()

virtual void Arp::Device::Interface::Services::IDeviceSettingsService::WriteValues ( WriteValuesSettingItemsDelegate  settingItemsDelegate, WriteValuesResultDelegate  resultDelegate  )

pure virtual

Write a list of settings

Parameters

settingItems

Arry of Arp.Device.Interface.Services.DeviceSettingItem for set the items to new values

Returns

result as arry of Arp.Device.Interface.Services.AccessErrorCode

---

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

• Arp/Device/Interface/Services/IDeviceSettingsService.hpp