libRBR  v1.2.3
RBR instrument communication API
Data Fields
RBRInstrumentDirectionDependentSampling Struct Reference

Instrument ddsampling command parameters. More...

#include <RBRInstrumentVehicle.h>

Data Fields

RBRInstrumentDirection direction
 In which direction the instrument samples at the fast rate.
 
RBRInstrumentPeriod fastPeriod
 The same meaning as RBRInstrumentSampling.period, but applies only when the instrument is moving in the preferred direction. More...
 
RBRInstrumentPeriod slowPeriod
 The same meaning as RBRInstrumentSampling.period, but applies only when the instrument is not moving in the preferred direction. More...
 
float fastThreshold
 Sets the boundary, based on the previous profile, where the instrument should switch to the fast period sampling. More...
 
float slowThreshold
 Sets the boundary, based on the previous profile, where the instrument should switch to the slow period sampling. More...
 

Detailed Description

Instrument ddsampling command parameters.

See also
RBRInstrument_getDirectionDependentSampling()
RBRInstrument_setDirectionDependentSampling()
https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/ddsampling

Field Documentation

◆ fastPeriod

RBRInstrumentPeriod RBRInstrumentDirectionDependentSampling::fastPeriod

The same meaning as RBRInstrumentSampling.period, but applies only when the instrument is moving in the preferred direction.

Must be shorter than RBRInstrumentDirectionDependentSampling.slowPeriod.

◆ fastThreshold

float RBRInstrumentDirectionDependentSampling::fastThreshold

Sets the boundary, based on the previous profile, where the instrument should switch to the fast period sampling.

Specified in dbar. The minimum precision is 0.1 and the value should be greater than 0.

◆ slowPeriod

RBRInstrumentPeriod RBRInstrumentDirectionDependentSampling::slowPeriod

The same meaning as RBRInstrumentSampling.period, but applies only when the instrument is not moving in the preferred direction.

Must be longer than RBRInstrumentDirectionDependentSampling.fastPeriod.

◆ slowThreshold

float RBRInstrumentDirectionDependentSampling::slowThreshold

Sets the boundary, based on the previous profile, where the instrument should switch to the slow period sampling.

Specified in dbar. The minimum precision is 0.1 and the value should be greater than 0.


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