Functions that retrieve information from the black box fishfinder regarding the allowable range of input values for certain setter functions. More...

Functions
FF_Error_t	STFF::STFishFinder::GetInputSamplesLimits (uint16_t pMinInputSamples, uint16_t pMaxInputSamples) const
	Getter function to provide limits for the parameter to the SetNumInputSamples() member function. More...

FF_Error_t	STFF::STFishFinder::GetSpeedPulsesPerNauticalMileLimits (uint32_t pMinSpeedPPNM, uint32_t pMaxSpeedPPNM) const
	Getter function to provide limits for the parameter to the SetSpeedPulsesPerNauticalMile() member function. More...

FF_Error_t	STFF::STFishFinder::GetTemperatureOffsetLimits (FF_TemperatureUnits_t units, int16_t pMinTempOffset, int16_t pMaxTempOffset) const
	Getter function to provide limits for the parameter to the SetTemperatureOffset() member function. More...

FF_Error_t	STFF::STFishFinder::GetRangeLimits (FF_DepthUnits_t units, uint32_t pMinRangeDeep, uint32_t pMaxRangeDeep) const
	Getter function to provide limits for the parameter to the SetRange() member function. More...

FF_Error_t	STFF::STFishFinder::GetGainLimits (uint16_t pMinGain, uint16_t pMaxGain) const
	Getter function to provide limits for the parameter to the SetGain() member function. More...

FF_Error_t	STFF::STFishFinder::GetGainOffsetLimits (int16_t pMinOffset, int16_t pMaxOffset) const
	Getter function to provide limits for the parameter to the SetGainOffset() member function. More...

FF_Error_t	STFF::STFishFinder::GetGainColorOffsetsLimits (uint16_t pNumOffsets, uint16_t pMinLargestOffset, uint16_t *pMaxLargestOffset) const
	Getter function to provide: More...

Detailed Description

Functions that retrieve information from the black box fishfinder regarding the allowable range of input values for certain setter functions.

These are member functions of the STFishFinder class.

These functions are provided to enable the application program to verify that the arguments it provides to a setter function are valid values for that function.

See also: Setters; Getters for Local Settings; Getters for Master Settings; Getters for Attributes; Getters for Data

Function Documentation

STFF::STFishFinder::GetGainColorOffsetsLimits	(	uint16_t *	pNumOffsets,
		uint16_t *	pMinLargestOffset,
		uint16_t *	pMaxLargestOffset
	)		const

#include <STFF-FishFinder.h>

Getter function to provide:

the number of required elements in the Gain Color Offsets array provided in the pGainColorOffsets parameter to the GetGainColorOffsets() and SetGainColorOffsets() member functions
minimum and maximum limits that define the range of allowable values that may be used in the array when calling the SetGainColorOffsets() member function.

The limits provided apply to both 200 kHz and 50 kHz frequencies.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Parameters

[out]	pNumOffsets	Pointer to location into which this function will store a value representing the required number of elements in the `pGainColorOffsets` array passed to the GetGainColorOffsets() and SetGainColorOffsets() member functions. If the pNumOffsets parameter is a null pointer, then no value will be stored.
[out]	pMinLargestOffset	Pointer to location into which this function will store the minimum allowable value for the last element in the `pGainColorOffsets` array passed to the SetGainColorOffsets() member function. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxLargestOffset	Pointer to location into which this function will store the maximum allowable value for the last element in the `pGainColorOffsets` array passed to the SetGainColorOffsets() member function. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: GetGainColorOffsets(); SetGainColorOffsets()

STFF::STFishFinder::GetGainLimits	(	uint16_t *	pMinGain,
		uint16_t *	pMaxGain
	)		const

#include <STFF-FishFinder.h>

Getter function to provide limits for the parameter to the SetGain() member function.

This function provides the minimum and maximum limits that define the range of allowable values that may be used in the gainSetting parameter when calling the SetGain() member function.

The limits provided apply to both 200 kHz and 50 kHz frequencies.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Parameters

[out]	pMinGain	Pointer to location into which this function will store the minimum allowable value for the gain setting. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxGain	Pointer to location into which this function will store the maximum allowable value for the gain setting. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: SetGain()

STFF::STFishFinder::GetGainOffsetLimits	(	int16_t *	pMinOffset,
		int16_t *	pMaxOffset
	)		const

#include <STFF-FishFinder.h>

Getter function to provide limits for the parameter to the SetGainOffset() member function.

This function provides the minimum and maximum limits that define the range of allowable values that may be used in the gainOffset parameter when calling the SetGainOffset() member function.

The limits provided apply to both 200 kHz and 50 kHz frequencies.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Parameters

[out]	pMinOffset	Pointer to location into which this function will store the minimum allowable value for the gain offset setting. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxOffset	Pointer to location into which this function will store the maximum allowable value for the gain offset setting. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: SetGainOffset()

STFF::STFishFinder::GetInputSamplesLimits	(	uint16_t *	pMinInputSamples,
		uint16_t *	pMaxInputSamples
	)		const

#include <STFF-FishFinder.h>

Getter function to provide limits for the parameter to the SetNumInputSamples() member function.

This function provides the minimum and maximum limits that define the range of allowable values that may be used in the numInputSamples parameter when calling the SetNumInputSamples() member function.

The limits provided apply to both 200 kHz and 50 kHz frequencies.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Parameters

[out]	pMinInputSamples	Pointer to location into which this function will store the lower limit. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxInputSamples	Pointer to location into which this function will will store the upper limit. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: SetNumInputSamples()

STFF::STFishFinder::GetRangeLimits	(	FF_DepthUnits_t	units,
		uint32_t *	pMinRangeDeep,
		uint32_t *	pMaxRangeDeep
	)		const

#include <STFF-FishFinder.h>

Getter function to provide limits for the parameter to the SetRange() member function.

This function provides the minimum and maximum limits that define the range of allowable values that may be used in the rangeDeep field of the pRangeSetting parameter when calling the SetRange() member function.

The limits provided apply to both 200 kHz and 50 kHz frequencies.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Note

This function does not pertain directly to the rangeShallow field of the pRangeSetting parameter. The limits for the rangeShallow field depend on the current value of the rangeDeep field as follows:
0 <= rangeShallow <= (rangeDeep - pMinRangeDeep)
Separate values are provided for each of the different depth units settings that reflect natural grid divisions for the given units. For example, the minimum range limit in fathoms might be 1.0 fathom, and the minimum range limit in meters might be 2.0 meters, even though these do not refer to the same depth. The units provided when calling this function should therefore be the same as the units that will be used when calling SetRange().

Parameters

[in]	units	The depth units for which and in which the `pMinRangeDeep` and `pMaxRangeDeep` values will be provided.
[out]	pMinRangeDeep	Pointer to location into which this function will store the minimum allowable value for the rangeDeep member of the range setting for the specified depth units. The value provided will be in hundredths of the unit specified by the `units` parameter. For example, if the provided `units` parameter is FF_DEPTH_UNITS_METERS, and the limit is 2 meters, then the value stored in *pMinRangeDeep will be 200. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxRangeDeep	Pointer to location into which this function will store the maximum allowable value for the rangeDeep member of the range setting for the specified depth units. The value provided will be in hundredths of the unit specified by the `units` parameter. For example, if the provided `units` parameter is FF_DEPTH_UNITS_METERS, and the limit is 300 meters, then the value stored in *pMaxRangeDeep will be 30,000. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: SetRange()

STFF::STFishFinder::GetSpeedPulsesPerNauticalMileLimits	(	uint32_t *	pMinSpeedPPNM,
		uint32_t *	pMaxSpeedPPNM
	)		const

#include <STFF-FishFinder.h>

Getter function to provide limits for the parameter to the SetSpeedPulsesPerNauticalMile() member function.

This function provides the minimum and maximum limits that define the range of allowable values that may be used in the speedPPNM parameter when calling the SetSpeedPulsesPerNauticalMile() member function.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Parameters

[out]	pMinSpeedPPNM	Pointer to location into which this function will store the lower limit. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxSpeedPPNM	Pointer to location into which this function will will store the upper limit. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: SetSpeedPulsesPerNauticalMile()

STFF::STFishFinder::GetTemperatureOffsetLimits	(	FF_TemperatureUnits_t	units,
		int16_t *	pMinTempOffset,
		int16_t *	pMaxTempOffset
	)		const

#include <STFF-FishFinder.h>

Getter function to provide limits for the parameter to the SetTemperatureOffset() member function.

This function provides the minimum and maximum limits that define the range of allowable values that may be used in the temperatureOffset parameter when calling the SetTemperatureOffset() member function.

The provided limits are read-only, and are defined by the black box. They do not change during the course of a session. There is no corresponding setter function for changing the limits.

Parameters

[in]	units	The requested temperature units in which the `pMinTempOffset` and `pMaxTempOffset` values will be provided. The values will be converted by this function to the units specified in this parameter.
[out]	pMinTempOffset	Pointer to location into which this function will store the lower limit. The value provided will be in hundredths of the unit specified in the `units` parameter. For example, if the lower limit is -10 degrees C, and the provided `units` parameter is FF_TEMPERATURE_UNITS_CELSIUS, then the value stored in *pMinTempOffset will be -1000. If this parameter is a null pointer, then no value will be stored.
[out]	pMaxTempOffset	Pointer to location into which this function will store the upper limit. The value provided will be in hundredths of the unit specified in the `units` parameter. For example, if the upper limit is +10 degrees C, and the provided `units` parameter is FF_TEMPERATURE_UNITS_CELSIUS, then value stored in *pMaxTempOffset will be 1000. If this parameter is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_API_NOT_INITIALIZED	if the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASE	if the API encounters an internal error

Note: Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

See also: SetTemperatureOffset()