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

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::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

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::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.
	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...
	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...
IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...
IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this 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.

Consider the following common rule when using RSC services that provide arrays or enumerators as return values or out arguments: It is always required to completely read all items from these resulting lists or enumerators.

Member Function Documentation

ReadValue()

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

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()

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

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()

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

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()

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

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