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_FREQ ,   DRVRERR__PARSE_THETA , DRVRERR__PARSE_PERCENTAGE , DRVRERR__PARSE_HEIGHT , DRVRERR__PARSE_STREET_WIDTH ,   DRVRERR__PARSE_REPR_HEIGHT , DRVRERR__PARSE_CLUTTER_TYPE , DRVRERR__PARSE_PATH_DIST , DRVRERR__VALIDATION_IN_FILE = 192 ,   DRVRERR__VALIDATION_OUT_FILE , DRVRERR__VALIDATION_MODEL }
	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_FREQ	Failed to parse frequency value.
DRVRERR__PARSE_THETA	Failed to parse theta value.
DRVRERR__PARSE_PERCENTAGE	Failed to parse percentage value.
DRVRERR__PARSE_HEIGHT	Failed to parse antenna height value.
DRVRERR__PARSE_STREET_WIDTH	Failed to parse street width value.
DRVRERR__PARSE_REPR_HEIGHT	Failed to parse representative height value.
DRVRERR__PARSE_CLUTTER_TYPE	Failed to parse clutter type value.
DRVRERR__PARSE_PATH_DIST	Failed to parse path distance value.
DRVRERR__VALIDATION_IN_FILE	Input file not specified.
DRVRERR__VALIDATION_OUT_FILE	Output file not specified.
DRVRERR__VALIDATION_MODEL	Model 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.