Functions that retrieve information about Master Settings that affect all display devices connected to the present black box fish finder. More...

Functions
FF_Error_t	STFF::STFishFinder::GetTemperatureOffset (FF_TemperatureUnits_t units, int16_t pTemperatureOffset, FF_SettingStatus_t pStatus) const
	Getter function to provide the current Temperature Offset master setting. More...

FF_Error_t	STFF::STFishFinder::GetSpeedPulsesPerNauticalMile (uint32_t pSpeedPPNM, FF_SettingStatus_t pStatus) const
	Getter function to provide the current Speed PPNM master setting. More...

FF_Error_t	STFF::STFishFinder::GetDepthAlarmSettings (FF_DepthUnits_t pUnits, uint32_t pShallowAlarm, uint32_t pDeepAlarm, FF_SettingStatus_t pStatus) const
	Getter function to provide the current Depth Alarm master settings. More...

Detailed Description

Functions that retrieve information about Master Settings that affect all display devices connected to the present black box fish finder.

Master Settings are stored in nonvolatile memory within the black box. They are changeable, and globally affect all displays and applications that are simultaneously connected to the same black box. These are member functions of the STFishFinder class.

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

Function Documentation

STFF::STFishFinder::GetDepthAlarmSettings	(	FF_DepthUnits_t *	pUnits,
		uint32_t *	pShallowAlarm,
		uint32_t *	pDeepAlarm,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Depth Alarm master settings.

Parameters

[out]	pUnits	Pointer to location into which this function will store the depth units in which the Depth Alarms were originally specified. If this parameter is a null pointer, then no value will be stored.
[out]	pShallowAlarm	Pointer to location into which this function will store the current Shallow Depth Alarm master setting. The value provided will be in hundredths of the unit reported in the `pUnits` value. For example, if the reported `pUnits` value is FF_DEPTH_UNITS_METERS, and the reported *pShallowAlarm value is 300, then this represents a Shallow Depth Alarm setting of 3.0 meters. If the stored value is 0, this indicates that the Shallow Depth Alarm is disabled. If this parameter is a null pointer, then no value will be stored.
[out]	pDeepAlarm	Pointer to location into which this function will store the current Deep Depth Alarm master setting. The value provided will be in hundredths of the unit reported in the `*pUnits` value. (See the example above in the description for the `pShallowAlarm` parameter.) If the stored value is 0, this indicates that the Deep Depth Alarm is disabled. 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 Depth Alarm master settings. 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: SetDepthAlarmSettings()

STFF::STFishFinder::GetSpeedPulsesPerNauticalMile	(	uint32_t *	pSpeedPPNM,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Speed PPNM master setting.

Parameters

[out]	pSpeedPPNM	Pointer to location into which this function will store the current Speed PPNM master 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 PPNM master 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: SetSpeedPulsesPerNauticalMile()

STFF::STFishFinder::GetTemperatureOffset	(	FF_TemperatureUnits_t	units,
		int16_t *	pTemperatureOffset,
		FF_SettingStatus_t *	pStatus
	)		const

#include <STFF-FishFinder.h>

Getter function to provide the current Temperature Offset master setting.

Parameters

[in]	units	The requested temperature units in which the `pTemperatureOffset` will be provided.
[out]	pTemperatureOffset	Pointer to location into which this function will store the current Temperature Offset master 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 Temperature Offset master 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: SetTemperatureOffset()