This service provides operations to read status information from the device. More...

Inheritance diagram for Arp::Device::Interface::Services::IDeviceStatusService:

Public Types
using	Ptr = std::shared_ptr< IDeviceStatusService >

using	GetItemsIdentifiersDelegate = delegate< void(IRscWriteEnumerator< RscString< 512 > > &)>

using	GetItemsResultDelegate = delegate< void(IRscReadEnumerator< RscVariant< 512 > > &)>

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

Public Member Functions
	IDeviceStatusService (void)=default
	Constructs an IDeviceStatusService instance.

virtual RscVariant< 512 >	GetItem (const RscString< 512 > &identifier)=0
	This operation reads a single status information item. More...

virtual void	GetItems (GetItemsIdentifiersDelegate identifiersDelegate, GetItemsResultDelegate resultDelegate)=0
	This operation reads a list of status information 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

This service provides operations to read status information from the device.

The service is defined in the library Arp.Device.Interface.
A current documentation of available device status information can be found in the Phoenix Contact "PLCnext Info Center", e.g.: PLCnext Info Center: IDeviceStatusService.

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

Member Function Documentation

virtual RscVariant< 512 > Arp::Device::Interface::Services::IDeviceStatusService::GetItem ( const RscString< 512 > & identifier )

pure virtual

This operation reads a single status information item.

Parameters

identifier String to select the respective status information item.

Returns: The result of the read operation as
RscVariant

Arp::Base::Rsc::Commons::RscVariant
Rsc class for variant data types like primitive data type, strings or information about arrays or str...
Definition: RscVariant.hxx:57

on success,
RscType::Void

on error.

virtual void Arp::Device::Interface::Services::IDeviceStatusService::GetItems	(	GetItemsIdentifiersDelegate	identifiersDelegate,
		GetItemsResultDelegate	resultDelegate
	)

pure virtual

This operation reads a list of status information items.

Parameters

identifiers Arry of String select the respective status information items.

Returns: The result of the read operation as an array of
RscVariant

on success,
RscType::Void

on error.

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