|
PLCnext API Documentation 23.0.2.9
|
Contains meta data and paylod of a Notification More...
#include <Notification.hpp>

Public Member Functions | |
| Notification ()=default | |
| Creates an empty Notification | |
| Notification (NotificationIdType id, NotificationNameIdType notificationNameId, const DateTime ×tamp, Severity severity, PayloadTypeIdType payloadTypeId, const RawPayloadType &payload) | |
| Constructor with all data More... | |
| 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... | |
| NotificationIdType | GetId () const |
| Returns the id | |
| NotificationNameIdType | GetNotificationNameId () const |
| Returns the NotificationNameId | |
| DateTime | GetTimestamp () const |
| Returns the timestamp | |
| Severity | GetSeverity () const |
| Returns the Severity | |
| PayloadTypeIdType | GetPayloadTypeId () const |
| Returns the PayloadTypeId | |
| const RawPayloadType & | GetPayload () const |
| Returns a reference to the raw payload | |
| template<typename PayloadType > | |
| const PayloadType | GetPayloadAs () const |
| Returns a view to the Payload using the defined PayloadType More... | |
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... | |
Contains meta data and paylod of a Notification
| Arp::System::Nm::Notification::Notification | ( | NotificationIdType | id, |
| NotificationNameIdType | notificationNameId, | ||
| const DateTime & | timestamp, | ||
| Severity | severity, | ||
| PayloadTypeIdType | payloadTypeId, | ||
| const RawPayloadType & | payload | ||
| ) |
Constructor with all data
This function is used internally
|
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.
|
inline |
Returns a view to the Payload using the defined PayloadType
Throws an exception if the PayloadType does not match the PayloadTypeId of the Notification.
|
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.