Instrument commands and structures pertaining to gated sampling. More...

This graph shows which files directly or indirectly include this file:

Data Structures
struct	RBRInstrumentThresholding
	Instrument `thresholding` command parameters. More...

struct	RBRInstrumentTwistActivation
	Instrument `twistactivation` command parameters. More...

Typedefs
typedef enum RBRInstrumentGatingState	RBRInstrumentGatingState
	The state of a gating condition.

typedef enum RBRInstrumentThresholdingChannelSelection	RBRInstrumentThresholdingChannelSelection
	Means of instrument thresholding channel selection. More...

typedef enum RBRInstrumentThresholdingCondition	RBRInstrumentThresholdingCondition
	Possible instrument thresholding conditions. More...

typedef struct RBRInstrumentThresholding	RBRInstrumentThresholding
	Instrument `thresholding` command parameters. More...

typedef struct RBRInstrumentTwistActivation	RBRInstrumentTwistActivation
	Instrument `twistactivation` command parameters. More...

Enumerations
enum	RBRInstrumentGatingState { RBRINSTRUMENT_GATING_NA, RBRINSTRUMENT_GATING_PAUSED, RBRINSTRUMENT_GATING_RUNNING, RBRINSTRUMENT_GATING_COUNT, RBRINSTRUMENT_UNKNOWN_GATING }
	The state of a gating condition. More...

enum	RBRInstrumentThresholdingChannelSelection { RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_INDEX, RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_LABEL }
	Means of instrument thresholding channel selection. More...

enum	RBRInstrumentThresholdingCondition { RBRINSTRUMENT_THRESHOLDING_ABOVE, RBRINSTRUMENT_THRESHOLDING_BELOW, RBRINSTRUMENT_THRESHOLDING_COUNT, RBRINSTRUMENT_UNKNOWN_THRESHOLDING }
	Possible instrument thresholding conditions. More...

Functions
const char *	RBRInstrumentGatingState_name (RBRInstrumentGatingState state)
	Get a human-readable string name for a gating state. More...

const char *	RBRInstrumentThresholdingChannelSelection_name (RBRInstrumentThresholdingChannelSelection selection)
	Get a human-readable string name for a means of thresholding channel selection. More...

const char *	RBRInstrumentThresholdingCondition_name (RBRInstrumentThresholdingCondition condition)
	Get a human-readable string name for a thresholding condition. More...

RBRInstrumentError	RBRInstrument_getThresholding (RBRInstrument instrument, RBRInstrumentThresholding threshold)
	Get the instrument thresholding settings. More...

RBRInstrumentError	RBRInstrument_setThresholding (RBRInstrument instrument, const RBRInstrumentThresholding threshold)
	Set the instrument thresholding settings. More...

RBRInstrumentError	RBRInstrument_getTwistActivation (RBRInstrument instrument, RBRInstrumentTwistActivation twistActivation)
	Get the instrument twist activation settings. More...

RBRInstrumentError	RBRInstrument_setTwistActivation (RBRInstrument instrument, const RBRInstrumentTwistActivation twistActivation)
	Set the instrument twist activation settings. More...

Detailed Description

Instrument commands and structures pertaining to gated sampling.

See also: https://docs.rbr-global.com/L3commandreference/commands/gated-sampling

Copyright: Copyright (c) 2018 RBR Ltd. Licensed under the Apache License, Version 2.0.

Typedef Documentation

◆ RBRInstrumentThresholding

typedef struct RBRInstrumentThresholding RBRInstrumentThresholding

Instrument thresholding command parameters.

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

◆ RBRInstrumentThresholdingChannelSelection

typedef enum RBRInstrumentThresholdingChannelSelection RBRInstrumentThresholdingChannelSelection

Means of instrument thresholding channel selection.

See also: RBRInstrumentThresholding; https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

◆ RBRInstrumentThresholdingCondition

typedef enum RBRInstrumentThresholdingCondition RBRInstrumentThresholdingCondition

Possible instrument thresholding conditions.

See also: RBRInstrumentThresholding; https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

◆ RBRInstrumentTwistActivation

typedef struct RBRInstrumentTwistActivation RBRInstrumentTwistActivation

Instrument twistactivation command parameters.

See also: RBRInstrument_getTwistActivation(); RBRInstrument_setTwistActivation(); https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/twistactivation

Enumeration Type Documentation

◆ RBRInstrumentGatingState

enum RBRInstrumentGatingState

The state of a gating condition.

Enumerator
RBRINSTRUMENT_GATING_NA	The gating condition is disabled.
RBRINSTRUMENT_GATING_PAUSED	Logging is paused due to the gating.
RBRINSTRUMENT_GATING_RUNNING	Logging is running due to the gating.
RBRINSTRUMENT_GATING_COUNT	The number of specific gating condition types.
RBRINSTRUMENT_UNKNOWN_GATING	An unknown or unrecognized gating condition type.

◆ RBRInstrumentThresholdingChannelSelection

enum RBRInstrumentThresholdingChannelSelection

Means of instrument thresholding channel selection.

See also: RBRInstrumentThresholding; https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

Enumerator
RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_INDEX	The channel is set by index.
RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_LABEL	The channel is set by label.

◆ RBRInstrumentThresholdingCondition

enum RBRInstrumentThresholdingCondition

Possible instrument thresholding conditions.

See also: RBRInstrumentThresholding; https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

Enumerator
RBRINSTRUMENT_THRESHOLDING_ABOVE	Sampling occurs when the monitored parameter is above the threshold.
RBRINSTRUMENT_THRESHOLDING_BELOW	Sampling occurs when the monitored parameter is below the threshold.
RBRINSTRUMENT_THRESHOLDING_COUNT	The number of thresholding conditions.
RBRINSTRUMENT_UNKNOWN_THRESHOLDING	An unknown or unrecognized thresholding condition.

Function Documentation

◆ RBRInstrument_getThresholding()

RBRInstrumentError RBRInstrument_getThresholding	(	RBRInstrument *	instrument,
		RBRInstrumentThresholding *	threshold
	)

Get the instrument thresholding settings.

Parameters

[in]	instrument	the instrument connection
[out]	threshold	the thresholding parameters

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the feature is unavailable

See also: https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

◆ RBRInstrument_getTwistActivation()

RBRInstrumentError RBRInstrument_getTwistActivation	(	RBRInstrument *	instrument,
		RBRInstrumentTwistActivation *	twistActivation
	)

Get the instrument twist activation settings.

Parameters

[in]	instrument	the instrument connection
[out]	twistActivation	the twist activation parameters

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully read; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the feature is unavailable

See also: https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/twistactivation

◆ RBRInstrument_setThresholding()

RBRInstrumentError RBRInstrument_setThresholding	(	RBRInstrument *	instrument,
		const RBRInstrumentThresholding *	threshold
	)

Set the instrument thresholding settings.

Hardware errors may occur if:

thresholding is not available for the instrument
the instrument is logging
you set an out-of-bounds parameter the library fails to detect
the thresholding channel selected is uncalibrated

Parameters

[in]	instrument	the instrument connection
[in]	threshold	the thresholding parameters

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the settings cannot be changed; RBRINSTRUMENT_INVALID_PARAMETER_VALUE when parameter values are out of range

See also: https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/thresholding

◆ RBRInstrument_setTwistActivation()

RBRInstrumentError RBRInstrument_setTwistActivation	(	RBRInstrument *	instrument,
		const RBRInstrumentTwistActivation *	twistActivation
	)

Set the instrument twist activation settings.

Hardware errors may occur if:

twist activation is not available for the instrument
the instrument is logging

Parameters

[in]	instrument	the instrument connection
[in]	twistActivation	the twist activation parameters

Returns: RBRINSTRUMENT_SUCCESS when the settings are successfully written; RBRINSTRUMENT_TIMEOUT when a timeout occurs; RBRINSTRUMENT_CALLBACK_ERROR returned by a callback; RBRINSTRUMENT_HARDWARE_ERROR when the settings cannot be changed

See also: https://docs.rbr-global.com/L3commandreference/commands/gated-sampling/twistactivation

◆ RBRInstrumentGatingState_name()

const char* RBRInstrumentGatingState_name ( RBRInstrumentGatingState state )

Get a human-readable string name for a gating state.

Parameters

[in] state the gating state

Returns: a string name for the gating state

See also: RBRInstrumentError_name() for a description of the format of names

◆ RBRInstrumentThresholdingChannelSelection_name()

const char* RBRInstrumentThresholdingChannelSelection_name ( RBRInstrumentThresholdingChannelSelection selection )

Get a human-readable string name for a means of thresholding channel selection.

Parameters

[in] selection the channel selection type

Returns: a string name for the channel selection type

See also: RBRInstrumentError_name() for a description of the format of names

◆ RBRInstrumentThresholdingCondition_name()

const char* RBRInstrumentThresholdingCondition_name ( RBRInstrumentThresholdingCondition condition )

Get a human-readable string name for a thresholding condition.

Parameters

[in] condition the thresholding condition

Returns: a string name for the thresholding condition

See also: RBRInstrumentError_name() for a description of the format of names

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ RBRInstrumentThresholding

◆ RBRInstrumentThresholdingChannelSelection

◆ RBRInstrumentThresholdingCondition

◆ RBRInstrumentTwistActivation

Enumeration Type Documentation

◆ RBRInstrumentGatingState

◆ RBRInstrumentThresholdingChannelSelection

◆ RBRInstrumentThresholdingCondition

Function Documentation

◆ RBRInstrument_getThresholding()

◆ RBRInstrument_getTwistActivation()

◆ RBRInstrument_setThresholding()

◆ RBRInstrument_setTwistActivation()

◆ RBRInstrumentGatingState_name()

◆ RBRInstrumentThresholdingChannelSelection_name()

◆ RBRInstrumentThresholdingCondition_name()