STFF Namespace Reference

This is the namespace containing the platform-independent STFishFinder API. More...

Classes
class	ImageColumn
	The ImageColumn class is a container for sample data retrieved from a single sonar ping. More...
class	Replay
	Replay class. More...
class	STFishFinder
	This is the main class for the STFishFinder API. More...
class	Version
	The Version class provides software version information. More...

Typedefs
typedef void(*	Callback_SettingChanged_t) (const STFishFinder *, FF_SettingType_t, FF_Frequency_t)
	'Setting Changed' callback. More...
typedef void(*	Callback_DataItemReceived_t) (const STFishFinder *, FF_DataType_t, const void *)
	'Data Item Received' callback. More...
typedef void(*	Callback_DepthAlarmStateChange_t) (const STFishFinder *, FF_DepthAlarmType_t)
	'Depth Alarm State Change' callback. More...
typedef void(*	Callback_FishAlarmTrigger_t) (const STFishFinder *, FF_FishData_t)
	'Fish Alarm Trigger' callback. More...
typedef void(*	Callback_StreamDataToFF_t) (const STFishFinder *, const char *, uint32_t)
	'Stream Data to FishFinder' callback. More...

Functions
FF_Error_t	ConvertDepth (FF_DepthUnits_t fromUnits, FF_DepthUnits_t toUnits, double input, double *pOutput)
	Convert a depth value from one set of units (feet, meters, or fathoms) to another. More...
FF_Error_t	ConvertSpeed (FF_SpeedUnits_t fromUnits, FF_SpeedUnits_t toUnits, double input, double *pOutput)
	Convert a speed value from one set of units (knots, miles per hour, or kilometers per hour) to another. More...
FF_Error_t	ConvertTemperature (FF_TemperatureUnits_t fromUnits, FF_TemperatureUnits_t toUnits, double input, double *pOutput)
	Convert a temperature value from one set of units (degrees Celsius or degrees Fahrenheit) to the other. More...
bool	valid (FF_Frequency_t frequency)
	Test that a value is valid for a variable of type FF_Frequency_t. More...
bool	valid (FF_DepthUnits_t units)
	Test that a value is valid for a variable of type FF_DepthUnits_t. More...
bool	valid (FF_SpeedUnits_t units)
	Test that a value is valid for a variable of type FF_SpeedUnits_t. More...
bool	valid (FF_TemperatureUnits_t units)
	Test that a value is valid for a variable of type FF_TemperatureUnits_t. More...
bool	valid (FF_SettingType_t settingType)
	Test that a value is valid for a variable of type FF_SettingType_t. More...
bool	valid (FF_DataType_t dataType)
	Test that a value is valid for a variable of type FF_DataType_t. More...
bool	valid (FF_ControlCommand_t controlCommand)
	Test that a value is valid for a variable of type FF_ControlCommand_t. More...
bool	valid (FF_FrequencyMode_t frequencyMode)
	Test that a value is valid for a variable of type FF_FrequencyMode_t. More...
bool	valid (FF_AutoRangeSetting_t autoRangeSetting)
	Test that a value is valid for a variable of type FF_AutoRangeSetting_t. More...
bool	valid (FF_AutoGainSetting_t autoGainSetting)
	Test that a value is valid for a variable of type FF_AutoGainSetting_t. More...
bool	valid (FF_DepthAlarmType_t depthAlarmType)
	Test that a value is valid for a variable of type FF_DepthAlarmType_t. More...
bool	valid (FF_DepthAlarmState_t depthAlarmState)
	Test that a value is valid for a variable of type FF_DepthAlarmState_t. More...
bool	valid (FF_FishAlarmSetting_t fishAlarmSetting)
	Test that a value is valid for a variable of type ::FF_FishAlarmSetting_t. More...
bool	valid (FF_ApiStatus_t apiStatus)
	Test that a value is valid for a variable of type FF_ApiStatus_t. More...

Detailed Description

This is the namespace containing the platform-independent STFishFinder API.

Within the STFF namespace, the API contains four classes: STFishFinder, ImageColumn, Replay, and Version, and a few non-member utility functions for performing units conversions and value checking.