PLCnext API Documentation 23.6.0.37
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
28{
29public: // typedefs
30 using Ptr = std::shared_ptr<IArManagementService>;
31
32public: // construction/destruction
34 IArManagementService(void) = default;
35
36public: // static policy operation
37 static IRscServiceProxyFactory& GetProxyFactory(void);
38
39public: // abstract operations
50 virtual uint32 GetArState(const RscString<512>& stationName, uint32& arState) = 0;
51
60 virtual uint32 StartAr(const RscString<512>& stationName, uint32& arState) = 0;
61
71 virtual uint32 StopAr(const RscString<512>& stationName, uint32& arState) = 0;
72};
73
75// inline methods of class IArManagementService
76inline IRscServiceProxyFactory& IArManagementService::GetProxyFactory()
77{
78 return ArManagementServiceProxyFactory::GetInstance();
79}
80
81}}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Use this service to manage PROFINET Application Relationships (AR)
Definition: IArManagementService.hpp:28
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:20
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:36
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API