PLCnext API Documentation 23.0.2.9
INotificationManagerInfo.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6
7#pragma once
8
9#include "Arp/System/Nm/Notification.hpp"
10#include "Arp/System/Nm/NotificationManagerTypes.hpp"
11#include "Arp/System/Nm/NotificationRegistrationInfo.hpp"
12#include "Arp/System/Nm/NotificationRegistrationStatus.hpp"
13
14
15namespace Arp { namespace System { namespace Nm
16{
17
18
21{
22public:
23 virtual ~INotificationManagerInfo() = default;
24
28 virtual const String GetNotificationName(NotificationNameIdType notificationNameId) const = 0;
29
33 virtual const NotificationNameIdType GetNotificationNameId(const String& notificationName) = 0;
34
40 const NotificationRegistrationStatus& status) const = 0;
41
45
50 NotificationNameIdType notificationNameId) const = 0;
51
55 virtual const PayloadTypeIdType GetPayloadTypeId(const String& payloadTypeName) = 0;
56
60 virtual const String GetPayloadTypeName(const PayloadTypeIdType& payloadTypeId) const = 0;
61
66};
67
68
69}}} // namespace Arp::System::Nm
Interface for information about the Notification Manager
Definition: INotificationManagerInfo.hpp:21
virtual const NotificationRegistrationInfo GetNotificationRegistration(NotificationNameIdType notificationNameId) const =0
Queries information about an Notification
virtual Arp::uint64 GetNumberOfSubmittedNotifications() const =0
Returns the number of Notifications submitted since startup of the controller
virtual const NotificationNameIdType GetNotificationNameId(const String &notificationName)=0
Queries the id of an NotificationName
virtual const PayloadTypeIdType GetPayloadTypeId(const String &payloadTypeName)=0
Query an id for a given PayloadType
virtual const NotificationNameIdList GetAllKnownNotificationNameIds() const =0
Queries of all known NotificationNameIds
virtual const String GetPayloadTypeName(const PayloadTypeIdType &payloadTypeId) const =0
Query the payload type name of a given id
virtual const NotificationNameIdList GetNotificationNameIdsByStatus(const NotificationRegistrationStatus &status) const =0
Queries the ids of Notifications with a given NotificationRegistrationStatus
virtual const String GetNotificationName(NotificationNameIdType notificationNameId) const =0
Queries the NotifictionName
Information about the registration of a Notification
Definition: NotificationRegistrationInfo.hpp:22
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:39
@ System
System components used by the System, Device, Plc or Io domains.
std::vector< NotificationNameIdType > NotificationNameIdList
collection of Notification name ids
Definition: NotificationManagerTypes.hpp:25
NotificationRegistrationStatus
Enumeration to represent the status of the Notification
Definition: NotificationRegistrationStatus.hpp:15
Root namespace for the PLCnext API