Instrument thresholding command parameters. More...

#include <RBRInstrumentGating.h>

Data Fields
bool	enabled
	Enables or disables thresholding.

const RBRInstrumentGatingState	state
	The state of logging based on the thresholding configuration. More...

RBRInstrumentThresholdingChannelSelection	channelSelection
	Whether the thresholding channel should be configured by index or by label. More...

RBRInstrumentChannelIndex	channelIndex
	The index of the channel to use for the threshold check. More...

char	channelLabel [RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]
	The label of the channel to use for the threshold check. More...

RBRInstrumentThresholdingCondition	condition
	Specifies the condition under which sampling will occur.

float	value
	The threshold value in calibrated units.

RBRInstrumentPeriod	interval
	The interval between threshold checks. More...

Detailed Description

Instrument thresholding command parameters.

See also: RBRInstrument_getThresholding(); RBRInstrument_setThresholding(); https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

Field Documentation

◆ channelIndex

RBRInstrumentChannelIndex RBRInstrumentThresholding::channelIndex

The index of the channel to use for the threshold check.

When setting the instrument thresholding channel, the value of this field is only used when RBRInstrumentThresholding.channelSelection is set to RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_INDEX.

◆ channelLabel

char RBRInstrumentThresholding::channelLabel[RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]

The label of the channel to use for the threshold check.

When setting the thresholding channel by label, should be provided as a null-terminated C string. The value will be populated likewise when retrieving thresholding parameters from the instrument.

When setting the instrument thresholding channel, the value of this field is only used when RBRInstrumentThresholding.channelSelection is set to RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_LABEL.

This parameter is unavailable for Logger2 instruments. Use RBRInstrumentThresholding.channelIndex instead.

◆ channelSelection

RBRInstrumentThresholdingChannelSelection RBRInstrumentThresholding::channelSelection

Whether the thresholding channel should be configured by index or by label.

This member is used only when writing parameters to the instrument. It is set to RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_INDEX when retrieving parameters. For Logger2 instruments, which do not have channel labels, this must be given as RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_INDEX or RBRInstrument_setThresholding() will return RBRINSTRUMENT_INVALID_PARAMETER_VALUE.

See also: RBRInstrument_setThresholding()

◆ interval

RBRInstrumentPeriod RBRInstrumentThresholding::interval

The interval between threshold checks.

The value is given and reported in milliseconds, but must correspond to a non-zero whole number of seconds (i.e., must be divisible by 1,000) and must not be greater than 86,400,000 (24 hours).

◆ state

const RBRInstrumentGatingState RBRInstrumentThresholding::state

The state of logging based on the thresholding configuration.

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.

This parameter is unavailable for Logger2 instruments. Will always be retrieved as RBRINSTRUMENT_UNKNOWN_GATING.

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

include/RBRInstrumentGating.h