PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::System::Nm::INotificationManagerInfo Class Referenceabstract

Interface for information about the Notification Manager More...

#include <INotificationManagerInfo.hpp>

Inheritance diagram for Arp::System::Nm::INotificationManagerInfo:
Inheritance graph

Public Member Functions

virtual String GetNotificationName (NotificationNameIdType notificationNameId) const =0
 Queries the NotifictionName More...
 
virtual NotificationNameIdType GetNotificationNameId (const String &notificationName)=0
 Queries the id of an NotificationName More...
 
virtual NotificationNameIdList GetNotificationNameIdsByStatus (const NotificationRegistrationStatus &status) const =0
 Queries the ids of Notifications with a given NotificationRegistrationStatus More...
 
virtual NotificationNameIdList GetAllKnownNotificationNameIds () const =0
 Queries of all known NotificationNameIds More...
 
virtual NotificationRegistrationInfo GetNotificationRegistration (NotificationNameIdType notificationNameId) const =0
 Queries information about an Notification More...
 
virtual PayloadTypeIdType GetPayloadTypeId (const String &payloadTypeName)=0
 Query an id for a given PayloadType More...
 
virtual String GetPayloadTypeName (const PayloadTypeIdType &payloadTypeId) const =0
 Query the payload type name of a given id More...
 
virtual Arp::uint64 GetNumberOfSubmittedNotifications () const =0
 Returns the number of Notifications submitted since startup of the controller More...
 

Detailed Description

Interface for information about the Notification Manager

Member Function Documentation

◆ GetAllKnownNotificationNameIds()

virtual NotificationNameIdList Arp::System::Nm::INotificationManagerInfo::GetAllKnownNotificationNameIds ( ) const
pure virtual

Queries of all known NotificationNameIds

Returns
collection of all known NotificationNameIds

Implemented in Arp::System::Nm::NotificationManager.

◆ GetNotificationName()

virtual String Arp::System::Nm::INotificationManagerInfo::GetNotificationName ( NotificationNameIdType  notificationNameId) const
pure virtual

Queries the NotifictionName

Parameters
notificationNameIdNotificationNameId
Returns
NotificationName

Implemented in Arp::System::Nm::NotificationManager.

◆ GetNotificationNameId()

virtual NotificationNameIdType Arp::System::Nm::INotificationManagerInfo::GetNotificationNameId ( const String notificationName)
pure virtual

Queries the id of an NotificationName

Parameters
notificationNameNotificationName
Returns
NotificationNameId

Implemented in Arp::System::Nm::NotificationManager.

◆ GetNotificationNameIdsByStatus()

virtual NotificationNameIdList Arp::System::Nm::INotificationManagerInfo::GetNotificationNameIdsByStatus ( const NotificationRegistrationStatus status) const
pure virtual

Queries the ids of Notifications with a given NotificationRegistrationStatus

Parameters
statusstatus of the queried Notifications
Returns
collection of matching NotificationNameIds

Implemented in Arp::System::Nm::NotificationManager.

◆ GetNotificationRegistration()

virtual NotificationRegistrationInfo Arp::System::Nm::INotificationManagerInfo::GetNotificationRegistration ( NotificationNameIdType  notificationNameId) const
pure virtual

Queries information about an Notification

Parameters
notificationNameIdNotificationNameId
Returns
data structure to describe the Notification

Implemented in Arp::System::Nm::NotificationManager.

◆ GetNumberOfSubmittedNotifications()

virtual Arp::uint64 Arp::System::Nm::INotificationManagerInfo::GetNumberOfSubmittedNotifications ( ) const
pure virtual

Returns the number of Notifications submitted since startup of the controller

Returns
number of submitted notifications

Implemented in Arp::System::Nm::NotificationManager.

◆ GetPayloadTypeId()

virtual PayloadTypeIdType Arp::System::Nm::INotificationManagerInfo::GetPayloadTypeId ( const String payloadTypeName)
pure virtual

Query an id for a given PayloadType

Parameters
payloadTypeNameName fo the payload type
Returns
id of the payload type

Implemented in Arp::System::Nm::NotificationManager.

◆ GetPayloadTypeName()

virtual String Arp::System::Nm::INotificationManagerInfo::GetPayloadTypeName ( const PayloadTypeIdType payloadTypeId) const
pure virtual

Query the payload type name of a given id

Parameters
payloadTypeIdid of the payload type
Returns
name of the payload type

Implemented in Arp::System::Nm::NotificationManager.


The documentation for this class was generated from the following file: