PLCnext API Documentation  22.9.0.33
IConfigurationService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include <vector>
9 #include "Arp/Io/ProfinetStack/System/Services/ConfigurationErrorCode.hpp"
10 #include "Arp/Io/ProfinetStack/System/Services/ConfigurationServiceProxyFactory.hpp"
11 #include "Arp/System/Rsc/Services/IRscService.hpp"
12 #include "Arp/System/Rsc/Services/RscString.hxx"
13 #include "Arp/System/Rsc/Services/RscVariant.hxx"
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 
34 {
35 public: // typedefs
36  using Ptr = std::shared_ptr<IConfigurationService>;
37 
38 public: // construction/destruction
40  IConfigurationService(void) = default;
41 
42 public: // static policy operation
43  static IRscServiceProxyFactory& GetProxyFactory(void);
44 
45 public: // abstract operations
52  virtual ConfigurationErrorCode Read(const RscString<512>& name, RscVariant<512>& value) = 0;
53 
61 
67 
72  virtual std::vector<RscString<512>> GetDeviceNames() = 0;
73 };
74 
76 // inline methods of class IConfigurationService
77 inline IRscServiceProxyFactory& IConfigurationService::GetProxyFactory()
78 {
79  return ConfigurationServiceProxyFactory::GetInstance();
80 }
81 
82 }}}}} // end of namespace Arp::Io::ProfinetStack::System::Services
This service read and writes different configuration options to the profinet system.
Definition: IConfigurationService.hpp:34
virtual ConfigurationErrorCode Write(const RscString< 512 > &name, RscVariant< 512 > value)=0
Writes one configuration to the profinet system.
IConfigurationService(void)=default
Constructs an IConfigurationService instance.
virtual std::vector< RscString< 512 > > GetDeviceNames()=0
Gets the instance names of all registered profinet devices.
virtual ConfigurationErrorCode Read(const RscString< 512 > &name, RscVariant< 512 > &value)=0
Reads one configuration from the profinet system.
virtual RscString< 512 > GetControllerName()=0
Gets the instance name of the profinet controller. If no controller is registered returns an empty st...
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
ConfigurationErrorCode
This enumeration defines errors codes of the Arp.Io.ProfinetStack.System.Services....
Definition: ConfigurationErrorCode.hpp:19
@ System
System components used by the System, Device, Plc or Io domains.
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API