IDS peak genericC++  v1.4.0
peak_event_controller.hpp
Go to the documentation of this file.
1 
11 #pragma once
12 
13 
17 #include <peak/dll_interface/peak_dll_interface_util.hpp>
19 
20 #include <cstddef>
21 #include <cstdint>
22 #include <memory>
23 
24 
25 namespace peak
26 {
27 namespace core
28 {
29 
38 {
39 public:
40  EventController() = delete;
42  EventController(const EventController& other) = delete;
43  EventController& operator=(const EventController& other) = delete;
44  EventController(EventController&& other) = delete;
45  EventController& operator=(EventController&& other) = delete;
46 
48  RawInformation Info(int32_t infoCommand) const;
58  size_t NumEventsInQueue() const;
68  uint64_t NumEventsFired() const;
78  size_t EventMaxSize() const;
88  size_t EventDataMaxSize() const;
89 
105  std::unique_ptr<Event> WaitForEvent(Timeout timeout_ms);
113  void KillWait();
121  void FlushEvents();
122 
131 
132 private:
133  friend ClassCreator<EventController>;
134  explicit EventController(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle);
135  PEAK_EVENT_CONTROLLER_HANDLE m_backendHandle;
136 };
137 
138 } /* namespace core */
139 } /* namespace peak */
140 
141 /* Implementation */
142 namespace peak
143 {
144 namespace core
145 {
146 
148  : m_backendHandle(eventControllerHandle)
149 {}
150 
152 {
153  (void)PEAK_C_ABI_PREFIX PEAK_EventController_Destruct(m_backendHandle);
154 }
155 
156 inline RawInformation EventController::Info(int32_t infoCommand) const
157 {
158  return QueryRawInformationFromCInterfaceFunction([&](int32_t* dataType, uint8_t* buffer, size_t* bufferSize) {
160  m_backendHandle, infoCommand, dataType, buffer, bufferSize);
161  });
162 }
163 
165 {
166  return QueryNumericFromCInterfaceFunction<size_t>([&](size_t* numEventsInQueue) {
167  return PEAK_C_ABI_PREFIX PEAK_EventController_GetNumEventsInQueue(m_backendHandle, numEventsInQueue);
168  });
169 }
170 
171 inline uint64_t EventController::NumEventsFired() const
172 {
173  return QueryNumericFromCInterfaceFunction<uint64_t>([&](uint64_t* numEventsFired) {
174  return PEAK_C_ABI_PREFIX PEAK_EventController_GetNumEventsFired(m_backendHandle, numEventsFired);
175  });
176 }
177 
178 inline size_t EventController::EventMaxSize() const
179 {
180  return QueryNumericFromCInterfaceFunction<size_t>([&](size_t* eventMaxSize) {
181  return PEAK_C_ABI_PREFIX PEAK_EventController_GetEventMaxSize(m_backendHandle, eventMaxSize);
182  });
183 }
184 
186 {
187  return QueryNumericFromCInterfaceFunction<size_t>([&](size_t* eventDataMaxSize) {
188  return PEAK_C_ABI_PREFIX PEAK_EventController_GetEventDataMaxSize(m_backendHandle, eventDataMaxSize);
189  });
190 }
191 
192 inline std::unique_ptr<Event> EventController::WaitForEvent(Timeout timeout_ms)
193 {
194  auto eventHandle = QueryNumericFromCInterfaceFunction<PEAK_EVENT_HANDLE>(
195  [&](PEAK_EVENT_HANDLE* _eventHandle) {
196  return PEAK_C_ABI_PREFIX PEAK_EventController_WaitForEvent(m_backendHandle, timeout_ms, _eventHandle);
197  });
198 
199  return std::make_unique<ClassCreator<Event>>(eventHandle);
200 }
201 
203 {
204  CallAndCheckCInterfaceFunction(
205  [&] { return PEAK_C_ABI_PREFIX PEAK_EventController_KillWait(m_backendHandle); });
206 }
207 
209 {
210  CallAndCheckCInterfaceFunction(
211  [&] { return PEAK_C_ABI_PREFIX PEAK_EventController_FlushEvents(m_backendHandle); });
212 }
213 
215 {
216  return static_cast<EventType>(
217  QueryNumericFromCInterfaceFunction<PEAK_EVENT_TYPE>([&](PEAK_EVENT_TYPE* controlledEventType) {
219  m_backendHandle, controlledEventType);
220  }));
221 }
222 
223 } /* namespace core */
224 } /* namespace peak */
PEAK_C_API PEAK_EventController_WaitForEvent(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t timeout_ms, PEAK_EVENT_HANDLE *eventHandle)
Tells the given event controller to wait for an event with the given timeout.
EventType
Different types of events.
Definition: peak_event.hpp:34
The "peak" namespace directly contains convenience functionality like the DeviceManager as well as th...
Definition: peak_dynamic_loader.h:32
PEAK_C_API PEAK_EventController_GetEventMaxSize(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *eventMaxSize)
Asks the event controller for the maximum size of an event.
std::unique_ptr< Event > WaitForEvent(Timeout timeout_ms)
Blocking wait for an event.
Definition: peak_event_controller.hpp:192
RawInformation Info(int32_t infoCommand) const
Delivers information based on the given GenTL info command.
Definition: peak_event_controller.hpp:156
struct PEAK_EVENT_CONTROLLER * PEAK_EVENT_CONTROLLER_HANDLE
Definition: peak_backend.h:461
Encapsulates the GenTL event functionality associated with one GenTL Event handle.
Definition: peak_event_controller.hpp:37
PEAK_C_API PEAK_EventController_FlushEvents(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Tells the given event controller to flush all events in queue.
int32_t PEAK_EVENT_TYPE
Definition: peak_backend.h:168
PEAK_C_API PEAK_EventController_GetInfo(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given event controller for an information based on a specific command.
void KillWait()
Terminates a wait for an event.
Definition: peak_event_controller.hpp:202
struct PEAK_EVENT * PEAK_EVENT_HANDLE
Definition: peak_backend.h:465
PEAK_C_API PEAK_EventController_Destruct(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Destroys the given event controller.
Represents a timeout value in milliseconds.
Definition: peak_timeout.hpp:30
size_t EventDataMaxSize() const
Returns the maximum size of the data of an event in bytes.
Definition: peak_event_controller.hpp:185
void FlushEvents()
Discards all events in queue.
Definition: peak_event_controller.hpp:208
PEAK_C_API PEAK_EventController_GetEventDataMaxSize(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *eventDataMaxSize)
Asks the event controller for the maximum size of an event&#39;s data.
size_t EventMaxSize() const
Returns the maximum size of an event in bytes.
Definition: peak_event_controller.hpp:178
#define PEAK_C_ABI_PREFIX
Definition: peak_dll_defines.h:16
PEAK_C_API PEAK_EventController_GetNumEventsInQueue(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *numEventsInQueue)
Asks the event controller for its number of events in queue.
uint64_t NumEventsFired() const
Returns the number of fired events.
Definition: peak_event_controller.hpp:171
size_t NumEventsInQueue() const
Returns the number of events in queue.
Definition: peak_event_controller.hpp:164
The struct returned by all raw information functions.
Definition: peak_common_structs.hpp:24
PEAK_C_API PEAK_EventController_GetNumEventsFired(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t *numEventsFired)
Asks the event controller for its number of fired events.
EventType ControlledEventType() const
Returns the controlled event type.
Definition: peak_event_controller.hpp:214
PEAK_C_API PEAK_EventController_GetControlledEventType(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, PEAK_EVENT_TYPE *controlledEventType)
Asks the event controller for its controlled event type.
EventController & operator=(const EventController &other)=delete
~EventController()
Definition: peak_event_controller.hpp:151
PEAK_C_API PEAK_EventController_KillWait(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Tells the given event controller to kill a wait for an event.