PLCnext API Documentation 25.0.2.69
IConfigurationService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include <vector>
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12#include "Arp/Base/Rsc/Commons/RscVariant.hxx"
13#include "Arp/Io/ProfinetStack/System/Services/ConfigurationErrorCode.hpp"
14
15// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IConfigurationService.cs
16
18{
19
20using namespace Arp::Base::Rsc::Commons;
21
35class ARP_EXPORT IConfigurationService : public IRscService
36{
37public: // usings
38 using Ptr = std::shared_ptr<IConfigurationService>;
39
40public: // construction/destruction
42 IConfigurationService(void) = default;
43
44public: // static policy operation
45 static IRscServiceProxyFactory& GetProxyFactory(void);
46
47public: // abstract operations
58
68 virtual ConfigurationErrorCode Write(const RscString<512>& name, const RscVariant<512>& value) = 0;
69
75
80 virtual std::vector<RscString<512>> GetDeviceNames() = 0;
81};
82
83} // end of namespace Arp::Io::ProfinetStack::System::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This service read and writes different configuration options to the profinet system.
Definition: IConfigurationService.hpp:36
virtual std::vector< RscString< 512 > > GetDeviceNames()=0
Gets the instance names of all registered profinet devices.
virtual ConfigurationErrorCode Write(const RscString< 512 > &name, const RscVariant< 512 > &value)=0
Writes one configuration to 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...
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.
Namespace for Profinet I/O system services
ConfigurationErrorCode
This enumeration defines errors codes of the Arp.Io.ProfinetStack.System.Services....
Definition: ConfigurationErrorCode.hpp:19