This service provides operations to read and write settings from resp. to the device. More...
#include <IDeviceSettingsService.hpp>
Inheritance diagram for Arp::Device::Interface::Services::IDeviceSettingsService:
Public Types | |
| using | Ptr = std::shared_ptr< IDeviceSettingsService > |
| using | ReadValuesResultDelegate = delegate< void(IRscReadEnumerator< DeviceSettingResult > &)> |
| using | ReadValuesSettingsDelegate = delegate< void(IRscWriteEnumerator< RscString< 512 > > &)> |
| using | WriteValuesResultDelegate = delegate< void(IRscReadEnumerator< AccessErrorCode > &)> |
| using | WriteValuesSettingItemsDelegate = delegate< void(IRscWriteEnumerator< DeviceSettingItem > &)> |
 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. | |
| virtual DeviceSettingResult | ReadValue (const RscString< 512 > &setting)=0 |
| This operation reads a single setting. More... | |
| virtual void | ReadValues (ReadValuesSettingsDelegate settingsDelegate, ReadValuesResultDelegate resultDelegate)=0 |
| This operation reads a list of settings. More... | |
| virtual AccessErrorCode | WriteValue (const DeviceSettingItem &settingItem)=0 |
| This operation writes a single setting. More... | |
| virtual void | WriteValues (WriteValuesSettingItemsDelegate settingItemsDelegate, WriteValuesResultDelegate resultDelegate)=0 |
| This operation writes a list of settings. More... | |
| Public Member Functions inherited from Arp::System::Rsc::Services::IRscService | |
| IRscService (void)=default | |
| Constructs an IRscService instance. | |
| virtual | ~IRscService (void)=default |
| Destructs this instance and frees all resouces. | |
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
This service provides operations to read and write settings from resp. to the device.
The service is defined in the library Arp.Device.Interface.
A current documentation of available device settings can be found in the Phoenix Contact "PLCnext Info Center", e.g.: PLCnext Info Center: IDeviceSettingsService.
Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.
Member Function Documentation
◆ ReadValue()
|
pure virtual |
This operation reads a single setting.
- Parameters
-
setting String containing the respective setting.
- Returns
- The result of the read operation as Arp.Device.Interface.Services.DeviceSettingResult.
◆ ReadValues()
|
pure virtual |
This operation reads a list of settings.
- Parameters
-
settings Array of strings containing the respective settings.
- Returns
- The results of the read operation as an array of Arp.Device.Interface.Services.DeviceSettingResult.
◆ WriteValue()
|
pure virtual |
This operation writes a single setting.
- Parameters
-
settingItem Arp.Device.Interface.Services.DeviceSettingItem containing a string for selecting the respective setting and its new value.
- Returns
- The result of the write operation as Arp.Device.Interface.Services.AccessErrorCode.
◆ WriteValues()
|
pure virtual |
This operation writes a list of settings.
- Parameters
-
settingItems Array of Arp.Device.Interface.Services.DeviceSettingItem each containing a string for selecting the respective setting and its new value.
- Returns
- The result of the write operation as an array of Arp.Device.Interface.Services.AccessErrorCode.
The documentation for this class was generated from the following file:
- Arp/Device/Interface/Services/IDeviceSettingsService.hpp
