PLCnext API Documentation  22.3.0.20
INotificationLoggerService2.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "NotificationLoggerService2ProxyFactory.hpp"
10 #include "Arp/System/Core/delegate.hxx"
11 #include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
12 #include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
13 #include "Arp/System/Rsc/Services/RscString.hxx"
14 #include "NotificationFilter2.hpp"
15 #include "SortOrder.hpp"
16 #include "StoredNotification2.hpp"
17 #include <vector>
18 
19 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INotificationLoggerService2.cs
20 
21 namespace Arp { namespace Services { namespace NotificationLogger { namespace Services
22 {
23 
24 using namespace Arp;
25 using namespace Arp::System::Rsc::Services;
26 
31 {
32 public: // typedefs
33  using Ptr = std::shared_ptr<INotificationLoggerService2>;
34  using ReadStoredNotificationsResultDelegate = delegate<void(IRscReadEnumerator<StoredNotification2>&)>;
35 
36 public: // construction/destruction
38  INotificationLoggerService2(void) = default;
39 
40 public: // static policy operation
41  static IRscServiceProxyFactory& GetProxyFactory(void);
42 
43 public: // abstract operations
54  virtual void ReadStoredNotifications(const std::vector<RscString<64>>& archives, const NotificationFilter2& filter, int32 limit, SortOrder sortOrder, boolean includePayloadXml, ReadStoredNotificationsResultDelegate resultDelegate) = 0;
55 
62  virtual int32 DeleteNotifications(const std::vector<RscString<64>>& archives, const NotificationFilter2& filter) = 0;
63 
69  virtual std::vector<RscString<64>> GetArchiveNames() = 0;
70 };
71 
73 // inline methods of class INotificationLoggerService2
74 inline IRscServiceProxyFactory& INotificationLoggerService2::GetProxyFactory()
75 {
76  return NotificationLoggerService2ProxyFactory::GetInstance();
77 }
78 
79 }}}} // end of namespace Arp::Services::NotificationLogger::Services
Filter specification to match notification on query or delete
Definition: NotificationFilter2.hpp:24
The NotificationLogger stores Notifications and provides an interface to retrieve them...
Definition: INotificationLoggerService2.hpp:30
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
SortOrder
Definition how to sort the queried notifications
Definition: SortOrder.hpp:20
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:37
Contains a static string with string lentgh up to N characters. The string has to be null terminated...
Definition: RscString.hxx:18