PLCnext API Documentation
20.0.0.24462
|
Contains meta data and paylod of a Notification More...
#include <Notification.hpp>
Public Member Functions | |
Notification ()=default | |
Creates an empty Notification More... | |
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 More... | |
NotificationNameIdType | GetNotificationNameId () const |
Returns the NotificationNameId More... | |
DateTime | GetTimestamp () const |
Returns the timestamp More... | |
Severity | GetSeverity () const |
Returns the Severity More... | |
PayloadTypeIdType | GetPayloadTypeId () const |
Returns the PayloadTypeId More... | |
const RawPayloadType & | GetPayload () const |
Returns a reference to the raw payload More... | |
template<typename PayloadType > | |
const PayloadType | GetPayloadAs () const |
Returns a view to the Payload using the defined PayloadType More... | |
![]() | |
virtual | ~IRscSerializable ()=default |
default destructor More... | |
Static Public Member Functions | |
static size_t | GetFieldCount (void) |
![]() | |
static size_t | GetFieldCount (void) |
Returns the count of fields of the struct type More... | |
Contains meta data and paylod of a Notification
|
default |
Creates an empty 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.
NotificationIdType Arp::System::Nm::Notification::GetId | ( | ) | const |
Returns the id
NotificationNameIdType Arp::System::Nm::Notification::GetNotificationNameId | ( | ) | const |
Returns the NotificationNameId
const RawPayloadType& Arp::System::Nm::Notification::GetPayload | ( | ) | const |
Returns a reference to the raw payload
|
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.
PayloadTypeIdType Arp::System::Nm::Notification::GetPayloadTypeId | ( | ) | const |
Returns the PayloadTypeId
Severity Arp::System::Nm::Notification::GetSeverity | ( | ) | const |
Returns the Severity
DateTime Arp::System::Nm::Notification::GetTimestamp | ( | ) | const |
Returns the timestamp
|
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.