PLCnext API Documentation  20.6.0.30321
IDeviceSettingsService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "DeviceSettingsServiceProxyFactory.hpp"
10 #include "AccessErrorCode.hpp"
11 #include "Arp/System/Core/delegate.hxx"
12 #include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
13 #include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
14 #include "Arp/System/Rsc/Services/RscString.hxx"
15 #include "DeviceSettingItem.hpp"
16 #include "DeviceSettingResult.hpp"
17 
18 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDeviceSettingsService.cs
19 
20 namespace Arp { namespace Device { namespace Interface { namespace Services
21 {
22 
23 using namespace Arp;
24 using namespace Arp::System::Rsc::Services;
25 
30 {
31 public: // typedefs
32  typedef std::shared_ptr<IDeviceSettingsService> Ptr;
33  typedef delegate<void(IRscWriteEnumerator<RscString<512>>&)> ReadValuesSettingsDelegate;
34  typedef delegate<void(IRscReadEnumerator<DeviceSettingResult>&)> ReadValuesResultDelegate;
35  typedef delegate<void(IRscWriteEnumerator<DeviceSettingItem>&)> WriteValuesSettingItemsDelegate;
36  typedef delegate<void(IRscReadEnumerator<AccessErrorCode>&)> WriteValuesResultDelegate;
37 
38 public: // construction/destruction
42  virtual ~IDeviceSettingsService(void);
43 
44 public: // static policy operation
45  static IRscServiceProxyFactory& GetProxyFactory(void);
46 
47 public: // abstract operations
53  virtual DeviceSettingResult ReadValue(const RscString<512>& setting) = 0;
54 
60  virtual void ReadValues(ReadValuesSettingsDelegate settingsDelegate, ReadValuesResultDelegate resultDelegate) = 0;
61 
68  virtual AccessErrorCode WriteValue(const DeviceSettingItem& settingItem) = 0;
69 
75  virtual void WriteValues(WriteValuesSettingItemsDelegate settingItemsDelegate, WriteValuesResultDelegate resultDelegate) = 0;
76 
77 private: // deleted methods (for non-copyable classes)
79  IDeviceSettingsService& operator=(const IDeviceSettingsService& arg) = delete;
80 };
81 
83 // inline methods of class IDeviceSettingsService
85 {
86 }
87 
89 {
90 }
91 
92 inline IRscServiceProxyFactory& IDeviceSettingsService::GetProxyFactory()
93 {
94  return DeviceSettingsServiceProxyFactory::GetInstance();
95 }
96 
97 }}}} // end of namespace Arp::Device::Interface::Services
Container for a (relative) setting identifier with its value.
Definition: DeviceSettingItem.hpp:31
Namespace for classes and interfaces for the Remote Service Call implementation
Use this service to read and write device settings.
Definition: IDeviceSettingsService.hpp:29
Container for a combination of an error code and a value which is a result for a read operation to a ...
Definition: DeviceSettingResult.hpp:29
virtual ~IDeviceSettingsService(void)
Destructs this instance and frees all resouces.
Definition: IDeviceSettingsService.hpp:88
IDeviceSettingsService(void)
Constructs an IDeviceSettingsService instance.
Definition: IDeviceSettingsService.hpp:84
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
AccessErrorCode
Enumeration for error codes returned from Device.Interface.Services.
Definition: AccessErrorCode.hpp:20