NDEVR
API Documentation
PointScannerOptions

Persistent settings for the 3D point scanner, controlling scanner behavior, IMU parameters, camera options, deployment options, and communication settings. More...

Inheritance diagram for PointScannerOptions:
[legend]
Collaboration diagram for PointScannerOptions:
[legend]

Public Member Functions

void getINI (INIFactory &factory) final override
 Populates the given INI factory with the options managed by this interface.
Public Member Functions inherited from INIInterface
 INIInterface ()
 Constructs an INIInterface with no default INI file.
 INIInterface (const File &default_ini)
 Constructs an INIInterface with the specified default INI file.
virtual ~INIInterface ()
 Virtual destructor for safe polymorphic cleanup.
virtual void finishReadingINI (INIFactory &)
 Called after reading an INI file.
virtual void prepareForINI (INIFactory &)
 Called before reading or writing an INI file.
virtual bool readINIOptions ()
 Reads INI options from the default INI file.
virtual bool readINIOptions (File &ini_file)
 Reads INI options from the specified INI file.
virtual bool saveINIOptions (bool multithead=false)
 Saves INI options to the default INI file.
virtual bool saveINIOptions (File &ini_file, bool multithead=false)
 Saves INI options to the specified INI file.
void setDefaultINIFile (const File &file)
 Sets the default INI file path used for reading and writing options.
virtual void writeToLog (const StringView &title, LogPtr log, uint01 log_level=2U)
 Writes the current INI options to the specified log with a title.
virtual void writeToLog (LogPtr log, uint01 log_level=2U)
 Writes the current INI options to the specified log.

Public Attributes

Resource< fltp04fast_speed
 Fast motor speed setting.
Resource< fltp08light_brightness
 Scanner light brightness level.
Resource< Stringremote_connections
 Comma-separated list of remote scanner connection strings.
Resource< fltp04slow_speed
 Slow motor speed setting.

Additional Inherited Members

Protected Attributes inherited from INIInterface
File m_default_ini
 The default file path used for reading and writing INI options.

Detailed Description

Persistent settings for the 3D point scanner, controlling scanner behavior, IMU parameters, camera options, deployment options, and communication settings.


Serialized via INIInterface.

Definition at line 44 of file PointScannerOptions.h.

Member Function Documentation

◆ getINI()

void PointScannerOptions::getINI ( INIFactory & factory)
finaloverridevirtual

Populates the given INI factory with the options managed by this interface.

Parameters
[in]factoryThe INI factory to populate with option definitions.

Implements INIInterface.


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