Common/Utility/Misc
[Common/Utility]

Collaboration diagram for Common/Utility/Misc:


Classes

class  Args
 This is a base class for those that parse and hold arguments of the type usually passed from a process invocation. More...
class  GoNogo
 A class to provide "GO" and OK status to objects. More...
struct  Ltstr
 A class supporting a number of container classes (e.g. More...

Typedefs

typedef std::list< std::string > Args::ProblemReport
 A problem report type.
typedef ProblemReport::iterator Args::ProblemReportIterator
 An iterator to the problem report type.
typedef ProblemReport::const_iterator Args::ConstProblemReportIterator
 A const iterator to the problem report type.

Functions

virtual Args::~Args ()
 Dtor.
 Args::Args (const Args &rhs)
 Copy ctor.
ArgsArgs::operator= (const Args &rhs)
 The copy operator.
bool Args::operator== (const Args &rhs) const
 Equality operator.
bool Args::operator!= (const Args &rhs) const
 Inequality operator.
bool Args::go () const
 Give the GO state of the object.
const std::string & Args::argv0 () const
 Give the argv[0] setting - i.e.
virtual std::string Args::usage () const
 Give the usage.
std::string Args::report ()
 Give the next problem report;.
bool Args::existingProblems () const
 Are there existing problems to report?
void Args::problem (const std::string argument)
 Add a new problem.

Variables

bool Args::go_state

Typedef Documentation

typedef std::list<std::string> Args::ProblemReport [inherited]

A problem report type.

Definition at line 87 of file Args.h.

typedef ProblemReport::iterator Args::ProblemReportIterator [inherited]

An iterator to the problem report type.

Definition at line 92 of file Args.h.

typedef ProblemReport::const_iterator Args::ConstProblemReportIterator [inherited]

A const iterator to the problem report type.

Definition at line 97 of file Args.h.


Function Documentation

virtual Args::~Args (  )  [virtual, inherited]

Dtor.

Args::Args ( const Args rhs  )  [inherited]

Copy ctor.

Parameters:
rhs The reference object.

Args& Args::operator= ( const Args rhs  )  [inherited]

The copy operator.

Parameters:
rhs The reference object.
Returns:
This object.

bool Args::operator== ( const Args rhs  )  const [inherited]

Equality operator.

Parameters:
rhs The reference object.
Returns:
If this object and the reference object are equal then true.

bool Args::operator!= ( const Args rhs  )  const [inherited]

Inequality operator.

Parameters:
rhs The reference object.
Returns:
The negation of the equality operator.

bool Args::go (  )  const [inherited]

Give the GO state of the object.

If NOGO then some fatal problem exists with the arguments.

Returns:
The GO state - true if GO.

const std::string& Args::argv0 (  )  const [inherited]

Give the argv[0] setting - i.e.

the process name.

Returns:
The process name.

virtual std::string Args::usage (  )  const [virtual, inherited]

Give the usage.

Returns:
Text containing the name (i.e. argv[0]) of this program.

std::string Args::report (  )  [inherited]

Give the next problem report;.

Returns:
A iterator to the text.

bool Args::existingProblems (  )  const [inherited]

Are there existing problems to report?

Returns:
If there are then true.

void Args::problem ( const std::string  argument  )  [protected, inherited]

Add a new problem.

Parameters:
argument A textual description of the problem.


Variable Documentation

bool Args::go_state [protected, inherited]

Definition at line 120 of file Args.h.