PLCnext API Documentation 24.0.0.71
INotificationManagerService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include <vector>
9#include "Arp/System/Nm/Services/NotificationManagerServiceProxyFactory.hpp"
10#include "Arp/System/Nm/Services/NotificationRegistrationInfo.hpp"
11#include "Arp/System/Nm/Services/NotificationRegistrationStatus.hpp"
12#include "Arp/System/Nm/Services/Severity.hpp"
13#include "Arp/System/Rsc/Services/IRscService.hpp"
14#include "Arp/System/Rsc/Services/RscString.hxx"
15#include "Arp/System/Rsc/Services/RscVariant.hxx"
16
17// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INotificationManagerService.cs
18
19namespace Arp { namespace System { namespace Nm { namespace Services
20{
21
22using namespace Arp;
23using namespace Arp::System::Rsc::Services;
24
33{
34public: // typedefs
35 using Ptr = std::shared_ptr<INotificationManagerService>;
36
37public: // construction/destruction
40
41public: // static policy operation
42 static IRscServiceProxyFactory& GetProxyFactory(void);
43
44public: // abstract operations
53 virtual uint32 RegisterNotification(const RscString<512>& notificationName, const RscString<512>& senderName, Severity severity, const RscString<512>& payloadTypeName) = 0;
54
59 virtual void UnregisterNotification(uint32 notificationNameId) = 0;
60
68 virtual uint64 SendNotification(uint32 notificationNameId, DateTime timestamp, const std::vector<RscVariant<512>>& payload) = 0;
69
75 virtual RscString<512> GetNotificationName(uint32 notificationNameId) = 0;
76
82 virtual uint32 GetNotificationNameId(const RscString<512>& notificationName) = 0;
83
89 virtual std::vector<uint32> GetNotificationNameIdsByStatus(NotificationRegistrationStatus status) = 0;
90
95 virtual std::vector<uint32> GetAllKnownNotificationNameIds() = 0;
96
103
109 virtual uint16 GetPayloadTypeId(const RscString<512>& payloadTypeName) = 0;
110
116 virtual RscString<512> GetPayloadTypeName(uint16 payloadTypeId) = 0;
117
123};
124
126// inline methods of class INotificationManagerService
127inline IRscServiceProxyFactory& INotificationManagerService::GetProxyFactory()
128{
129 return NotificationManagerServiceProxyFactory::GetInstance();
130}
131
132}}}} // end of namespace Arp::System::Nm::Services
The class contains date and time informations.
Definition: DateTime.hpp:46
Information about the registration of a Notification
Definition: NotificationRegistrationInfo.hpp:22
Service to send Notifications and query information about the NotificationManager
Definition: INotificationManagerService.hpp:33
virtual void UnregisterNotification(uint32 notificationNameId)=0
Unregisters a Nototification
virtual NotificationRegistrationInfo GetNotificationRegistration(uint32 notificationNameId)=0
Queries information about an Notification
virtual uint64 SendNotification(uint32 notificationNameId, DateTime timestamp, const std::vector< RscVariant< 512 > > &payload)=0
Sends a notification
virtual std::vector< uint32 > GetAllKnownNotificationNameIds()=0
Queries of all known NotificationNameIds
virtual uint32 RegisterNotification(const RscString< 512 > &notificationName, const RscString< 512 > &senderName, Severity severity, const RscString< 512 > &payloadTypeName)=0
Registers a new Notification
virtual uint16 GetPayloadTypeId(const RscString< 512 > &payloadTypeName)=0
Query an id for a given PayloadType
virtual std::vector< uint32 > GetNotificationNameIdsByStatus(NotificationRegistrationStatus status)=0
Queries the ids of Notifications with a given NotificationRegistrationStatus
virtual uint32 GetNotificationNameId(const RscString< 512 > &notificationName)=0
Queries the id of an NotificationName
virtual RscString< 512 > GetNotificationName(uint32 notificationNameId)=0
Queries the NotifictionName
virtual RscString< 512 > GetPayloadTypeName(uint16 payloadTypeId)=0
Query the payload type name of a given id
INotificationManagerService(void)=default
Constructs an INotificationManagerService instance.
virtual uint64 GetNumberOfSubmittedNotifications()=0
Returns the number of Notifications submitted since startup of the controller
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:40
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:36
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:32
@ System
System components used by the System, Device, Plc or Io domains.
enum ARP_CXX_SYMBOL_EXPORT Severity
Enumeration of Severities for notifications
Definition: Severity.hpp:14
enum ARP_CXX_SYMBOL_EXPORT NotificationRegistrationStatus
Enumeration to represent the status of the Notification
Definition: NotificationRegistrationStatus.hpp:14
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API