Use this service to manage PROFINET Controller Application Relationships (AR) More...

#include <IArDataService.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::IArDataService:

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

using	GetAllArAttributeNamesResultDelegate = delegate< void(IRscReadEnumerator< RscString< 256 > > &)>

using	GetAllArInfoResultDelegate = delegate< void(IRscReadEnumerator< ArInfo > &)>

using	GetAttributeValuesAttributeNameDelegate = delegate< void(IRscWriteEnumerator< RscString< 256 > > &)>

using	GetAttributeValuesResultDelegate = delegate< void(IRscReadEnumerator< ArDataResult > &)>

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

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

virtual void	GetAllArInfo (GetAllArInfoResultDelegate resultDelegate)=0
	This method returns a list of ArInfo-objects with DNS-Name and AR-User-Id of each configured profinet device More...

virtual void	GetAllArAttributeNames (uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate)=0
	This method returns an array of strings with all available attributes of specified AR-User-Id of which values can be read More...

virtual ArDataResult	GetAttributeValue (uint16 arUserId, const RscString< 256 > &attributeName)=0
	Read a single attribute value More...

virtual void	GetAttributeValues (uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate)=0
	Read a list of attribute values More...

virtual std::vector< DiagnosticResult >	GetArDiagnosis (const std::vector< uint16 > &arUserId)=0
	Read an array of diagnosis information 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

Use this service to manage PROFINET Controller Application Relationships (AR)

This service is defined in library Arp.Io.ProfinetStack.

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

Member Function Documentation

◆ GetAllArAttributeNames()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAllArAttributeNames	(	uint16	arUserId,
		GetAllArAttributeNamesResultDelegate	resultDelegate
	)

pure virtual

This method returns an array of strings with all available attributes of specified AR-User-Id of which values can be read

Parameters

arUserId ArUserId to specify AR of requested items

Returns: array of strings with all available attributes

◆ GetAllArInfo()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAllArInfo ( GetAllArInfoResultDelegate resultDelegate )

pure virtual

This method returns a list of ArInfo-objects with DNS-Name and AR-User-Id of each configured profinet device

Returns: result as array of Arp.Io.ProfinetStack.Controller.Services.ArInfo

◆ GetArDiagnosis()

virtual std::vector< DiagnosticResult > Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetArDiagnosis ( const std::vector< uint16 > & arUserId )

pure virtual

Read an array of diagnosis information

Parameters

arUserId Array of uint16-Ar-User-Ids, for which diagnosis is requested, if empty, diagnosis for all configured ARs is returned

Returns: result as array of Arp.Io.ProfinetStack.Controller.Services.DiagnosticResult

◆ GetAttributeValue()

virtual ArDataResult Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAttributeValue	(	uint16	arUserId,
		const RscString< 256 > &	attributeName
	)

pure virtual

Read a single attribute value

Parameters

arUserId	ArUserId to specify AR of requested items
attributeName	String for the requested attribute

Returns: result as Arp.Io.ProfinetStack.Controller.Services.ArDataResult

◆ GetAttributeValues()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArDataService::GetAttributeValues	(	uint16	arUserId,
		GetAttributeValuesAttributeNameDelegate	attributeNameDelegate,
		GetAttributeValuesResultDelegate	resultDelegate
	)

pure virtual

Read a list of attribute values

Parameters

arUserId	ArUserId to specify AR of requested items
attributeName	Array of string for select the items

Returns: result as array of Arp.Io.ProfinetStack.Controller.Services.ArDataResult

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

Arp/Io/ProfinetStack/Controller/Services/IArDataService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAllArAttributeNames()

◆ GetAllArInfo()

◆ GetArDiagnosis()

◆ GetAttributeValue()

◆ GetAttributeValues()