PLCnext API Documentation 25.0.2.69
INotificationManagerInfo.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6
7#pragma once
8
10#include "Arp/System/Nm/Notification.hpp"
11#include "Arp/System/Nm/NotificationManagerTypes.hpp"
12#include "Arp/System/Nm/NotificationRegistrationInfo.hpp"
13#include "Arp/System/Nm/NotificationRegistrationStatus.hpp"
14
15
16namespace Arp { namespace System { namespace Nm
17{
18
19
21class ARP_CXX_SYMBOL_EXPORT INotificationManagerInfo
22{
23public:
24 virtual ~INotificationManagerInfo() = default;
25
29 virtual String GetNotificationName(NotificationNameIdType notificationNameId) const = 0;
30
34 virtual NotificationNameIdType GetNotificationNameId(const String& notificationName) = 0;
35
41 const NotificationRegistrationStatus& status) const = 0;
42
46
51 NotificationNameIdType notificationNameId) const = 0;
52
56 virtual PayloadTypeIdType GetPayloadTypeId(const String& payloadTypeName) = 0;
57
61 virtual String GetPayloadTypeName(const PayloadTypeIdType& payloadTypeId) const = 0;
62
67};
68
69
70}}} // namespace Arp::System::Nm
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
Interface for information about the Notification Manager
Definition: INotificationManagerInfo.hpp:22
virtual Arp::uint64 GetNumberOfSubmittedNotifications() const =0
Returns the number of Notifications submitted since startup of the controller
virtual String GetPayloadTypeName(const PayloadTypeIdType &payloadTypeId) const =0
Query the payload type name of a given id
virtual NotificationNameIdList GetAllKnownNotificationNameIds() const =0
Queries of all known NotificationNameIds
virtual NotificationNameIdType GetNotificationNameId(const String &notificationName)=0
Queries the id of an NotificationName
virtual NotificationNameIdList GetNotificationNameIdsByStatus(const NotificationRegistrationStatus &status) const =0
Queries the ids of Notifications with a given NotificationRegistrationStatus
virtual PayloadTypeIdType GetPayloadTypeId(const String &payloadTypeName)=0
Query an id for a given PayloadType
virtual NotificationRegistrationInfo GetNotificationRegistration(NotificationNameIdType notificationNameId) const =0
Queries information about an Notification
virtual String GetNotificationName(NotificationNameIdType notificationNameId) const =0
Queries the NotifictionName
Information about the registration of a Notification
Definition: NotificationRegistrationInfo.hpp:21
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:37
enum ARP_CXX_SYMBOL_EXPORT NotificationRegistrationStatus
Enumeration to represent the status of the Notification
Definition: NotificationRegistrationStatus.hpp:14
std::vector< NotificationNameIdType > NotificationNameIdList
collection of Notification name ids
Definition: NotificationManagerTypes.hpp:23
Root namespace for the PLCnext API