PLCnext API Documentation  21.6.0.46
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Device::Interface::Services::IDeviceSettingsService Class Referenceabstract

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

#include <IDeviceSettingsService.hpp>

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

Public Types

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

Public Member Functions

 IDeviceSettingsService (void)=default
 Constructs an IDeviceSettingsService instance. 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()

Arp::Device::Interface::Services::IDeviceSettingsService::IDeviceSettingsService ( void  )
default

Constructs an IDeviceSettingsService instance.

Member Function Documentation

◆ ReadValue()

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

Read a single setting

Parameters
settingString 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
settingsArry 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
settingItemArp.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
settingItemsArry 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: