Instrument commands and structures pertaining to vehicle support. More...

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

Data Structures
struct	RBRInstrumentRegimes
	Instrument `regimes` command parameters. More...

struct	RBRInstrumentRegime
	Instrument `regime` command parameters. More...

struct	RBRInstrumentDirectionDependentSampling
	Instrument `ddsampling` command parameters. More...

Macros
#define	RBRINSTRUMENT_REGIME_MAX 3
	The maximum number of regimes configurable on an instrument.

#define	RBRINSTRUMENT_REGIME_BOUNDARY_MAX 65535
	The maximum regime boundary in dbar.

#define	RBRINSTRUMENT_REGIME_BINSIZE_MAX 6553.5
	The maximum regime bin size in dbar.

#define	RBRINSTRUMENT_REGIME_SAMPLING_PERIOD_MAX 65000
	The maximum sampling period within a regime.

Typedefs
typedef enum RBRInstrumentDirection	RBRInstrumentDirection
	Whether settings apply to ascent or descent. More...

typedef enum RBRInstrumentRegimesReference	RBRInstrumentRegimesReference
	The types of pressure available for use a reference for the determination of the current regime and bin. More...

typedef struct RBRInstrumentRegimes	RBRInstrumentRegimes
	Instrument `regimes` command parameters. More...

typedef uint8_t	RBRInstrumentRegimeIndex
	A regime identifier.

typedef struct RBRInstrumentRegime	RBRInstrumentRegime
	Instrument `regime` command parameters. More...

typedef struct RBRInstrumentDirectionDependentSampling	RBRInstrumentDirectionDependentSampling
	Instrument `ddsampling` command parameters. More...

Enumerations
enum	RBRInstrumentDirection { RBRINSTRUMENT_DIRECTION_ASCENDING, RBRINSTRUMENT_DIRECTION_DESCENDING, RBRINSTRUMENT_DIRECTION_COUNT, RBRINSTRUMENT_UNKNOWN_DIRECTION }
	Whether settings apply to ascent or descent. More...

enum	RBRInstrumentRegimesReference { RBRINSTRUMENT_REFERENCE_ABSOLUTE, RBRINSTRUMENT_REFERENCE_SEAPRESSURE, RBRINSTRUMENT_REFERENCE_COUNT, RBRINSTRUMENT_UNKNOWN_REFERENCE }
	The types of pressure available for use a reference for the determination of the current regime and bin. More...

Functions
const char *	RBRInstrumentDirection_name (RBRInstrumentDirection direction)
	Get a human-readable string name for an instrument direction. More...

const char *	RBRInstrumentRegimesReference_name (RBRInstrumentRegimesReference reference)
	Get a human-readable string name for a regime pressure reference. More...

RBRInstrumentError	RBRInstrument_getRegimes (RBRInstrument instrument, RBRInstrumentRegimes regimes)
	Get the instrument regimes settings. More...

RBRInstrumentError	RBRInstrument_setRegimes (RBRInstrument instrument, const RBRInstrumentRegimes regimes)
	Set the instrument regimes settings. More...

RBRInstrumentError	RBRInstrument_getRegime (RBRInstrument instrument, RBRInstrumentRegime regime)
	Get the instrument regime settings. More...

RBRInstrumentError	RBRInstrument_setRegime (RBRInstrument instrument, const RBRInstrumentRegime regime)
	Set the instrument regime settings. More...

RBRInstrumentError	RBRInstrument_getDirectionDependentSampling (RBRInstrument instrument, RBRInstrumentDirectionDependentSampling ddsampling)
	Get the instrument direction-dependent sampling settings. More...

RBRInstrumentError	RBRInstrument_setDirectionDependentSampling (RBRInstrument instrument, RBRInstrumentDirectionDependentSampling ddsampling)
	Set the instrument regime settings. More...

Detailed Description

Instrument commands and structures pertaining to vehicle support.

See also: https://docs.rbr-global.com/L3commandreference/commands/vehicle-support

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

Typedef Documentation

◆ RBRInstrumentDirection

typedef enum RBRInstrumentDirection RBRInstrumentDirection

Whether settings apply to ascent or descent.

See also: RBRInstrumentRegimes; RBRInstrumentDirectionDependentSampling; https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regimes; https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/ddsampling

◆ RBRInstrumentDirectionDependentSampling

typedef struct RBRInstrumentDirectionDependentSampling RBRInstrumentDirectionDependentSampling

Instrument ddsampling command parameters.

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

◆ RBRInstrumentRegime

typedef struct RBRInstrumentRegime RBRInstrumentRegime

Instrument regime command parameters.

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

◆ RBRInstrumentRegimes

typedef struct RBRInstrumentRegimes RBRInstrumentRegimes

Instrument regimes command parameters.

See also: RBRInstrument_getRegimes(); RBRInstrument_setRegimes(); https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regimes

◆ RBRInstrumentRegimesReference

typedef enum RBRInstrumentRegimesReference RBRInstrumentRegimesReference

The types of pressure available for use a reference for the determination of the current regime and bin.

See also: RBRInstrumentRegimes; https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regimes

Enumeration Type Documentation

◆ RBRInstrumentDirection

enum RBRInstrumentDirection

Whether settings apply to ascent or descent.

See also: RBRInstrumentRegimes; RBRInstrumentDirectionDependentSampling; https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regimes; https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/ddsampling

Enumerator
RBRINSTRUMENT_DIRECTION_ASCENDING	The settings apply while ascending.
RBRINSTRUMENT_DIRECTION_DESCENDING	The settings apply while descending.
RBRINSTRUMENT_DIRECTION_COUNT	The number of specific directions.
RBRINSTRUMENT_UNKNOWN_DIRECTION	An unknown or unrecognized direction.

◆ RBRInstrumentRegimesReference

enum RBRInstrumentRegimesReference

The types of pressure available for use a reference for the determination of the current regime and bin.

See also: RBRInstrumentRegimes; https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regimes

Enumerator
RBRINSTRUMENT_REFERENCE_ABSOLUTE	Absolute pressure is used as the reference.
RBRINSTRUMENT_REFERENCE_SEAPRESSURE	Sea pressure is used as the reference.
RBRINSTRUMENT_REFERENCE_COUNT	The number of specific regime reference types.
RBRINSTRUMENT_UNKNOWN_REFERENCE	An unknown or unrecognized regime reference type.

Function Documentation

◆ RBRInstrument_getDirectionDependentSampling()

RBRInstrumentError RBRInstrument_getDirectionDependentSampling	(	RBRInstrument *	instrument,
		RBRInstrumentDirectionDependentSampling *	ddsampling
	)

Get the instrument direction-dependent sampling settings.

Parameters

[in]	instrument	the instrument connection
[out]	ddsampling	the direction-dependent sampling 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/vehicle-support/ddsampling

◆ RBRInstrument_getRegime()

RBRInstrumentError RBRInstrument_getRegime	(	RBRInstrument *	instrument,
		RBRInstrumentRegime *	regime
	)

Get the instrument regime settings.

Set RBRInstrumentRegime.index to indicate which regime settings are to be retrieved.

RBRINSTRUMENT_INVALID_PARAMETER_VALUE will be returned right away if a regime index greater than 3 is requested. RBRINSTRUMENT_HARDWARE_ERROR will be returned if a regime index is given which exceeds the number of regimes currently configured (RBRInstrumentRegimes.count).

Parameters

[in]	instrument	the instrument connection
[out]	regime	the regime 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, or if an invalid regime index is given; RBRINSTRUMENT_INVALID_PARAMETER_VALUE if an invalid regime index is given

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

◆ RBRInstrument_getRegimes()

RBRInstrumentError RBRInstrument_getRegimes	(	RBRInstrument *	instrument,
		RBRInstrumentRegimes *	regimes
	)

Get the instrument regimes settings.

Parameters

[in]	instrument	the instrument connection
[out]	regimes	the regimes 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/vehicle-support/regimes

◆ RBRInstrument_setDirectionDependentSampling()

RBRInstrumentError RBRInstrument_setDirectionDependentSampling	(	RBRInstrument *	instrument,
		RBRInstrumentDirectionDependentSampling *	ddsampling
	)

Set the instrument regime settings.

Hardware errors may occur if:

direction-dependent sampling is not available for the instrument
the instrument is logging
you set an out-of-bounds parameter the library fails to detect

Parameters

[in]	instrument	the instrument connection
[in]	ddsampling	the direction-dependent sampling 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/vehicle-support/ddsampling

◆ RBRInstrument_setRegime()

RBRInstrumentError RBRInstrument_setRegime	(	RBRInstrument *	instrument,
		const RBRInstrumentRegime *	regime
	)

Set the instrument regime settings.

Hardware errors may occur if:

regimes are not available for the instrument
the instrument is logging
you set an out-of-bounds parameter the library fails to detect

Parameters

[in]	instrument	the instrument connection
[in]	regime	the regime 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/vehicle-support/regime

◆ RBRInstrument_setRegimes()

RBRInstrumentError RBRInstrument_setRegimes	(	RBRInstrument *	instrument,
		const RBRInstrumentRegimes *	regimes
	)

Set the instrument regimes settings.

These settings are only used when the RBRInstrumentSampling.mode is RBRINSTRUMENT_SAMPLING_REGIMES.

Hardware errors may occur if:

regimes are not available for the instrument
the instrument is logging

Parameters

[in]	instrument	the instrument connection
[in]	regimes	the regimes 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 too many regimes are requested

See also: https://docs.rbr-global.com/L3commandreference/commands/vehicle-support/regimes

◆ RBRInstrumentDirection_name()

const char* RBRInstrumentDirection_name ( RBRInstrumentDirection direction )

Get a human-readable string name for an instrument direction.

Parameters

[in] direction the direction

Returns: a string name for the direction

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

◆ RBRInstrumentRegimesReference_name()

const char* RBRInstrumentRegimesReference_name ( RBRInstrumentRegimesReference reference )

Get a human-readable string name for a regime pressure reference.

Parameters

[in] reference the pressure reference

Returns: a string name for the pressure reference

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

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ RBRInstrumentDirection

◆ RBRInstrumentDirectionDependentSampling

◆ RBRInstrumentRegime

◆ RBRInstrumentRegimes

◆ RBRInstrumentRegimesReference

Enumeration Type Documentation

◆ RBRInstrumentDirection

◆ RBRInstrumentRegimesReference

Function Documentation

◆ RBRInstrument_getDirectionDependentSampling()

◆ RBRInstrument_getRegime()

◆ RBRInstrument_getRegimes()

◆ RBRInstrument_setDirectionDependentSampling()

◆ RBRInstrument_setRegime()

◆ RBRInstrument_setRegimes()

◆ RBRInstrumentDirection_name()

◆ RBRInstrumentRegimesReference_name()