arginput.hΒΆ

A header file containing function prototypes for the corresponding .cpp file.

Functions

void InitialiseArguments(void)

Function in which all code input parameters are specified as members of an ArgumentList.

See
GeneralInputArgument, ArgumentList

void PrintUsage(void)

Function which loops over the ArgumentList and prints to screen all available arguments, flags and descriptions.

void ParameterFileRead(const char * param_file_name)

Function which searches a parameter file for all parameters expected from the ArgumentList and reads their values.

See
ArgumentList
Parameters
  • parameter_file_location -

    path to target parameter file

int param_cmd_parse(int argc, char * argv[])

Function which searches a the command line input for all parameters expected from the ArgumentList and reads their values.

See
ArgumentList
Parameters
  • argc -

    number of terminal arguments

  • argv -

    array of terminal arguments as constant character arrays (c strings)