PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Nm::NotificationRegistrationInfo Class Reference

Information about the registration of a Notification More...

#include <NotificationRegistrationInfo.hpp>

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

Public Member Functions

 NotificationRegistrationInfo (NotificationNameIdType notificationNameId, const String &notificationName)
 
 NotificationRegistrationInfo (NotificationNameIdType notificationNameId, const String &notificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId, NotificationRegistrationStatus initialStatus)
 
void Serialize (Arp::Base::Rsc::Commons::Services::RscWriter &writer) const
 
void Deserialize (Arp::Base::Rsc::Commons::Services::RscReader &reader)
 
NotificationNameIdType GetNotificationNameId () const
 Returns the NotificationNameId
 
String GetNotificationName () const
 Returns the NotificationName
 
String GetSenderName () const
 Returns the sender name
 
Severity GetSeverity () const
 Returns the Severity
 
PayloadTypeIdType GetPayloadTypeId () const
 Returns the PayloadTypeId
 
NotificationRegistrationStatus GetStatus () const
 Returns the registration status
 
bool IsSubscribed () const
 Returns true if the notification is subscribed More...
 
bool IsRegistered () const
 Returns true is the notification is subscribed
 
bool IsUnRegistered () const
 Returns true if the notification is unregistered
 
void SetStatusRegistered ()
 
void SetStatusUnregistered ()
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 

Detailed Description

Information about the registration of a Notification

Member Function Documentation

◆ IsSubscribed()

bool Arp::System::Nm::NotificationRegistrationInfo::IsSubscribed ( ) const

Returns true if the notification is subscribed

This means someone subscribed to this Notification but it was never registered.

◆ SetStatusRegistered()

void Arp::System::Nm::NotificationRegistrationInfo::SetStatusRegistered ( )

Used internally to change the state of the object. Only copies are returned by the NotificationManager

◆ SetStatusUnregistered()

void Arp::System::Nm::NotificationRegistrationInfo::SetStatusUnregistered ( )

Used internally to change the state of the object. Only copies are returned by the NotificationManager


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