PLCnext API Documentation  22.0.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/System/Rsc/Services/IRscService.hpp"
9 #include "AlarmServiceProxyFactory.hpp"
10 #include "AlarmInfo.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 
23 class IAlarmService : public IRscService
24 {
25 public: // typedefs
26  using Ptr = std::shared_ptr<IAlarmService>;
27 
28 public: // construction/destruction
30  IAlarmService(void) = default;
31 
32 public: // static policy operation
33  static IRscServiceProxyFactory& GetProxyFactory(void);
34 
35 public: // abstract operations
49  virtual uint32 ReceiveAlarm(uint32 id, AlarmInfo& alarmInfo) = 0;
50 
56  virtual void EnableAutoAlarmAcknowledge(boolean value) = 0;
57 };
58 
60 // inline methods of class IAlarmService
61 inline IRscServiceProxyFactory& IAlarmService::GetProxyFactory()
62 {
63  return AlarmServiceProxyFactory::GetInstance();
64 }
65 
66 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
This structure contains all information about a received alarm. For more information read the PROFINE...
Definition: AlarmInfo.hpp:25
Use this service to work receive PROFINET alarms
Definition: IAlarmService.hpp:23
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18