PLCnext API Documentation  21.9.0.40
INotificationManagerService.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 "NotificationManagerServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include "Arp/System/Rsc/Services/RscVariant.hxx"
12 #include "NotificationRegistrationInfo.hpp"
13 #include "NotificationRegistrationStatus.hpp"
14 #include "Severity.hpp"
15 #include <vector>
16 
17 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INotificationManagerService.cs
18 
19 namespace Arp { namespace System { namespace Nm { namespace Services
20 {
21 
22 using namespace Arp;
23 using namespace Arp::System::Rsc::Services;
24 
29 {
30 public: // typedefs
31  using Ptr = std::shared_ptr<INotificationManagerService>;
32 
33 public: // construction/destruction
35  INotificationManagerService(void) = default;
36 
37 public: // static policy operation
38  static IRscServiceProxyFactory& GetProxyFactory(void);
39 
40 public: // abstract operations
49  virtual uint32 RegisterNotification(const RscString<512>& notificationName, const RscString<512>& senderName, Severity severity, const RscString<512>& payloadTypeName) = 0;
50 
55  virtual void UnregisterNotification(uint32 notificationNameId) = 0;
56 
64  virtual uint64 SendNotification(uint32 notificationNameId, DateTime timestamp, const std::vector<RscVariant<512>>& payload) = 0;
65 
71  virtual RscString<512> GetNotificationName(uint32 notificationNameId) = 0;
72 
78  virtual uint32 GetNotificationNameId(const RscString<512>& notificationName) = 0;
79 
85  virtual std::vector<uint32> GetNotificationNameIdsByStatus(NotificationRegistrationStatus status) = 0;
86 
91  virtual std::vector<uint32> GetAllKnownNotificationNameIds() = 0;
92 
98  virtual NotificationRegistrationInfo GetNotificationRegistration(uint32 notificationNameId) = 0;
99 
105  virtual uint16 GetPayloadTypeId(const RscString<512>& payloadTypeName) = 0;
106 
112  virtual RscString<512> GetPayloadTypeName(uint16 payloadTypeId) = 0;
113 
118  virtual uint64 GetNumberOfSubmittedNotifications() = 0;
119 };
120 
122 // inline methods of class INotificationManagerService
123 inline IRscServiceProxyFactory& INotificationManagerService::GetProxyFactory()
124 {
125  return NotificationManagerServiceProxyFactory::GetInstance();
126 }
127 
128 }}}} // end of namespace Arp::System::Nm::Services
Service to send Notifications and query information about the NotificationManager ...
Definition: INotificationManagerService.hpp:28
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
The class contains date and time informations.
Definition: DateTime.hpp:44
NotificationRegistrationStatus
Enumeration to represent the status of the Notification
Definition: NotificationRegistrationStatus.hpp:16
Severity
Enumeration of Severities for notifications
Definition: Severity.hpp:15
Root namespace for the PLCnext API
Information about the registration of a Notification
Definition: NotificationRegistrationInfo.hpp:21
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:39
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
System components used by the System, Device, Plc or Io domains.