PLCnext API Documentation 23.6.0.37
IAlarmService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/Io/ProfinetStack/Controller/Services/AlarmInfo.hpp"
9#include "Arp/Io/ProfinetStack/Controller/Services/AlarmServiceProxyFactory.hpp"
10#include "Arp/System/Rsc/Services/IRscService.hpp"
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IAlarmService.cs
13
14namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
15{
16
17using namespace Arp;
18using namespace Arp::System::Rsc::Services;
19
28{
29public: // typedefs
30 using Ptr = std::shared_ptr<IAlarmService>;
31
32public: // construction/destruction
34 IAlarmService(void) = default;
35
36public: // static policy operation
37 static IRscServiceProxyFactory& GetProxyFactory(void);
38
39public: // abstract operations
53 virtual uint32 ReceiveAlarm(uint32 id, AlarmInfo& alarmInfo) = 0;
54
60 virtual void EnableAutoAlarmAcknowledge(boolean value) = 0;
61};
62
64// inline methods of class IAlarmService
65inline IRscServiceProxyFactory& IAlarmService::GetProxyFactory()
66{
67 return AlarmServiceProxyFactory::GetInstance();
68}
69
70}}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
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:28
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.
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:36
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API