PLCnext API Documentation 23.0.2.9
IArManagementService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/Io/ProfinetStack/Controller/Services/ArManagementServiceProxyFactory.hpp"
9#include "Arp/System/Rsc/Services/IRscService.hpp"
10#include "Arp/System/Rsc/Services/RscString.hxx"
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IArManagementService.cs
13
14namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
15{
16
17using namespace Arp;
18using namespace Arp::System::Rsc::Services;
19
25{
26public: // typedefs
27 using Ptr = std::shared_ptr<IArManagementService>;
28
29public: // construction/destruction
31 IArManagementService(void) = default;
32
33public: // static policy operation
34 static IRscServiceProxyFactory& GetProxyFactory(void);
35
36public: // abstract operations
47 virtual uint32 GetArState(const RscString<512>& stationName, uint32& arState) = 0;
48
57 virtual uint32 StartAr(const RscString<512>& stationName, uint32& arState) = 0;
58
68 virtual uint32 StopAr(const RscString<512>& stationName, uint32& arState) = 0;
69};
70
72// inline methods of class IArManagementService
73inline IRscServiceProxyFactory& IArManagementService::GetProxyFactory()
74{
75 return ArManagementServiceProxyFactory::GetInstance();
76}
77
78}}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Use this service to manage PROFINET Application Relationships (AR)
Definition: IArManagementService.hpp:25
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
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API