PLCnext API Documentation 25.0.2.69
IArManagementService.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 "Arp/Base/Rsc/Commons/RscString.hxx"
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IArManagementService.cs
13
15{
16
17using namespace Arp::Base::Rsc::Commons;
18
26class ARP_EXPORT IArManagementService : public IRscService
27{
28public: // usings
29 using Ptr = std::shared_ptr<IArManagementService>;
30
31public: // construction/destruction
33 IArManagementService(void) = default;
34
35public: // static policy operation
36 static IRscServiceProxyFactory& GetProxyFactory(void);
37
38public: // abstract operations
49 virtual uint32 GetArState(const RscString<512>& stationName, uint32& arState) = 0;
50
59 virtual uint32 StartAr(const RscString<512>& stationName, uint32& arState) = 0;
60
70 virtual uint32 StopAr(const RscString<512>& stationName, uint32& arState) = 0;
71};
72
73} // end of namespace Arp::Io::ProfinetStack::Controller::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
Use this service to manage PROFINET Application Relationships (AR)
Definition: IArManagementService.hpp:27
virtual uint32 StopAr(const RscString< 512 > &stationName, uint32 &arState)=0
virtual uint32 GetArState(const RscString< 512 > &stationName, uint32 &arState)=0
IArManagementService(void)=default
Constructs an IArManagementService instance.
virtual uint32 StartAr(const RscString< 512 > &stationName, uint32 &arState)=0
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
Namespace for Profinet I/O controller services