Arp::Io::ProfinetStack::Controller::Services::IArConfigurationService Class Reference

This service provides PROFINET AR configurations and differences More...

#include <IArConfigurationService.hpp>

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

Public Types
using	Ptr = std::shared_ptr< IArConfigurationService >
using	GetConfigurationsResultDelegate = delegate< void(IRscReadEnumerator< ArConfiguration > &)>
using	GetDifferencesResultDelegate = delegate< void(IRscReadEnumerator< ArDifference > &)>
Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	IArConfigurationService (void)=default
	Constructs an IArConfigurationService instance.
virtual ArConfiguration	GetConfiguration (uint16 arUserId)=0
	Get PROFINET configuration for one AR More...
virtual void	GetConfigurations (const std::vector< uint16 > &arUserIds, GetConfigurationsResultDelegate resultDelegate)=0
	Get PROFINET configuration for multiple ARs More...
virtual ArDifference	GetDifference (uint16 arUserId)=0
	Get difference in configuration for one AR More...
virtual void	GetDifferences (const std::vector< uint16 > &arUserIds, GetDifferencesResultDelegate resultDelegate)=0
	Get differences in configuration for multiple ARs 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 PROFINET AR configurations and differences

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

GetConfiguration()

virtual ArConfiguration Arp::Io::ProfinetStack::Controller::Services::IArConfigurationService::GetConfiguration ( uint16  arUserId )

pure virtual

Get PROFINET configuration for one AR

Parameters

arUserId

Contains user ID for which the configuration shall be read.

Returns

Configurations of requested AR as Arp.Io.ProfinetStack.Controller.Services.ArConfiguration.

GetConfigurations()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArConfigurationService::GetConfigurations ( const std::vector< uint16 > &  arUserIds, GetConfigurationsResultDelegate  resultDelegate  )

pure virtual

Get PROFINET configuration for multiple ARs

Parameters

arUserIds

Contains all user IDs for which the configuration shall be read. If arUserIds is empty, all AR configurations will be requested.

Returns

Configurations of requested ARs as Arp.Io.ProfinetStack.Controller.Services.ArConfiguration.

GetDifference()

virtual ArDifference Arp::Io::ProfinetStack::Controller::Services::IArConfigurationService::GetDifference ( uint16  arUserId )

pure virtual

Get difference in configuration for one AR

Parameters

arUserId

Contains ID for which the difference shall be received.

Returns

Difference in configuration of requested AR as Arp.Io.ProfinetStack.Controller.Services.ArConfiguration.

GetDifferences()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArConfigurationService::GetDifferences ( const std::vector< uint16 > &  arUserIds, GetDifferencesResultDelegate  resultDelegate  )

pure virtual

Get differences in configuration for multiple ARs

Parameters

arUserIds

Contains all user IDs for which the differences shall be received. If arUserIds is empty, all differences will be requested.

Returns

Differences in configuration of requested ARs as Arp.Io.ProfinetStack.Controller.Services.ArConfiguration.

---

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

• Arp/Io/ProfinetStack/Controller/Services/IArConfigurationService.hpp