PLCnext API Documentation
22.3.0.20
|
Use this service to read and write device settings. More...
#include <IDeviceSettingsService.hpp>
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< IRscService > | Ptr |
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... | |
Use this service to read and write device settings.
|
default |
Constructs an IDeviceSettingsService instance.
|
pure virtual |
Read a single setting
setting | String for select the item |
|
pure virtual |
Read a list of settings
settings | Arry of string for select the items |
|
pure virtual |
Write a single setting
settingItem | Arp.Device.Interface.Services.DeviceSettingItem with string for select the item and the new value |
|
pure virtual |
Write a list of settings
settingItems | Arry of Arp.Device.Interface.Services.DeviceSettingItem for set the items to new values |