PLCnext API Documentation 24.0.0.71
IPlcManagerService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/Plc/Domain/Services/PlcManagerServiceProxyFactory.hpp"
9#include "Arp/Plc/Domain/Services/PlcStartKind.hpp"
10#include "Arp/Plc/Domain/Services/PlcState.hpp"
11#include "Arp/System/Rsc/Services/IRscService.hpp"
12
13// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IPlcManagerService.cs
14
15namespace Arp { namespace Plc { namespace Domain { namespace Services
16{
17
18using namespace Arp;
19using namespace Arp::System::Rsc::Services;
20
29{
30public: // typedefs
31 using Ptr = std::shared_ptr<IPlcManagerService>;
32
33public: // construction/destruction
35 IPlcManagerService(void) = default;
36
37public: // static policy operation
38 static IRscServiceProxyFactory& GetProxyFactory(void);
39
40public: // abstract operations
46 virtual void Load(boolean async = false) = 0;
47
66 virtual void Start(PlcStartKind startKind, boolean async = false) = 0;
67
73 virtual void Stop(boolean async = false) = 0;
74
80 virtual void Reset(boolean async = false) = 0;
81
89 virtual PlcState GetPlcState() = 0;
90};
91
93// inline methods of class IPlcManagerService
94inline IRscServiceProxyFactory& IPlcManagerService::GetProxyFactory()
95{
96 return PlcManagerServiceProxyFactory::GetInstance();
97}
98
99}}}} // end of namespace Arp::Plc::Domain::Services
Use this service to control the PLC of the controller.
Definition: IPlcManagerService.hpp:29
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.
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API