PLCnext API Documentation 25.0.2.69
IPlcManagerService.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/Plc/Domain/Services/PlcStartKind.hpp"
11#include "Arp/Plc/Domain/Services/PlcState.hpp"
12
13// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IPlcManagerService.cs
14
16{
17
18using namespace Arp::Base::Rsc::Commons;
19
27class ARP_EXPORT IPlcManagerService : public IRscService
28{
29public: // usings
30 using Ptr = std::shared_ptr<IPlcManagerService>;
31
32public: // construction/destruction
34 IPlcManagerService(void) = default;
35
36public: // static policy operation
37 static IRscServiceProxyFactory& GetProxyFactory(void);
38
39public: // abstract operations
45 virtual void Load(boolean async = false) = 0;
46
65 virtual void Start(PlcStartKind startKind, boolean async = false) = 0;
66
72 virtual void Stop(boolean async = false) = 0;
73
79 virtual void Reset(boolean async = false) = 0;
80
88 virtual PlcState GetPlcState() = 0;
89};
90
91} // 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
Use this service to control the PLC of the controller.
Definition: IPlcManagerService.hpp:28
virtual void Reset(boolean async=false)=0
Resets the PLC and unloads its configuration.
IPlcManagerService(void)=default
Constructs an IPlcManagerService instance.
virtual PlcState GetPlcState()=0
Gets the actual PLC state.
virtual void Start(PlcStartKind startKind, boolean async=false)=0
Starts the PLC.
virtual void Stop(boolean async=false)=0
Stops the PLC.
virtual void Load(boolean async=false)=0
Loads the PLC configuration and setup the PLC.
PlcState
Definition: PlcState.hpp:14
Namespace for services of the PLC domain