Arp::Plc::Domain::Services::IPlcConfigService Class Reference

Allows to read and write parameters of the PLC config. More...

#include <IPlcConfigService.hpp>

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

Public Types
using	Ptr = std::shared_ptr< IPlcConfigService >
Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IPlcConfigService (void)=default
	Constructs an IPlcConfigService instance.
virtual PlcConfigResult	GetItem (PlcConfigId identifier)=0
	Returns the requested config item. More...
virtual ConfigErrorCode	SetItem (const PlcConfigItem &item)=0
	Sets the value of the config item. More...
virtual std::vector< PlcConfigResult >	GetItems (const std::vector< PlcConfigId > &identifiers)=0
	Returns the requested config items. More...
virtual std::vector< ConfigErrorCode >	SetItems (const std::vector< PlcConfigItem > &items)=0
	Sets the values of the config items. 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::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

Allows to read and write parameters of the PLC config.

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

GetItem()

virtual PlcConfigResult Arp::Plc::Domain::Services::IPlcConfigService::GetItem ( PlcConfigId  identifier )

pure virtual

Returns the requested config item.

Parameters

identifier

The identifier of the config item to retrieve.

Returns

The result of the request.

GetItems()

virtual std::vector< PlcConfigResult > Arp::Plc::Domain::Services::IPlcConfigService::GetItems ( const std::vector< PlcConfigId > &  identifiers )

pure virtual

Returns the requested config items.

Parameters

identifiers

The identifiers of the config items to retrieve.

Returns

The results of the request.

SetItem()

virtual ConfigErrorCode Arp::Plc::Domain::Services::IPlcConfigService::SetItem ( const PlcConfigItem &  item )

pure virtual

Sets the value of the config item.

Parameters

item	The config item to update.

Returns

The result of the request.

SetItems()

virtual std::vector< ConfigErrorCode > Arp::Plc::Domain::Services::IPlcConfigService::SetItems ( const std::vector< PlcConfigItem > &  items )

pure virtual

Sets the values of the config items.

Parameters

items

The config items to update.

Returns

The results of the request.

---

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

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