PLCnext API Documentation  22.6.0.43
IArManagementService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
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 
14 namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
15 {
16 
17 using namespace Arp;
18 using namespace Arp::System::Rsc::Services;
19 
25 {
26 public: // typedefs
27  using Ptr = std::shared_ptr<IArManagementService>;
28 
29 public: // construction/destruction
31  IArManagementService(void) = default;
32 
33 public: // static policy operation
34  static IRscServiceProxyFactory& GetProxyFactory(void);
35 
36 public: // 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
73 inline 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
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API