PLCnext API Documentation 23.6.0.37
IConfigurationService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
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
17namespace Arp { namespace Io { namespace ProfinetStack { namespace System { namespace Services
18{
19
20using namespace Arp;
21using namespace Arp::System::Rsc::Services;
22
37{
38public: // typedefs
39 using Ptr = std::shared_ptr<IConfigurationService>;
40
41public: // construction/destruction
43 IConfigurationService(void) = default;
44
45public: // static policy operation
46 static IRscServiceProxyFactory& GetProxyFactory(void);
47
48public: // abstract operations
59
70
76
81 virtual std::vector<RscString<512>> GetDeviceNames() = 0;
82};
83
85// inline methods of class IConfigurationService
86inline IRscServiceProxyFactory& IConfigurationService::GetProxyFactory()
87{
88 return ConfigurationServiceProxyFactory::GetInstance();
89}
90
91}}}}} // end of namespace Arp::Io::ProfinetStack::System::Services
This service read and writes different configuration options to the profinet system.
Definition: IConfigurationService.hpp:37
virtual ConfigurationErrorCode Write(const RscString< 512 > &name, RscVariant< 512 > value)=0
Writes one configuration to the profinet system.
virtual std::vector< RscString< 512 > > GetDeviceNames()=0
Gets the instance names of all registered profinet devices.
virtual RscString< 512 > GetControllerName()=0
Gets the instance name of the profinet controller. If no controller is registered returns an empty st...
IConfigurationService(void)=default
Constructs an IConfigurationService instance.
virtual ConfigurationErrorCode Read(const RscString< 512 > &name, RscVariant< 512 > &value)=0
Reads one configuration from the profinet system.
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
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
Root namespace for the PLCnext API