PLCnext API Documentation  20.6.0.30321
ITraceControllerService.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 "TraceControllerServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include <vector>
12 
13 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ITraceControllerService.cs
14 
15 namespace Arp { namespace Services { namespace TraceController { namespace Services
16 {
17 
18 using namespace Arp;
19 using namespace Arp::System::Rsc::Services;
20 
25 {
26 public: // typedefs
27  typedef std::shared_ptr<ITraceControllerService> Ptr;
28 
29 public: // construction/destruction
33  virtual ~ITraceControllerService(void);
34 
35 public: // static policy operation
36  static IRscServiceProxyFactory& GetProxyFactory(void);
37 
38 public: // abstract operations
43  virtual boolean IsSessionDaemonAlive() = 0;
44 
52  virtual boolean LoadSessionConfiguration(const RscString<512>& session, const RscString<512>& path) = 0;
53 
59  virtual std::vector<RscString<512>> ListSessions() = 0;
60 
67  virtual boolean StartSession(const RscString<512>& session) = 0;
68 
75  virtual boolean StopSession(const RscString<512>& session) = 0;
76 
83  virtual boolean DestroySession(const RscString<512>& session) = 0;
84 
93  virtual void LoadTracepointLib() = 0;
94 
103  virtual void UnloadTracepointLib() = 0;
104 
112  virtual boolean TriggerSavingTraceOutputs(boolean stopTriggerSession) = 0;
113 
120  virtual boolean IsSessionInSnapshotMode(const RscString<512>& session) = 0;
121 
128  virtual boolean IsSessionEnabled(const RscString<512>& session) = 0;
129 
136  virtual boolean IsSessionLoaded(const RscString<512>& session) = 0;
137 
138 private: // deleted methods (for non-copyable classes)
140  ITraceControllerService& operator=(const ITraceControllerService& arg) = delete;
141 };
142 
144 // inline methods of class ITraceControllerService
146 {
147 }
148 
150 {
151 }
152 
153 inline IRscServiceProxyFactory& ITraceControllerService::GetProxyFactory()
154 {
155  return TraceControllerServiceProxyFactory::GetInstance();
156 }
157 
158 }}}} // end of namespace Arp::Services::TraceController::Services
virtual ~ITraceControllerService(void)
Destructs this instance and frees all resouces.
Definition: ITraceControllerService.hpp:149
The TraceController provides an Interface to manage and control the LTTng Tracing on the Control ...
Definition: ITraceControllerService.hpp:24
Namespace for classes and interfaces for the Remote Service Call implementation
ITraceControllerService(void)
Constructs an ITraceControllerService instance.
Definition: ITraceControllerService.hpp:145
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18