|
PLCnext API Documentation
22.9.0.33
|
Information about the registration of a Notification More...
#include <NotificationRegistrationInfo.hpp>

Public Member Functions | |
| NotificationRegistrationInfo ()=default | |
| Used internally to create the object. | |
| NotificationRegistrationInfo (NotificationNameIdType notificationNameId, const String ¬ificationName) | |
| Used internally to create the object. | |
| NotificationRegistrationInfo (NotificationNameIdType notificationNameId, const String ¬ificationName, 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 More... | |
| const String | GetNotificationName () const |
| Returns the NotificationName More... | |
| const String | GetSenderName () const |
| Returns the sender name More... | |
| const Severity | GetSeverity () const |
| Returns the Severity More... | |
| const PayloadTypeIdType | GetPayloadTypeId () const |
| Returns the PayloadTypeId More... | |
| const NotificationRegistrationStatus | GetStatus () const |
| Returns the registration status More... | |
| bool | IsSubscribed () const |
| Returns true if the notification is subscribed More... | |
| bool | IsRegistered () const |
| Returns true is the notification is subscribed More... | |
| bool | IsUnRegistered () const |
| Returns true if the notification is unregistered More... | |
| void | SetStatusRegistered () |
| void | SetStatusUnregistered () |
Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable | |
| virtual | ~IRscSerializable ()=default |
| default destructor 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... | |
Information about the registration of a Notification
|
overridevirtual |
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
| reader | Reference to RscReader. |
Implements Arp::System::Rsc::Services::IRscSerializable.
| const String Arp::System::Nm::NotificationRegistrationInfo::GetNotificationName | ( | ) | const |
Returns the NotificationName
| const NotificationNameIdType Arp::System::Nm::NotificationRegistrationInfo::GetNotificationNameId | ( | ) | const |
Returns the NotificationNameId
| const PayloadTypeIdType Arp::System::Nm::NotificationRegistrationInfo::GetPayloadTypeId | ( | ) | const |
Returns the PayloadTypeId
| const String Arp::System::Nm::NotificationRegistrationInfo::GetSenderName | ( | ) | const |
Returns the sender name
| const Severity Arp::System::Nm::NotificationRegistrationInfo::GetSeverity | ( | ) | const |
Returns the Severity
| const NotificationRegistrationStatus Arp::System::Nm::NotificationRegistrationInfo::GetStatus | ( | ) | const |
Returns the registration status
| bool Arp::System::Nm::NotificationRegistrationInfo::IsRegistered | ( | ) | const |
Returns true is the notification is subscribed
| 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.
| bool Arp::System::Nm::NotificationRegistrationInfo::IsUnRegistered | ( | ) | const |
Returns true if the notification is unregistered
|
overridevirtual |
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
| writer | Reference to RscWriter |
Implements Arp::System::Rsc::Services::IRscSerializable.
| void Arp::System::Nm::NotificationRegistrationInfo::SetStatusRegistered | ( | ) |
Used internally to change the state of the object. Only copies are returned by the NotificationManager
| void Arp::System::Nm::NotificationRegistrationInfo::SetStatusUnregistered | ( | ) |
Used internally to change the state of the object. Only copies are returned by the NotificationManager