PLCnext API Documentation 23.6.0.37
NotificationFilter.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/System/Rsc/Services/IRscSerializable.hpp"
9#include "Arp/System/Rsc/Services/RscReader.hpp"
10#include "Arp/System/Rsc/Services/RscString.hxx"
11#include "Arp/System/Rsc/Services/RscWriter.hpp"
12
13// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
14
15namespace Arp { namespace Services { namespace NotificationLogger { namespace Services
16{
17
18using namespace Arp;
19using namespace Arp::System::Rsc::Services;
20
25{
26public:
31
36
42
48
55
62
68
74
75 void Serialize(RscWriter& writer)const override
76 {
77 writer.Write(this->StoredIdLowerLimit);
78 writer.Write(this->StoredIdUpperLimit);
79 writer.Write(this->NotificationNameRegExp);
80 writer.Write(this->SenderNameRegExp);
81 writer.Write(this->TimestampBefore);
82 writer.Write(this->TimestampAfter);
83 writer.Write(this->SeverityLowerLimit);
84 writer.Write(this->SeverityUpperLimit);
85 }
86
87 void Deserialize(RscReader& reader)override
88 {
89 reader.Read(this->StoredIdLowerLimit);
90 reader.Read(this->StoredIdUpperLimit);
91 reader.Read(this->NotificationNameRegExp);
92 reader.Read(this->SenderNameRegExp);
93 reader.Read(this->TimestampBefore);
94 reader.Read(this->TimestampAfter);
95 reader.Read(this->SeverityLowerLimit);
96 reader.Read(this->SeverityUpperLimit);
97 }
98
99 static constexpr size_t GetFieldCount(void)
100 {
101 return 8;
102 }
103};
104
105}}}} // end of namespace Arp::Services::NotificationLogger::Services
Filter specification to match notification on query or delete
Definition: NotificationFilter.hpp:25
RscString< 512 > SeverityUpperLimit
Maximum matching Severity Ignored if empty
Definition: NotificationFilter.hpp:73
RscString< 512 > TimestampAfter
Matches all timestamps after this timestamp Format: YYYY-MM-ddTHH:mm:ss.SSS Ignored if empty
Definition: NotificationFilter.hpp:61
void Deserialize(RscReader &reader) override
Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.
Definition: NotificationFilter.hpp:87
uint64 StoredIdLowerLimit
Minimum matching Id (>= 0)
Definition: NotificationFilter.hpp:30
RscString< 512 > SenderNameRegExp
Regular expresssion to match the sender name Ignored if empty
Definition: NotificationFilter.hpp:47
uint64 StoredIdUpperLimit
Maximum matching Id (< 1^64)
Definition: NotificationFilter.hpp:35
RscString< 512 > SeverityLowerLimit
Minimum matching Severity Ignored if empty
Definition: NotificationFilter.hpp:67
void Serialize(RscWriter &writer) const override
Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.
Definition: NotificationFilter.hpp:75
RscString< 512 > TimestampBefore
Matches all timestamps before this timestamp Format: YYYY-MM-ddTHH:mm:ss.SSS Ignored if empty
Definition: NotificationFilter.hpp:54
RscString< 512 > NotificationNameRegExp
Regular expression to match the notification name Ignored if empty.
Definition: NotificationFilter.hpp:41
Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same...
Definition: IRscSerializable.hpp:20
Reads data from Rsc
Definition: RscReader.hpp:27
T Read(void)
Reads an element of T from Rsc. With data tagging enabled RscType of T is validated.
Definition: RscReader.hpp:166
Writes data to Rsc.
Definition: RscWriter.hpp:32
void Write(const T &value)
Writes an element of T from Rsc. Datatag and format is determined deducted by type of T.
Definition: RscWriter.hpp:178
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:40
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API