Arp::Plc::Domain::Services::IPlcManagerService2 Class Reference

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

#include <IPlcManagerService2.hpp>

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

Public Types
using	Ptr = std::shared_ptr< IPlcManagerService2 >
Public Types inherited from Arp::Plc::Domain::Services::IPlcManagerService
using	Ptr = std::shared_ptr< IPlcManagerService >
Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IPlcManagerService2 (void)=default
	Constructs an IPlcManagerService2 instance.
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::Plc::Domain::Services::IPlcManagerService
	IPlcManagerService (void)=default
	Constructs an IPlcManagerService instance.
virtual void	Load (boolean async=false)=0
	Loads the PLC configuration and setup the PLC. More...
virtual void	Start (PlcStartKind startKind, boolean async=false)=0
	Starts the PLC. More...
virtual void	Stop (boolean async=false)=0
	Stops the PLC. More...
virtual void	Reset (boolean async=false)=0
	Resets the PLC and unloads its configuration. More...
virtual PlcState	GetPlcState ()=0
	Gets the actual PLC state. More...
Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.
	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...
	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...
IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...
IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Plc::Domain::Services::IPlcManagerService
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

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

This service is defined in library Arp.Plc.Domain.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

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

async

true, 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

startKind	The 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
async	true, if the operation should be processed asynchronously, otherwise false.

---

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

• Arp/Plc/Domain/Services/IPlcManagerService2.hpp