Getters for Local Settings

Functions that retrieve information about changeable settings that are local to the present application. More...

Functions
FF_Error_t	STFF::STFishFinder::GetNumInputSamples (uint16_t *pNumInputSamples, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current setting for the number of samples that will be provided by the black box when transferring each column of image data to the API. More...
FF_Error_t	STFF::STFishFinder::GetFrequencyMode (FF_FrequencyMode_t *pFrequencyMode, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Frequency Mode setting. More...
FF_Error_t	STFF::STFishFinder::GetAutoGainSetting (FF_AutoGainSetting_t *pAutoGainSetting, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Auto Gain setting. More...
FF_Error_t	STFF::STFishFinder::GetAutoRangeSetting (FF_AutoRangeSetting_t *pAutoRange, FF_DepthUnits_t *pUnits, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Auto Range setting. More...
FF_Error_t	STFF::STFishFinder::GetRange (FF_RangeSetting_t *pRangeSetting, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Range setting. More...
FF_Error_t	STFF::STFishFinder::GetGain (FF_Frequency_t frequency, uint16_t *pGainSetting, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Gain setting. More...
FF_Error_t	STFF::STFishFinder::GetGainOffset (FF_Frequency_t frequency, int16_t *pGainOffset, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Gain Offset setting. More...
FF_Error_t	STFF::STFishFinder::GetGainColorOffsets (FF_Frequency_t frequency, uint16_t *pNumColors, uint16_t *pGainColorOffsets, FF_SettingStatus_t *pStatus) const
	Getter function to provide the number of colors used when generating the STFF::ImageColumn data, and the table of gain offset values used for separating the received sonar signal into its colors. More...
FF_Error_t	STFF::STFishFinder::GetFishIdSetting (FF_Frequency_t frequency, FF_FishIdSetting_t *pFishIdSetting, FF_SettingStatus_t *pStatus) const
	Getter function to provide the current Fish ID setting. More...

Detailed Description

Functions that retrieve information about changeable settings that are local to the present application.

These settings do not affect other displays and applications that are simultaneously connected to the same black box. These are member functions of the STFishFinder class.

Each of the functions in this category has a corresponding "setter" function that provides the ability to change the setting. See the "See also" section in each function description for a link to the corresponding setter for that function.

See also

Setters for Local Settings

Getters for Master Settings

Getters for Attributes

Getters for Limits

Getters for Data

Function Documentation

STFF::STFishFinder::GetAutoGainSetting	(	FF_AutoGainSetting_t *	pAutoGainSetting,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Auto Gain setting.

The Auto Gain setting is either FF_AUTO_GAIN_SETTING_MANUAL or FF_AUTO_GAIN_SETTING_AUTO.

A single Auto Gain setting applies to both the 200 kHz and 50 kHz frequency contexts.

Parameters

[out]	pAutoGainSetting	Pointer to location into which this function will store the current Auto Gain setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Auto 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

SetAutoGainSetting()

STFF::STFishFinder::GetAutoRangeSetting	(	FF_AutoRangeSetting_t *	pAutoRange,
		FF_DepthUnits_t *	pUnits,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Auto Range setting.

The Auto Range setting has one of the following values:

• FF_AUTO_RANGE_SETTING_MANUAL
• FF_AUTO_RANGE_SETTING_AUTO_RANGE
• FF_AUTO_RANGE_SETTING_AUTO_SHIFT

A single Auto Range setting applies to both the 200 kHz and 50 kHz frequency contexts.

Parameters

[out]	pAutoRange	Pointer to location into which this function will store the current Auto Range setting. If this parameter is a null pointer, then no value will be stored.
[out]	pUnits	Pointer to location into which this function will store the current depth units used for the Range setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Auto Range 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

SetAutoRangeSetting()

STFF::STFishFinder::GetFishIdSetting	(	FF_Frequency_t	frequency,
		FF_FishIdSetting_t *	pFishIdSetting,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Fish ID setting.

The provided Fish ID setting is an aggregate of type FF_FishIdSetting_t.

Parameters

[in]	frequency	The frequency context for which the Fish ID setting is requested.
[out]	pFishIdSetting	Pointer to location into which this function will store the current Fish ID setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Fish ID 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_INVALID_FREQUENCY	if the provided frequency parameter has an invalid value (see FF_Frequency_t)
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

SetFishIdSetting()

STFF::STFishFinder::GetFrequencyMode	(	FF_FrequencyMode_t *	pFrequencyMode,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Frequency Mode setting.

The Frequency Mode specifies whether the black box should provide image data for 200 kHz only, 50 kHz only, or alternating 200 kHz / 50 kHz.

Parameters

[out]	pFrequencyMode	Pointer to location into which this function will store the current Frequency Mode setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Frequency Mode 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

SetFrequencyMode()

STFF::STFishFinder::GetGain	(	FF_Frequency_t	frequency,
		uint16_t *	pGainSetting,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Gain setting.

Parameters

[in]	frequency	The frequency context for which the Gain setting is requested.
[out]	pGainSetting	Pointer to location into which this function will store the current Gain setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided 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_INVALID_FREQUENCY	if the provided frequency parameter has an invalid value (see FF_Frequency_t)
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::GetGainColorOffsets	(	FF_Frequency_t	frequency,
		uint16_t *	pNumColors,
		uint16_t *	pGainColorOffsets,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the number of colors used when generating the STFF::ImageColumn data, and the table of gain offset values used for separating the received sonar signal into its colors.

Parameters

[in]	frequency	the frequency context for which the Gain Color Offsets data is requested.
[in]	pNumColors	pointer to location into which this function will store the number of colors used. If this parameter is a null pointer, then no value will be stored.
[in]	pGainColorOffsets	pointer to location into which this function will store an array of Gain Color Offset values. The number of values stored in the array will be (*pNumColors - 2). If this parameter is a null pointer, then no array values will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Gain Color Offsets data. 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_INVALID_FREQUENCY	if the provided frequency parameter has an invalid value (see FF_Frequency_t)
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.

Remarks

It is recommended that this function be called twice: On the first call, set the pGainColorOffsets parameter to null, and read the pNumColors value. This will provide the size of the array to allocate. After allocating the memory for the array, call this function a second time to read the array into the allocated memory.

See the description of the SetGainColorOffsets() function for an explanation of the meaning of the pGainColorOffsets array.

See also

SetGainColorOffsets()

STFF::STFishFinder::GetGainOffset	(	FF_Frequency_t	frequency,
		int16_t *	pGainOffset,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Gain Offset setting.

Parameters

[in]	frequency	The frequency context for which the Gain Offset setting is requested.
[out]	pGainOffset	Pointer to location into which this function will store the current Gain Offset setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided 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_INVALID_FREQUENCY	if the provided frequency parameter has an invalid value (see FF_Frequency_t)
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::GetNumInputSamples	(	uint16_t *	pNumInputSamples,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current setting for the number of samples that will be provided by the black box when transferring each column of image data to the API.

A single Number of Input Samples setting applies to both the 200 kHz and 50 kHz frequency contexts.

Parameters

[out]	pNumInputSamples	Pointer to location into which this function will store the current Number of Input Samples setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Number of Input Samples 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

SetNumInputSamples()

STFF::STFishFinder::GetRange	(	FF_RangeSetting_t *	pRangeSetting,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Range setting.

The provided Range setting is an aggregate of type FF_RangeSetting_t, containing a shallow depth, a deep depth, and a depth units specifier.

A single Range setting applies to both the 200 kHz and 50 kHz frequency contexts.

Parameters

[out]	pRangeSetting	Pointer to location into which this function will store the current Range setting. If this parameter is a null pointer, then no value will be stored.
[out]	pStatus	Pointer to location into which this function will store the status (invalid, pending, or valid) of the provided Range 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

SetRange()