PLCnext API Documentation  20.0.0.24462
IConfigurationService.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 "ConfigurationServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include "Arp/System/Rsc/Services/RscVariant.hxx"
12 #include "ConfigurationErrorCode.hpp"
13 #include <vector>
14 
15 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IConfigurationService.cs
16 
17 namespace Arp { namespace Io { namespace ProfinetStack { namespace System { namespace Services
18 {
19 
20 using namespace Arp;
21 using namespace Arp::System::Rsc::Services;
22 
27 {
28 public: // typedefs
29  typedef std::shared_ptr<IConfigurationService> Ptr;
30 
31 public: // construction/destruction
35  virtual ~IConfigurationService(void);
36 
37 public: // static policy operation
38  static IRscServiceProxyFactory& GetProxyFactory(void);
39 
40 public: // abstract operations
47  virtual ConfigurationErrorCode Read(const RscString<512>& name, RscVariant<512>& value) = 0;
48 
55  virtual ConfigurationErrorCode Write(const RscString<512>& name, RscVariant<512> value) = 0;
56 
61  virtual RscString<512> GetControllerName() = 0;
62 
67  virtual std::vector<RscString<512>> GetDeviceNames() = 0;
68 
69 private: // deleted methods (for non-copyable classes)
70  IConfigurationService(const IConfigurationService& arg) = delete;
71  IConfigurationService& operator=(const IConfigurationService& arg) = delete;
72 };
73 
75 // inline methods of class IConfigurationService
77 {
78 }
79 
81 {
82 }
83 
84 inline IRscServiceProxyFactory& IConfigurationService::GetProxyFactory()
85 {
86  return ConfigurationServiceProxyFactory::GetInstance();
87 }
88 
89 }}}}} // end of namespace Arp::Io::ProfinetStack::System::Services
IConfigurationService(void)
Constructs an IConfigurationService instance.
Definition: IConfigurationService.hpp:76
Namespace for classes and interfaces for the Remote Service Call implementation
This service read and writes different configuration options to the profinet system.
Definition: IConfigurationService.hpp:26
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
System components used by the System, Device, Plc or Io domains.
virtual ~IConfigurationService(void)
Destructs this instance and frees all resouces.
Definition: IConfigurationService.hpp:80