Functions that retrieve depth, speed, temperature, and battery voltage data from the connected black box fish finder. More...

Functions
FF_Error_t	STFF::STFishFinder::GetTemperature (FF_TemperatureUnits_t units, FF_TemperatureData_t *pTemperatureData) const
	Getter function to provide the current water temperature data. More...

FF_Error_t	STFF::STFishFinder::GetSpeed (FF_SpeedUnits_t units, FF_SpeedData_t *pSpeedData) const
	Getter function to provide the current Speed Through Water data. More...

FF_Error_t	STFF::STFishFinder::GetDepth (FF_DepthUnits_t units, FF_DepthData_t *pDepthData) const
	Getter function to provide the current Depth data. More...

FF_Error_t	STFF::STFishFinder::GetBatteryVoltage (FF_BatteryVoltageData_t *pBatteryVoltageData) const
	Getter function to provide the current Battery Voltage data. More...

Detailed Description

Functions that retrieve depth, speed, temperature, and battery voltage data from the connected black box fish finder.

These are member functions of the STFishFinder class.

Note: The function to retrieve image data is not a member of the STFishFinder class, but is in fact a member of the STFishFinder::ImageColumn class. See STFishFinder::ImageColumn::GetImageData().

See also: Getters for Local Settings; Getters for Master Settings; Getters for Attributes; Getters for Limits

Function Documentation

STFF::STFishFinder::GetBatteryVoltage ( FF_BatteryVoltageData_t * pBatteryVoltageData ) const

#include <STFF-FishFinder.h>

Getter function to provide the current Battery Voltage data.

Parameters

[out] pBatteryVoltageData pointer to a location where the requested Battery Voltage data will be stored. The *pBatteryVoltageData value is a struct of type FF_BatteryVoltageData_t. The struct contains a voltage member containing the current voltage of the battery powering the black box, in hundredths of a volt, and a status value that indicates whether the provided battery voltage value is valid, invalid, simulated, or a log playback. The application should not display an invalid value, or should clearly indicate that the displayed value is invalid. If pBatteryVoltageData 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

Remarks: Typically, this function would be called as a result of the Callback_DataItemReceived_t callback function being called with a FF_DataType_t parameter of FF_DATA_TYPE_BATTERY_VOLTAGE.

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.

STFF::STFishFinder::GetDepth	(	FF_DepthUnits_t	units,
		FF_DepthData_t *	pDepthData
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Depth data.

Parameters

[in]	units	the requested depth units (feet, meters, or fathoms) in which the data value will be provided
[out]	pDepthData	pointer to a location where the requested Depth data will be stored. The `*pDepthData` value is a struct of type FF_DepthData_t. The struct contains a units member that will mirror the units parameter in the call to this function, a depth member containing the current depth in hundredths of the specified units, and a status value that indicates whether the provided depth value is valid, invalid, simulated, or a log playback. The application should not display an invalid value, or should clearly indicate that the displayed value is invalid. If `pDepthData` is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_ARGUMENT_OUT_OF_RANGE	if the value provided in the `units` parameter is outside the range of allowable values.
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

Remarks: Typically, this function would be called as a result of the Callback_DataItemReceived_t callback function being called with a FF_DataType_t parameter of FF_DATA_TYPE_DEPTH.

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.

STFF::STFishFinder::GetSpeed	(	FF_SpeedUnits_t	units,
		FF_SpeedData_t *	pSpeedData
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Speed Through Water data.

Parameters

[in]	units	the requested speed units (knots, mph, or kph) in which the data value will be provided
[out]	pSpeedData	pointer to a location where the requested Speed data will be stored. The `*pSpeedData` value is a struct of type FF_SpeedData_t. The struct contains a units member that will mirror the units parameter in the call to this function, a speed member containing the current speed in hundredths of the specified units, and a status value that indicates whether the provided speed value is valid, invalid, simulated, or a log playback. The application should not display an invalid value, or should clearly indicate that the displayed value is invalid. If `pSpeedData` is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_ARGUMENT_OUT_OF_RANGE	if the value provided in the `units` parameter is outside the range of allowable values.
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

Remarks: Typically, this function would be called as a result of the Callback_DataItemReceived_t callback function being called with a FF_DataType_t parameter of FF_DATA_TYPE_SPEED.

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.

STFF::STFishFinder::GetTemperature	(	FF_TemperatureUnits_t	units,
		FF_TemperatureData_t *	pTemperatureData
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current water temperature data.

The temperature data reported by this function will have already been adjusted by the Temperature Offset master setting.

Parameters

[in]	units	the requested temperature units (Celsius or Fahrenheit) in which the data value will be provided
[out]	pTemperatureData	pointer to a location where the requested Temperature data will be stored. The `*pTemperatureData` value is a struct of type FF_TemperatureData_t. The struct contains a units member that will mirror the units parameter in the call to this function, a temperature member containing the current water temperature in hundredths of the specified units, and a status value that indicates whether the provided temperature value is valid, invalid, simulated, or a log playback. The application should not display an invalid value, or should clearly indicate that the displayed value is invalid. If `pTemperatureData` is a null pointer, then no value will be stored.

Return values

FF_ERR_NO_ERROR	if the operation completed successfully
FF_ERR_ARGUMENT_OUT_OF_RANGE	if the value provided in the `units` parameter is outside the range of allowable values.
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

Remarks: Typically, this function would be called as a result of the Callback_DataItemReceived_t callback function being called with a FF_DataType_t parameter of FF_DATA_TYPE_TEMPERATURE.

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.