Mech-Eye API 2.3.4
API reference documentation for Mech-Eye 3D Laser Profiler
All Classes Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Attributes | List of all members
mmind::eye::scan_settings::BatchRetrievalTimeout Class Reference

Static Public Attributes

static constexpr const char * name = "BatchRetrievalTimeout"
 
static constexpr const char * description
 
static constexpr Parameter::Type type = Parameter::Type::_Int
 
static constexpr const char * unit = "ms"
 

Detailed Description

Definition at line 172 of file ScanParameters.h.

Member Data Documentation

◆ description

constexpr const char* mmind::eye::scan_settings::BatchRetrievalTimeout::description
staticconstexpr
Initial value:
=
"Set the timeout period for retrieving a batch of data. If no batches are available for "
"retrieval within the set timeout period, the current round of data acquisition is "
"automatically stopped.\nThis timeout period should be no shorter than the amount of time "
"needed for scanning 16 lines. If line scan is triggered at a slow rate, increase this "
"parameter.\nA value of 0 or -1 corresponds to an infinite timeout period."

Definition at line 177 of file ScanParameters.h.

◆ name

constexpr const char* mmind::eye::scan_settings::BatchRetrievalTimeout::name = "BatchRetrievalTimeout"
staticconstexpr

Definition at line 175 of file ScanParameters.h.

◆ type

constexpr Parameter::Type mmind::eye::scan_settings::BatchRetrievalTimeout::type = Parameter::Type::_Int
staticconstexpr

Definition at line 184 of file ScanParameters.h.

◆ unit

constexpr const char* mmind::eye::scan_settings::BatchRetrievalTimeout::unit = "ms"
staticconstexpr

Definition at line 186 of file ScanParameters.h.


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