PLCnext API Documentation  20.0.0.24462
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Device::Interface::Services::IDeviceInfoService Class Referenceabstract

Use this service to read device information. More...

#include <IDeviceInfoService.hpp>

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

Public Types

typedef std::shared_ptr< IDeviceInfoServicePtr
 
typedef delegate< void(IRscWriteEnumerator< RscString< 512 >> &)> GetItemsIdentifiersDelegate
 
typedef delegate< void(IRscReadEnumerator< RscVariant< 512 >> &)> GetItemsResultDelegate
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IDeviceInfoService (void)
 Constructs an IDeviceInfoService instance. More...
 
virtual ~IDeviceInfoService (void)
 Destructs this instance and frees all resouces. More...
 
virtual RscVariant< 512 > GetItem (const RscString< 512 > &identifier)=0
 Read a single information More...
 
virtual void GetItems (GetItemsIdentifiersDelegate identifiersDelegate, GetItemsResultDelegate resultDelegate)=0
 Read a list of information More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

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

Use this service to read device information.

Constructor & Destructor Documentation

◆ IDeviceInfoService()

Arp::Device::Interface::Services::IDeviceInfoService::IDeviceInfoService ( void  )
inline

Constructs an IDeviceInfoService instance.

◆ ~IDeviceInfoService()

Arp::Device::Interface::Services::IDeviceInfoService::~IDeviceInfoService ( void  )
inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

◆ GetItem()

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

Read a single information

Parameters
identifierString for select the item
Returns
value as
RscVariant
on success,
RscType::Void
on error

◆ GetItems()

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

Read a list of information

Parameters
identifiersArry of String for select the items
Returns
value as
RscVariant
>on success,
RscType::Void
on error

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