![]() |
Mech-Eye API Reference 2.1.4-alpha
API reference documentation for Mech-Eye 3D Laser Profiler
|
Represents a Mech-Eye 3D Laser Profiler device. More...
#include <Profiler.h>
Public Types | |
using | AcquisitionCallback = std::function< void(const ProfileBatch &batch, void *pUser)> |
Public Member Functions | |
MMIND_API_EXPORT | Profiler () |
Constructor. | |
MMIND_API_EXPORT | ~Profiler () |
Destructor. | |
MMIND_API_EXPORT | Profiler (const Profiler &other) noexcept |
Copy constructor. | |
MMIND_API_EXPORT Profiler & | operator= (const Profiler &other) noexcept |
Copy assignment. | |
MMIND_API_EXPORT ErrorStatus | connect (const ProfilerInfo &info, unsigned int timeoutMs=5000) |
Connects to a laser profiler by its information. | |
MMIND_API_EXPORT ErrorStatus | connect (const std::string &ipAddress, unsigned int timeoutMs=5000) |
Connects to a laser profiler by its IP address. | |
MMIND_API_EXPORT ErrorStatus | disconnect () |
Disconnects from the current laser profiler. | |
MMIND_API_EXPORT ErrorStatus | getProfilerInfo (ProfilerInfo &info) const |
Gets profiler information, including model, serial number, IP address, etc. | |
MMIND_API_EXPORT UserSetManager & | userSetManager () |
Returns a reference to the UserSetManager object. | |
MMIND_API_EXPORT UserSet & | currentUserSet () |
Returns a reference to the UserSet object. | |
MMIND_API_EXPORT ErrorStatus | captureRawImage (RawImage &image, int timeoutMs=2000) const |
Captures a raw image. | |
MMIND_API_EXPORT ErrorStatus | retrieveBatchData (ProfileBatch &batch, int timeoutMs=4000) const |
Retrieves a batch of the profiles in the scan data. | |
MMIND_API_EXPORT ErrorStatus | triggerSoftware () |
Sends a software signal to trigger data acquisition. This method is used when no external signals are input to trigger data acquisition and must be called after startAcquisition. | |
MMIND_API_EXPORT ErrorStatus | registerAcquisitionCallback (const Profiler::AcquisitionCallback &func, void *pUser) |
Registers the callback function for data acquisition. | |
MMIND_API_EXPORT ErrorStatus | startAcquisition () |
Enters the laser profiler into the data acquisition status, where it can accept trigger signals. This method must be called before triggerSoftware. | |
MMIND_API_EXPORT ErrorStatus | stopAcquisition () |
Stops data acquisition. | |
Static Public Member Functions | |
static MMIND_API_EXPORT std::vector< ProfilerInfo > | discoverProfilers () |
Discovers all available laser profilers. | |
Represents a Mech-Eye 3D Laser Profiler device.
Definition at line 21 of file Profiler.h.
using mmind::eye::Profiler::AcquisitionCallback = std::function<void(const ProfileBatch& batch, void* pUser)> |
Definition at line 24 of file Profiler.h.