PLCnext API Documentation  22.3.0.20
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Plc::Domain::Services::IPlcManagerService2 Class Referenceabstract

The DownloadChange extension of the Arp.Plc.Domain.Services.IPlcManagerService. More...

#include <IPlcManagerService2.hpp>

Inheritance diagram for Arp::Plc::Domain::Services::IPlcManagerService2:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IPlcManagerService2 >
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IPlcManagerService2 (void)=default
 Constructs an IPlcManagerService2 instance. More...
 
virtual void Load (boolean async=false)=0
 
virtual void Start (PlcStartKind startKind, boolean async=false)=0
 
virtual void Stop (boolean async=false)=0
 
virtual void Reset (boolean async=false)=0
 
virtual PlcState GetPlcState ()=0
 
virtual void Change (boolean async=false)=0
 This operation will perform the change of the PLC configuration, which was downloaded before. More...
 
virtual void Restart (PlcStartKind startKind, boolean async=false)=0
 Restarts the Plc, that is, it's stopped and started in a single operation. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

static IRscServiceProxyFactory & GetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory & GetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of the service More...
 

Detailed Description

The DownloadChange extension of the Arp.Plc.Domain.Services.IPlcManagerService.

Constructor & Destructor Documentation

◆ IPlcManagerService2()

Arp::Plc::Domain::Services::IPlcManagerService2::IPlcManagerService2 ( void  )
default

Constructs an IPlcManagerService2 instance.

Member Function Documentation

◆ Change()

virtual void Arp::Plc::Domain::Services::IPlcManagerService2::Change ( boolean  async = false)
pure virtual

This operation will perform the change of the PLC configuration, which was downloaded before.

Parameters
asynctrue, if the operation should be processed asynchronously, otherwise false.

◆ Restart()

virtual void Arp::Plc::Domain::Services::IPlcManagerService2::Restart ( PlcStartKind  startKind,
boolean  async = false 
)
pure virtual

Restarts the Plc, that is, it's stopped and started in a single operation.

Parameters
startKindThe start kind Arp.Plc.Domain.Services.PlcStartKind.Cold, Arp.Plc.Domain.Services.PlcStartKind.Warm, Arp.Plc.Domain.Services.PlcStartKind.RestoreWarm of Arp.Plc.Domain.Services.PlcStartKind.Hot
asynctrue, if the operation should be processed asynchronously, otherwise false.

The documentation for this class was generated from the following file: