ReturnCodes.h File Reference

Defines return codes for the driver. More...

Go to the source code of this file.

Enumerations
enum	DrvrReturnCode {   DRVR__SUCCESS = 128 , DRVR__RETURN_SUCCESS , DRVRERR__MISSING_OPTION , DRVRERR__INVALID_OPTION ,   DRVRERR__OPENING_INPUT_FILE , DRVRERR__OPENING_OUTPUT_FILE , DRVRERR__PARSE = 160 , DRVRERR__PARSE_TX_TERMINAL_HEIGHT ,   DRVRERR__PARSE_RX_TERMINAL_HEIGHT , DRVRERR__PARSE_FREQUENCY , DRVRERR__PARSE_TX_POWER , DRVRERR__PARSE_SURFACE_REFRACTIVITY ,   DRVRERR__PARSE_PATH_DISTANCE , DRVRERR__PARSE_EPSILON , DRVRERR__PARSE_SIGMA , DRVRERR__PARSE_POLARIZATION ,   DRVRERR__VALIDATION_IN_FILE = 192 , DRVRERR__VALIDATION_OUT_FILE }
	Return Codes defined by this driver software (128-255) More...

Functions
std::string	GetDrvrReturnStatusMsg (int code)
	Get an error message string from a return code.

Detailed Description

Defines return codes for the driver.

Enumeration Type Documentation

DrvrReturnCode

enum DrvrReturnCode

Return Codes defined by this driver software (128-255)

Enumerator
DRVR__SUCCESS	Successful execution.
DRVR__RETURN_SUCCESS	Indicates driver should exit successfully.
DRVRERR__MISSING_OPTION	No value provided for given argument.
DRVRERR__INVALID_OPTION	Unknown option specified.
DRVRERR__OPENING_INPUT_FILE	Failed to open the input file for reading.
DRVRERR__OPENING_OUTPUT_FILE	Failed to open the output file for writing.
DRVRERR__PARSE	Failed parsing inputs; unknown parameter.
DRVRERR__PARSE_TX_TERMINAL_HEIGHT	Failed to parse TX terminal height value.
DRVRERR__PARSE_RX_TERMINAL_HEIGHT	Failed to parse RX terminal height value.
DRVRERR__PARSE_FREQUENCY	Failed to parse frequency value.
DRVRERR__PARSE_TX_POWER	Failed to parse transmit power value.
DRVRERR__PARSE_SURFACE_REFRACTIVITY	Failed to parse surface refractivity value.
DRVRERR__PARSE_PATH_DISTANCE	Failed to parse path distance value.
DRVRERR__PARSE_EPSILON	Failed to parse epsilon value.
DRVRERR__PARSE_SIGMA	Failed to parse sigma value.
DRVRERR__PARSE_POLARIZATION	Failed to parse polarization value.
DRVRERR__VALIDATION_IN_FILE	Input file not specified.
DRVRERR__VALIDATION_OUT_FILE	Output file not specified.

Function Documentation

GetDrvrReturnStatusMsg()

std::string GetDrvrReturnStatusMsg

(

int

code

)

Get an error message string from a return code.

Parameters

[in]

code

Driver return code.

Returns

A status message corresponding to the input code.