PLCnext API Documentation 23.6.0.37
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 ()=default
 Used internally to create the object.
 
 NotificationRegistrationInfo (NotificationNameIdType notificationNameId, const String &notificationName)
 Used internally to create the object.
 
 NotificationRegistrationInfo (NotificationNameIdType notificationNameId, const String &notificationName, const String &senderName, Severity severity, PayloadTypeIdType payloadTypeId, NotificationRegistrationStatus initialStatus)
 Used internally to create the object.
 
void Serialize (Arp::System::Rsc::Services::RscWriter &writer) const override
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (Arp::System::Rsc::Services::RscReader &reader) override
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
const NotificationNameIdType GetNotificationNameId () const
 Returns the NotificationNameId
 
const String GetNotificationName () const
 Returns the NotificationName
 
const String GetSenderName () const
 Returns the sender name
 
const Severity GetSeverity () const
 Returns the Severity
 
const PayloadTypeIdType GetPayloadTypeId () const
 Returns the PayloadTypeId
 
const 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::System::Rsc::Services::IRscSerializable
virtual ~IRscSerializable ()=default
 default destructor
 
virtual void Serialize (RscWriter &writer) const =0
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
virtual void Deserialize (RscReader &reader)=0
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 

Static Public Member Functions

static size_t GetFieldCount (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t GetFieldCount (void)
 Returns the count of fields of the struct type More...
 

Detailed Description

Information about the registration of a Notification

Member Function Documentation

◆ Deserialize()

void Arp::System::Nm::NotificationRegistrationInfo::Deserialize ( Arp::System::Rsc::Services::RscReader reader)
overridevirtual

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ 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.

◆ Serialize()

void Arp::System::Nm::NotificationRegistrationInfo::Serialize ( Arp::System::Rsc::Services::RscWriter writer) const
overridevirtual

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ 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 file: