Driver.cpp File Reference

Implements the main function of the executable, and other high-level functions. More...

Functions
int	main (int argc, char **argv)
	Main function of the driver executable.
DrvrReturnCode	ParseArguments (int argc, char **argv, DrvrParams &params)
	Parse the command line arguments.
void	Help (std::ostream &os)
	Print help instructions to the terminal.
DrvrReturnCode	ValidateInputs (const DrvrParams &params)
	Validate that required inputs are present for the mode specified by the user.

Detailed Description

Implements the main function of the executable, and other high-level functions.

Function Documentation

Help()

void Help

(

std::ostream &

os

)

Print help instructions to the terminal.

Parameters

[in]

os

Output stream for writing; defaults to std::cout

main()

int main	(	int	argc,
		char **	argv )

Main function of the driver executable.

Parameters

[in]	argc	Number of arguments entered on the command line
[in]	argv	Array containing the provided command-line arguments

Returns

Return code

ParseArguments()

DrvrReturnCode ParseArguments	(	int	argc,
		char **	argv,
		DrvrParams &	params )

Parse the command line arguments.

Parameters

[in]	argc	Number of arguments
[in]	argv	Command line arguments
[out]	params	Structure with user input params

Returns

Return code

ValidateInputs()

DrvrReturnCode ValidateInputs

(

const DrvrParams &

params

)

Validate that required inputs are present for the mode specified by the user.

This function DOES NOT check the validity of the parameter values, only that required parameters have been specified by the user

Parameters

[in]

params

Structure with user input parameters

Returns

Return code