PLCnext API Documentation  22.6.0.43
IAlarmService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
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 
14 namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
15 {
16 
17 using namespace Arp;
18 using namespace Arp::System::Rsc::Services;
19 
24 class IAlarmService : public IRscService
25 {
26 public: // typedefs
27  using Ptr = std::shared_ptr<IAlarmService>;
28 
29 public: // construction/destruction
31  IAlarmService(void) = default;
32 
33 public: // static policy operation
34  static IRscServiceProxyFactory& GetProxyFactory(void);
35 
36 public: // abstract operations
50  virtual uint32 ReceiveAlarm(uint32 id, AlarmInfo& alarmInfo) = 0;
51 
57  virtual void EnableAutoAlarmAcknowledge(boolean value) = 0;
58 };
59 
61 // inline methods of class IAlarmService
62 inline IRscServiceProxyFactory& IAlarmService::GetProxyFactory()
63 {
64  return AlarmServiceProxyFactory::GetInstance();
65 }
66 
67 }}}}} // 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:25
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:19
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API