PLCnext API Documentation  20.0.0.24462
INotificationLoggerService.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 "NotificationLoggerServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include "Notification.hpp"
12 #include "NotificationFilter.hpp"
13 #include "SortOrder.hpp"
14 #include "StoredNotification.hpp"
15 #include <vector>
16 
17 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY INotificationLoggerService.cs
18 
19 namespace Arp { namespace Services { namespace NotificationLogger { namespace Services
20 {
21 
22 using namespace Arp;
23 using namespace Arp::System::Rsc::Services;
24 
29 {
30 public: // typedefs
31  typedef std::shared_ptr<INotificationLoggerService> Ptr;
32 
33 public: // construction/destruction
37  virtual ~INotificationLoggerService(void);
38 
39 public: // static policy operation
40  static IRscServiceProxyFactory& GetProxyFactory(void);
41 
42 public: // abstract operations
52  virtual std::vector<StoredNotification> QueryStoredNotifications(const std::vector<RscString<512>>& archives, const NotificationFilter& filter, int32 limit, SortOrder sortOrder, const RscString<512>& language) = 0;
53 
63  virtual std::vector<Notification> QueryNotifications(const std::vector<RscString<512>>& archives, const NotificationFilter& filter, int32 limit, SortOrder sortOrder, const RscString<512>& language) = 0;
64 
71  virtual int32 DeleteNotifications(const std::vector<RscString<512>>& archives, const NotificationFilter& filter) = 0;
72 
77  virtual std::vector<RscString<512>> ListArchives() = 0;
78 
84  virtual std::vector<RscString<512>> GetArchiveConfiguration(const RscString<512>& archive) = 0;
85 
92  virtual boolean SetArchiveConfiguration(const RscString<512>& archive, const std::vector<RscString<512>>& xmlConfiguration) = 0;
93 
99  virtual boolean ResetArchiveConfigurationToFiles(const RscString<512>& archive) = 0;
100 
101 private: // deleted methods (for non-copyable classes)
103  INotificationLoggerService& operator=(const INotificationLoggerService& arg) = delete;
104 };
105 
107 // inline methods of class INotificationLoggerService
109 {
110 }
111 
113 {
114 }
115 
116 inline IRscServiceProxyFactory& INotificationLoggerService::GetProxyFactory()
117 {
118  return NotificationLoggerServiceProxyFactory::GetInstance();
119 }
120 
121 }}}} // end of namespace Arp::Services::NotificationLogger::Services
INotificationLoggerService(void)
Constructs an INotificationLoggerService instance.
Definition: INotificationLoggerService.hpp:108
Namespace for classes and interfaces for the Remote Service Call implementation
virtual ~INotificationLoggerService(void)
Destructs this instance and frees all resouces.
Definition: INotificationLoggerService.hpp:112
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
Filter specification to match notification on query or delete
Definition: NotificationFilter.hpp:24
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:37
The NotificationLogger stores Notifications and provides an interface to retrieve them...
Definition: INotificationLoggerService.hpp:28