PLCnext API Documentation 25.0.2.69
NotificationFilter.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/JRsc/Commons/JRsc.hpp"
10#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12
13// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
14
16{
17
18using namespace Arp;
19using namespace Arp::Base::Rsc::Commons;
20using namespace Arp::Base::Rsc::Commons::Services;
21using namespace Arp::Base::JRsc::Commons;
22
26class ARP_EXPORT NotificationFilter : public RscSerializable
27{
28public: // construction/destruction
30 NotificationFilter(uint64 storedIdLowerLimit, uint64 storedIdUpperLimit, const RscString<512>& notificationNameRegExp, const RscString<512>& senderNameRegExp, const RscString<512>& timestampBefore, const RscString<512>& timestampAfter, const RscString<512>& severityLowerLimit, const RscString<512>& severityUpperLimit);
31
32public: // Properties
36 uint64 StoredIdLowerLimit = 0;
37
41 uint64 StoredIdUpperLimit = 0;
42
48
54
61
68
74
80
81public: // Rsc operations
82 void Serialize(RscWriter& writer)const;
83 void Deserialize(RscReader& reader);
84 void Serialize(JRscWriter& writer)const;
85 void Deserialize(JRscReader& reader);
86 static size_t GetFieldCount(void);
87};
88
89} // end of namespace Arp::Services::NotificationLogger::Services
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34
Filter specification to match notification on query or delete
Definition: NotificationFilter.hpp:27
NotificationFilter(void)
Constructs an NotificationFilter instance.
RscString< 512 > SeverityUpperLimit
Maximum matching Severity Ignored if empty
Definition: NotificationFilter.hpp:79
RscString< 512 > TimestampAfter
Matches all timestamps after this timestamp Format: YYYY-MM-ddTHH:mm:ss.SSS Ignored if empty
Definition: NotificationFilter.hpp:67
RscString< 512 > SenderNameRegExp
Regular expresssion to match the sender name Ignored if empty
Definition: NotificationFilter.hpp:53
RscString< 512 > SeverityLowerLimit
Minimum matching Severity Ignored if empty
Definition: NotificationFilter.hpp:73
RscString< 512 > TimestampBefore
Matches all timestamps before this timestamp Format: YYYY-MM-ddTHH:mm:ss.SSS Ignored if empty
Definition: NotificationFilter.hpp:60
RscString< 512 > NotificationNameRegExp
Regular expression to match the notification name Ignored if empty.
Definition: NotificationFilter.hpp:47
std::uint64_t uint64
The Arp unsigned integer type of 8 byte size.
Definition: PrimitiveTypes.hpp:37
Namespace for the JSON RSC extension
Namespace for services of the NotificationLogger
Root namespace for the PLCnext API