CommandLineArguments Class Reference

#include <CommandLineArguments.hpp>

Collaboration diagram for CommandLineArguments:

Public Member Functions
bool	OptionExists (std::string option)
char *	GetValueCorrespondingToOption (std::string option, int valueNumber=1)
double	GetDoubleCorrespondingToOption (std::string option, int valueNumber=1)
int	GetIntCorrespondingToOption (std::string option, int valueNumber=1)
unsigned	GetUnsignedCorrespondingToOption (std::string option, int valueNumber=1)
std::string	GetStringCorrespondingToOption (std::string option, int valueNumber=1)
std::vector< std::string >	GetStringsCorrespondingToOption (std::string option)
std::vector< double >	GetDoublesCorrespondingToOption (std::string option)
std::vector< int >	GetIntsCorrespondingToOption (std::string option)
std::vector< unsigned >	GetUnsignedsCorrespondingToOption (std::string option)
Static Public Member Functions
static CommandLineArguments *	Instance ()
Public Attributes
int *	p_argc
char ***	p_argv
Private Member Functions
	CommandLineArguments ()
int	GetIndexForArgument (std::string argument)
int	GetNumberOfArgumentsForOption (std::string option)
void	TestOptionFormat (std::string option)
Static Private Attributes
static CommandLineArguments *	mpInstance = NULL

Detailed Description

A convenient holder for the command line arguments, with helper methods for checking whether an option has been given or getting the value(s) corresponding to a given option.

Options are considered to be any argument starting witha '-' followed by a non-numeric character, in order to distinguish between options and negative numbers. Each option may have zero or more values following it on the command line. Examples:

-option1 on
--my_param value
--verbose
-numbers 1 8 -4.5
--models model1 model2

The cxxtest harness will fill in the member variables when a test is started. They can then be read by PETSc when it is initialised, and by other code as required.

Definition at line 55 of file CommandLineArguments.hpp.

Constructor & Destructor Documentation

CommandLineArguments::CommandLineArguments ( ) [private]

Default constructor. Should never be called directly, call CommandLineArguments::Instance() instead.

Definition at line 34 of file CommandLineArguments.cpp.

References mpInstance.

Member Function Documentation

double CommandLineArguments::GetDoubleCorrespondingToOption	(	std::string	option,
		int	valueNumber = `1`
	)

Get the double for a given option.

This uses GetValueCorrespondingToOption and converts the char* to a double.

Parameters:

	option	the option name as a string.
	valueNumber	the number of the argument following the option definiton (defaults to 1, for 1st argument).

Definition at line 73 of file CommandLineArguments.cpp.

References GetValueCorrespondingToOption().

Referenced by GetDoublesCorrespondingToOption().

std::vector< double > CommandLineArguments::GetDoublesCorrespondingToOption ( std::string option )

Get a collection of doubles for a given option.

This uses GetDoubleCorrespondingToOption repeatedly.

Parameters:

option

the option name as a string.

Definition at line 155 of file CommandLineArguments.cpp.

References GetDoubleCorrespondingToOption(), and GetNumberOfArgumentsForOption().

int CommandLineArguments::GetIndexForArgument ( std::string argument ) [private]

Get the index for the given argument. Returns -1 if the argument is not found.

Parameters:

argument

the argument name as a string.

Returns:: the position of the argument in the list (indexed from 1)

Definition at line 96 of file CommandLineArguments.cpp.

References p_argc, p_argv, and TestOptionFormat().

Referenced by GetNumberOfArgumentsForOption(), GetValueCorrespondingToOption(), and OptionExists().

int CommandLineArguments::GetIntCorrespondingToOption	(	std::string	option,
		int	valueNumber = `1`
	)

Get the int for a given option.

This uses GetValueCorrespondingToOption and converts the char* to an int.

Parameters:

	option	the option name as a string.
	valueNumber	the number of the argument following the option definiton (defaults to 1, for 1st argument).

Definition at line 79 of file CommandLineArguments.cpp.

References GetValueCorrespondingToOption().

Referenced by GetIntsCorrespondingToOption().

std::vector< int > CommandLineArguments::GetIntsCorrespondingToOption ( std::string option )

Get a collection of ints for a given option.

This uses GetIntCorrespondingToOption repeatedly.

Parameters:

option

the option name as a string.

Definition at line 177 of file CommandLineArguments.cpp.

References GetIntCorrespondingToOption(), and GetNumberOfArgumentsForOption().

int CommandLineArguments::GetNumberOfArgumentsForOption ( std::string option ) [private]

Get the number of arguments for a given option. Throws an Exception if the option does not have any following arguments, or the option does not exist. So you can use OptionExists() to avoid Exceptions in your code when using the other public methods.

Parameters:

option

the option name as a string.

Returns:: the number of arguments following this option.

Definition at line 110 of file CommandLineArguments.cpp.

References EXCEPTION, GetIndexForArgument(), p_argc, and p_argv.

Referenced by GetDoublesCorrespondingToOption(), GetIntsCorrespondingToOption(), GetStringsCorrespondingToOption(), GetUnsignedsCorrespondingToOption(), and GetValueCorrespondingToOption().

std::string CommandLineArguments::GetStringCorrespondingToOption	(	std::string	option,
		int	valueNumber = `1`
	)

Get the string for a given option.

This uses GetValueCorrespondingToOption and converts the char* to a std::string.

Parameters:

	option	the option name as a string.
	valueNumber	the number of the argument following the option definiton (defaults to 1, for 1st argument).

Definition at line 137 of file CommandLineArguments.cpp.

References GetValueCorrespondingToOption().

Referenced by GetStringsCorrespondingToOption().

std::vector< std::string > CommandLineArguments::GetStringsCorrespondingToOption ( std::string option )

Get a collection of strings for a given option (useful for inputting a list of files for example).

This uses GetStringCorrespondingToOption repeatedly.

Parameters:

option

the option name as a string.

Definition at line 144 of file CommandLineArguments.cpp.

References GetNumberOfArgumentsForOption(), and GetStringCorrespondingToOption().

unsigned CommandLineArguments::GetUnsignedCorrespondingToOption	(	std::string	option,
		int	valueNumber = `1`
	)

Get the unsigned for a given option.

This uses GetValueCorrespondingToOption and converts the char* to an unsigned. Throws an exception if the option converts to a negative integer.

Parameters:

	option	the option name as a string.
	valueNumber	the number of the argument following the option definiton (defaults to 1, for 1st argument).

Definition at line 85 of file CommandLineArguments.cpp.

References EXCEPTION, and GetValueCorrespondingToOption().

Referenced by GetUnsignedsCorrespondingToOption().

std::vector< unsigned > CommandLineArguments::GetUnsignedsCorrespondingToOption ( std::string option )

Get a collection of unsigneds for a given option.

This uses GetUnsignedCorrespondingToOption repeatedly.

Parameters:

option

the option name as a string.

Definition at line 166 of file CommandLineArguments.cpp.

References GetNumberOfArgumentsForOption(), and GetUnsignedCorrespondingToOption().

char * CommandLineArguments::GetValueCorrespondingToOption	(	std::string	option,
		int	valueNumber = `1`
	)

Get the value for a given option, i.e. the argument after the option name in the list of command line arguments. For example, if the following arguments were given ./heart/build/debug/TestMyClassRunner -timestep 0.04 Then calling CommandLineArguments::Instance()->GetValueCorrespondingToOption("-timestep"); will return 0.04 (as a char*). Use atoi or atof to convert the char* to an int or a double(float) respectively, or call one of our convenience methods for common types.

Parameters: