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

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

#include <IAlarmService.hpp>

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

Public Types
using	Ptr = std::shared_ptr< IAlarmService >
Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	IAlarmService (void)=default
	Constructs an IAlarmService instance. More...
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::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 work receive PROFINET alarms

Constructor & Destructor Documentation

IAlarmService()

Arp::Io::ProfinetStack::Controller::Services::IAlarmService::IAlarmService ( void  )

default

Constructs an IAlarmService instance.

Member Function Documentation

EnableAutoAlarmAcknowledge()

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.

ReceiveAlarm()

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

Returns

Status of service

ToDo

ToDo

---

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

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