Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
mmind::eye::ProfilerEvent Class Reference

Describes the event of profiler. Use ProfilerEvent::registerProfilerEventCallback to register an event of interest. More...

#include <ProfilerEvent.h>

Public Types

enum  Event { PROFILER_EVENT_DISCONNECTED = 0x0001 , PROFILER_EVENT_ALL = 0xFFFF }
 Describes the types of Event. More...
 
using EventCallback = std::function<void(Event event, void* pUser)>
 

Static Public Member Functions

static ErrorStatus registerProfilerEventCallback (Profiler &profiler, EventCallback callback, void *pUser, unsigned int events)
 Registers a profiler event of interest.
 

Detailed Description

Describes the event of profiler. Use ProfilerEvent::registerProfilerEventCallback to register an event of interest.

Definition at line 48 of file ProfilerEvent.h.

Member Typedef Documentation

◆ EventCallback

using mmind::eye::ProfilerEvent::EventCallback = std::function<void(Event event, void* pUser)>

Definition at line 59 of file ProfilerEvent.h.

Member Enumeration Documentation

◆ Event

Describes the types of Event.

Definition at line 54 of file ProfilerEvent.h.

Member Function Documentation

◆ registerProfilerEventCallback()

static ErrorStatus mmind::eye::ProfilerEvent::registerProfilerEventCallback ( Profiler & profiler,
EventCallback callback,
void * pUser,
unsigned int events )
static

Registers a profiler event of interest.

Parameters
[in]profilerThe profiler handle.
[in]callbackThe callback function for responding to profiler events.
[in]pUserPointer used by the user.
[in]eventsThe profiler event. See ProfilerEvent::Event for details.
Returns
ErrorStatus::MMIND_STATUS_SUCCESS Success.
ErrorStatus::MMIND_STATUS_INVALID_DEVICE Invalid profiler handle.
ErrorStatus::MMIND_STATUS_DEVICE_OFFLINE Profiler disconnected.
ErrorStatus::MMIND_STATUS_NO_SUPPORT_ERROR Not supported profiler model or firmware version.

The documentation for this class was generated from the following file: