PLCnext API Documentation  21.0.0.35466
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  typedef std::shared_ptr<IAlarmService> Ptr;
27 
28 public: // construction/destruction
30  IAlarmService(void);
32  virtual ~IAlarmService(void);
33 
34 public: // static policy operation
35  static IRscServiceProxyFactory& GetProxyFactory(void);
36 
37 public: // abstract operations
51  virtual uint32 ReceiveAlarm(uint32 id, AlarmInfo& alarmInfo) = 0;
52 
58  virtual void EnableAutoAlarmAcknowledge(boolean value) = 0;
59 
60 private: // deleted methods (for non-copyable classes)
61  IAlarmService(const IAlarmService& arg) = delete;
62  IAlarmService& operator=(const IAlarmService& arg) = delete;
63 };
64 
66 // inline methods of class IAlarmService
68 {
69 }
70 
72 {
73 }
74 
75 inline IRscServiceProxyFactory& IAlarmService::GetProxyFactory()
76 {
77  return AlarmServiceProxyFactory::GetInstance();
78 }
79 
80 }}}}} // 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
virtual ~IAlarmService(void)
Destructs this instance and frees all resouces.
Definition: IAlarmService.hpp:71
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
IAlarmService(void)
Constructs an IAlarmService instance.
Definition: IAlarmService.hpp:67