Arp::Device::Interface::Services::IDeviceInfoService Class Reference

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

#include <IDeviceInfoService.hpp>

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::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

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::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 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.

Consider the following common rule when using RSC services that provide arrays or enumerators as return values or out arguments: It is always required to completely read all items from these resulting lists or enumerators.

Member Function Documentation

GetItem()

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

on success,

RscType::Void

on error.

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

GetItems()

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:

• Arp/Device/Interface/Services/IDeviceInfoService.hpp