Instrument sampling command parameters. More...

#include <RBRInstrumentSchedule.h>

Data Fields
RBRInstrumentSamplingMode	mode
	The instrument sampling mode.

RBRInstrumentPeriod	period
	Time between measurements. More...

const RBRInstrumentPeriod	availableFastPeriods [RBRINSTRUMENT_AVAILABLE_FAST_PERIODS_MAX]
	Fast measurement periods available for the logger for sampling rates faster than 1Hz. More...

const RBRInstrumentPeriod	userPeriodLimit
	The minimum period which can be used in fast sampling modes. More...

int32_t	burstLength
	The number of measurements taken in each burst. More...

RBRInstrumentPeriod	burstInterval
	The time between the first measurement of two consecutive bursts. More...

RBRInstrumentGate	gate
	The sampling gating condition.

Detailed Description

Instrument sampling command parameters.

See the command reference for details on valid parameter values.

See also: RBRInstrument_getSampling(); RBRInstrument_setSampling(); https://docs.rbr-global.com/L3commandreference/commands/time-and-schedule/sampling

Field Documentation

◆ availableFastPeriods

const RBRInstrumentPeriod RBRInstrumentSampling::availableFastPeriods[RBRINSTRUMENT_AVAILABLE_FAST_PERIODS_MAX]

Fast measurement periods available for the logger for sampling rates faster than 1Hz.

Available fast periods are stored in the array in the order reported by the instrument. Unused array elements are populated with 0. If more than RBRINSTRUMENT_AVAILABLE_FAST_PERIODS_MAX are available, trailing entries are discarded.

Logger2 instruments do not report available fast periods. For convenience, RBRInstrument_getSampling() will synthesize the contents of this field based on the value of RBRInstrumentSampling.userPeriodLimit.

The corresponding instrument parameter is read-only. This member is used only when reading parameters from the instrument; its value is ignored when sending parameters to the instrument.

◆ burstInterval

RBRInstrumentPeriod RBRInstrumentSampling::burstInterval

The time between the first measurement of two consecutive bursts.

Specified in milliseconds. Must be in the range 1,000—86,400,000 and must be an integer multiple of 1,000. The burst interval is additionally constrained by the sampling period (RBRInstrumentSampling.period) and burst length (RBRInstrumentSampling.burstLength):

burst interval > (burst length × sampling period)

◆ burstLength

int32_t RBRInstrumentSampling::burstLength

The number of measurements taken in each burst.

Specified in numbers of samples. Must be in the range 2—65,535.

◆ period

RBRInstrumentPeriod RBRInstrumentSampling::period

Time between measurements.

Specified in milliseconds. Must be in the range RBRInstrumentSampling.userPeriodLimit—86,400,000.

When < 1,000, must be in RBRInstrumentSampling.availableFastPeriods.
When ≥ 1,000, must be an integer multiple of 1,000.

◆ userPeriodLimit

const RBRInstrumentPeriod RBRInstrumentSampling::userPeriodLimit

The minimum period which can be used in fast sampling modes.

Specified in milliseconds.

This is the minimum RBRInstrumentSampling.period value.