PLCnext API Documentation 25.0.2.69
IPlcConfigService.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/Plc/Domain/Services/ConfigErrorCode.hpp"
12#include "Arp/Plc/Domain/Services/PlcConfigId.hpp"
13#include "Arp/Plc/Domain/Services/PlcConfigItem.hpp"
14#include "Arp/Plc/Domain/Services/PlcConfigResult.hpp"
15
16// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IPlcConfigService.cs
17
19{
20
21using namespace Arp::Base::Rsc::Commons;
22
30class ARP_EXPORT IPlcConfigService : public IRscService
31{
32public: // usings
33 using Ptr = std::shared_ptr<IPlcConfigService>;
34
35public: // construction/destruction
37 IPlcConfigService(void) = default;
38
39public: // static policy operation
40 static IRscServiceProxyFactory& GetProxyFactory(void);
41
42public: // abstract operations
48 virtual PlcConfigResult GetItem(PlcConfigId identifier) = 0;
49
55 virtual ConfigErrorCode SetItem(const PlcConfigItem& item) = 0;
56
62 virtual std::vector<PlcConfigResult> GetItems(const std::vector<PlcConfigId>& identifiers) = 0;
63
69 virtual std::vector<ConfigErrorCode> SetItems(const std::vector<PlcConfigItem>& items) = 0;
70};
71
72} // end of namespace Arp::Plc::Domain::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
Allows to read and write parameters of the PLC config.
Definition: IPlcConfigService.hpp:31
virtual std::vector< PlcConfigResult > GetItems(const std::vector< PlcConfigId > &identifiers)=0
Returns the requested config items.
IPlcConfigService(void)=default
Constructs an IPlcConfigService instance.
virtual PlcConfigResult GetItem(PlcConfigId identifier)=0
Returns the requested config item.
virtual ConfigErrorCode SetItem(const PlcConfigItem &item)=0
Sets the value of the config item.
virtual std::vector< ConfigErrorCode > SetItems(const std::vector< PlcConfigItem > &items)=0
Sets the values of the config items.
A config item.
Definition: PlcConfigItem.hpp:28
The result of a IPlcConfigService operation.
Definition: PlcConfigResult.hpp:28
Namespace for services of the PLC domain
PlcConfigId
Collects all identifiers of the Plc config which are available by the IPlcConfigService.
Definition: PlcConfigId.hpp:19
ConfigErrorCode
The result code of a IPlcConfigService operation.
Definition: ConfigErrorCode.hpp:19