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

Instrument regime command parameters. More...

#include <RBRInstrumentVehicle.h>

Data Fields

RBRInstrumentRegimeIndex index
 The index of the regime in question. More...
 
float boundary
 The first boundary in a region. More...
 
float binSize
 The size used for each averaged bin. More...
 
RBRInstrumentPeriod samplingPeriod
 The same meaning as RBRInstrumentSampling.period, but applies only to this particular regime. More...
 

Detailed Description

Instrument regime command parameters.

See also
RBRInstrument_getRegime()
RBRInstrument_setRegime()
https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regime

Field Documentation

◆ binSize

float RBRInstrumentRegime::binSize

The size used for each averaged bin.

Specified in dbar.

◆ boundary

float RBRInstrumentRegime::boundary

The first boundary in a region.

Specified in dbar.

◆ index

RBRInstrumentRegimeIndex RBRInstrumentRegime::index

The index of the regime in question.

The value of this member is used to determine which regime settings are being retrieved or set.

Must be in the range 1–3.

◆ samplingPeriod

RBRInstrumentPeriod RBRInstrumentRegime::samplingPeriod

The same meaning as RBRInstrumentSampling.period, but applies only to this particular regime.

May not be greater than 65,000.


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