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

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

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

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

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

Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

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

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

virtual void	GetItems (GetItemsIdentifiersDelegate identifiersDelegate, GetItemsResultDelegate resultDelegate)=0
	This operation reads several device information items. More...

Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance.

virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces.

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

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

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

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::IDeviceInfoService::GetItem ( const RscString< 512 > & identifier )

pure virtual

This operation reads a single device information item.

Parameters

identifier Specifies the device information item to be read.

Returns: The value of the requested device information as
RscVariant

Arp::System::Rsc::Services::RscVariant
Rsc container class for primitive data type, strings or information about arrays or structs....
Definition: RscVariant.hxx:69

on success,
RscType::Void

on error.

The data type of the requested device information can be found in the service documentation.

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

pure virtual

This operation reads several device information items.

Parameters

identifiers Specifies a list of device information items to be read.

Returns: A list of values of the requested device information as
RscVariant

>on success,
RscType::Void

on error.

The data types of the requested device information can be found in the service documentation.

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