NDEVR
API Documentation
RealSenseIOSettings

Aggregated IO settings for all RealSense streams and laser configuration. More...

Collaboration diagram for RealSenseIOSettings:
[legend]

Public Member Functions

 RealSenseIOSettings ()
 Constructs default IO settings.
 RealSenseIOSettings (CollectionMode mode, fltp04 quality, bool use_imu_for_scan)
 Constructs IO settings for a given collection mode and quality.
bool hasRSStreamDiff (const RealSenseIOSettings &s) const
 Checks whether the stream configuration differs from another settings object.
void setToDefaults (CollectionMode mode, fltp04 quality, bool use_imu_for_scan)
 Resets all settings to defaults for the given mode and quality.
void turnAllOnOrOff (bool on)
 Enables or disables all streams.

Public Attributes

RealSenseStreamSettings accelerometer_stream
 Settings for the accelerometer stream.
RealSenseStreamSettings color_stream
 Settings for the color stream.
RealSenseStreamSettings depth_stream
 Settings for the depth stream.
RealSenseStreamSettings gyro_stream
 Settings for the gyroscope stream.
RealSenseStreamSettings ir_stream
 Settings for the infrared stream.
fltp04 laser_power_percent = 0.5f
 Laser power as a fraction (0.0 to 1.0).
bool pulse_emitter = false
 Whether to pulse the IR emitter.
bool use_ir_for_point_color = false
 Whether to use IR for point coloring instead of color stream.
bool use_ir_for_slam = false
 Whether to use IR frames for SLAM tracking.

Detailed Description

Aggregated IO settings for all RealSense streams and laser configuration.

Encapsulates stream settings for IR, color, depth, gyro, and accelerometer along with laser power and emitter configuration.

Definition at line 34 of file RealSenseIOSettings.h.

Constructor & Destructor Documentation

◆ RealSenseIOSettings()

RealSenseIOSettings::RealSenseIOSettings ( CollectionMode mode,
fltp04 quality,
bool use_imu_for_scan )

Constructs IO settings for a given collection mode and quality.

Parameters
[in]modeThe collection mode.
[in]qualityThe quality level (0.0 to 1.0).
[in]use_imu_for_scanWhether to use IMU data during scanning.

Member Function Documentation

◆ hasRSStreamDiff()

bool RealSenseIOSettings::hasRSStreamDiff ( const RealSenseIOSettings & s) const

Checks whether the stream configuration differs from another settings object.

Parameters
[in]sThe other settings to compare.
Returns
True if any RealSense stream settings differ.

References RealSenseIOSettings().

◆ setToDefaults()

void RealSenseIOSettings::setToDefaults ( CollectionMode mode,
fltp04 quality,
bool use_imu_for_scan )

Resets all settings to defaults for the given mode and quality.

Parameters
[in]modeThe collection mode.
[in]qualityThe quality level.
[in]use_imu_for_scanWhether to use IMU during scanning.

◆ turnAllOnOrOff()

void RealSenseIOSettings::turnAllOnOrOff ( bool on)

Enables or disables all streams.

Parameters
[in]onWhether to turn all streams on (true) or off (false).

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