STFishFinder API  API version 0.0.0, Documentation version 3 -PRELIMINARY-
STFF-Utility.h File Reference

Header file containing declarations for free functions in the STFF:: namespace that perform. More...

Go to the source code of this file.

Namespaces

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

Functions

FF_Error_t STFF::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 STFF::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 STFF::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 STFF::valid (FF_Frequency_t frequency)
 Test that a value is valid for a variable of type FF_Frequency_t. More...
 
bool STFF::valid (FF_DepthUnits_t units)
 Test that a value is valid for a variable of type FF_DepthUnits_t. More...
 
bool STFF::valid (FF_SpeedUnits_t units)
 Test that a value is valid for a variable of type FF_SpeedUnits_t. More...
 
bool STFF::valid (FF_TemperatureUnits_t units)
 Test that a value is valid for a variable of type FF_TemperatureUnits_t. More...
 
bool STFF::valid (FF_SettingType_t settingType)
 Test that a value is valid for a variable of type FF_SettingType_t. More...
 
bool STFF::valid (FF_DataType_t dataType)
 Test that a value is valid for a variable of type FF_DataType_t. More...
 
bool STFF::valid (FF_ControlCommand_t controlCommand)
 Test that a value is valid for a variable of type FF_ControlCommand_t. More...
 
bool STFF::valid (FF_FrequencyMode_t frequencyMode)
 Test that a value is valid for a variable of type FF_FrequencyMode_t. More...
 
bool STFF::valid (FF_AutoRangeSetting_t autoRangeSetting)
 Test that a value is valid for a variable of type FF_AutoRangeSetting_t. More...
 
bool STFF::valid (FF_AutoGainSetting_t autoGainSetting)
 Test that a value is valid for a variable of type FF_AutoGainSetting_t. More...
 
bool STFF::valid (FF_DepthAlarmType_t depthAlarmType)
 Test that a value is valid for a variable of type FF_DepthAlarmType_t. More...
 
bool STFF::valid (FF_DepthAlarmState_t depthAlarmState)
 Test that a value is valid for a variable of type FF_DepthAlarmState_t. More...
 
bool STFF::valid (FF_FishAlarmSetting_t fishAlarmSetting)
 Test that a value is valid for a variable of type ::FF_FishAlarmSetting_t. More...
 
bool STFF::valid (FF_ApiStatus_t apiStatus)
 Test that a value is valid for a variable of type FF_ApiStatus_t. More...
 

Detailed Description

Header file containing declarations for free functions in the STFF:: namespace that perform.

Definition in file STFF-Utility.h.