Use this service to work receive PROFINET alarms More...

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

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

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

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

virtual uint32	ReceiveAlarm (uint32 id, AlarmInfo &alarmInfo)=0
	Receive a PROFINET alarm More...

virtual void	EnableAutoAlarmAcknowledge (boolean value)=0
	Change setting of automatic alarm acknowledge. 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 work receive PROFINET alarms

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 void Arp::Io::ProfinetStack::Controller::Services::IAlarmService::EnableAutoAlarmAcknowledge ( boolean value )

pure virtual

Change setting of automatic alarm acknowledge.

Parameters

value Set value = true to activate automatic alarm acknowledge and value = false to deactivate automatic alarm acknowledge.

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IAlarmService::ReceiveAlarm	(	uint32	id,
		AlarmInfo &	alarmInfo
	)

pure virtual

Receive a PROFINET alarm

Parameters

id	Node ID
alarmInfo	Structure with all alarm information Arp.Io.ProfinetStack.Controller.Services.AlarmInfo

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