Mech-Eye API 2.4.0
API reference documentation for Mech-Eye 3D Laser Profiler
Loading...
Searching...
No Matches
VirtualProfiler.h
1#pragma once
2#include <memory>
3#include <functional>
4#include "api_global.h"
5#include "ProfilerInfo.h"
6#include "ProfileData.h"
7#include "VirtualUserSet.h"
8
9namespace mmind {
10
11namespace eye {
12
13class VirtualProfilerImpl;
14
15class MMIND_API_EXPORT VirtualProfiler
16{
17public:
24 using AcquisitionCallback = std::function<void(const ProfileBatch& batch, void* pUser)>;
25
33 VirtualProfiler(const std::string& filePath);
34
39
43 VirtualProfiler(const VirtualProfiler& other) noexcept;
44
48 VirtualProfiler& operator=(const VirtualProfiler& other) noexcept;
49
58
67
80
99 void* pUser);
100
108
117
118private:
119 std::shared_ptr<VirtualProfilerImpl> _d;
120};
121
122} // namespace eye
123
124} // namespace mmind
Represents a batch of profiles, which can be obtained by calling Profiler::retrieveBatchData()....
Definition ProfileData.h:30
VirtualUserSet & currentUserSet()
Gets the parameter information used when the virtual device was saved.
ErrorStatus getProfilerInfo(ProfilerInfo &info) const
Gets the basic information of the virtual laser profiler, such as model, serial number,...
VirtualProfiler(const std::string &filePath)
Constructor.
std::function< void(const ProfileBatch &batch, void *pUser)> AcquisitionCallback
The type of callback function.
VirtualProfiler(const VirtualProfiler &other) noexcept
Copy constructor.
ErrorStatus startAcquisition()
Enters the virtual device into the acquisition ready status, where it can accept trigger signals for ...
ErrorStatus retrieveBatchData(ProfileBatch &batch) const
Retrieves a batch of the profiles. There are two ways to retrieve profile data, by polling or callbac...
ErrorStatus registerAcquisitionCallback(const VirtualProfiler::AcquisitionCallback &func, void *pUser)
Registers the callback function for data acquisition. There are two ways to retrieve profile data,...
VirtualProfiler & operator=(const VirtualProfiler &other) noexcept
Copy assignment.
ErrorStatus stopAcquisition()
Exits the virtual profiler from the acquisition ready status to avoid accidental triggering of scanni...
Describes the types of errors.
Definition ErrorStatus.h:12
Describes the laser profiler information.