PLCnext API Documentation 25.0.2.69
IAlarmService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Io/ProfinetStack/Controller/Services/AlarmInfo.hpp"
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IAlarmService.cs
13
15{
16
17using namespace Arp::Base::Rsc::Commons;
18
26class ARP_EXPORT IAlarmService : public IRscService
27{
28public: // usings
29 using Ptr = std::shared_ptr<IAlarmService>;
30
31public: // construction/destruction
33 IAlarmService(void) = default;
34
35public: // static policy operation
36 static IRscServiceProxyFactory& GetProxyFactory(void);
37
38public: // abstract operations
51 virtual uint32 ReceiveAlarm(uint32 id, AlarmInfo& alarmInfo) = 0;
52
58 virtual void EnableAutoAlarmAcknowledge(boolean value) = 0;
59};
60
61} // end of namespace Arp::Io::ProfinetStack::Controller::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This structure contains all information about a received alarm. For more information read the PROFINE...
Definition: AlarmInfo.hpp:26
Use this service to work receive PROFINET alarms
Definition: IAlarmService.hpp:27
virtual uint32 ReceiveAlarm(uint32 id, AlarmInfo &alarmInfo)=0
Receive a PROFINET alarm
IAlarmService(void)=default
Constructs an IAlarmService instance.
virtual void EnableAutoAlarmAcknowledge(boolean value)=0
Change setting of automatic alarm acknowledge.
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
Namespace for Profinet I/O controller services