Args Class Reference
[Common/Utility/Misc]

This is a base class for those that parse and hold arguments of the type usually passed from a process invocation. More...

#include <Args.h>

List of all members.

Public Types
typedef std::list< std::string >	ProblemReport
	A problem report type.
typedef ProblemReport::iterator	ProblemReportIterator
	An iterator to the problem report type.
typedef ProblemReport::const_iterator	ConstProblemReportIterator
	A const iterator to the problem report type.
Public Member Functions
	Args (int argc, const char *const argv[])
	Ctor.
virtual	~Args ()
	Dtor.
	Args (const Args &rhs)
	Copy ctor.
Args &	operator= (const Args &rhs)
	The copy operator.
bool	operator== (const Args &rhs) const
	Equality operator.
bool	operator!= (const Args &rhs) const
	Inequality operator.
bool	go () const
	Give the GO state of the object.
const std::string &	argv0 () const
	Give the argv[0] setting - i.e.
virtual std::string	usage () const
	Give the usage.
std::string	report ()
	Give the next problem report;.
bool	existingProblems () const
	Are there existing problems to report?
Protected Member Functions
void	problem (const std::string argument)
	Add a new problem.
Protected Attributes
bool	go_state

---

Detailed Description

This is a base class for those that parse and hold arguments of the type usually passed from a process invocation.

The derived classes will usually add member functions that are specific to the arguments parsed and can be used to obtain the various arguments.

Definition at line 20 of file Args.h.

---

Constructor & Destructor Documentation

Args::Args	(	int	argc,
		const char *const	argv[]
	)

Ctor.

Init this object with go() == true if GO. Setup the problem report stuff.

Parameters:

	argc	The number of user arguments as passed from the system
	argv	The user arguments as passed from the system.

---

The documentation for this class was generated from the following file:

• Args.h

Generated on Sat Nov 22 12:37:35 2008 for Swath Sonar by Doxygen 1.5.1