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

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

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

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

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

virtual uint32	GetArState (const RscString< 512 > &stationName, uint32 &arState)=0

virtual uint32	StartAr (const RscString< 512 > &stationName, uint32 &arState)=0

virtual uint32	StopAr (const RscString< 512 > &stationName, uint32 &arState)=0

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

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArManagementService::GetArState	(	const RscString< 512 > &	stationName,
		uint32 &	arState
	)

pure virtual

Parameters

stationName	Station name of the device
arState	Current state of the AR

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArManagementService::StartAr	(	const RscString< 512 > &	stationName,
		uint32 &	arState
	)

pure virtual

Parameters

stationName	Station name of the device
arState	State of the AR

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArManagementService::StopAr	(	const RscString< 512 > &	stationName,
		uint32 &	arState
	)

pure virtual

Parameters

stationName	Station name of the device
arState	State of the AR

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