DtCmdLine::ArgException Class Reference

A simple class that defines and argument exception. More...

Inheritance diagram for DtCmdLine::ArgException:

Collaboration diagram for DtCmdLine::ArgException:

Public Member Functions
	ArgException (const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic ArgException")
	Constructor.
virtual	~ArgException () throw ()
	Destructor.
std::string	error () const
	Returns the error text.
std::string	argId () const
	Returns the argument id.
const char *	what () const throw ()
	Returns the arg id and error text.
std::string	typeDescription () const
	Returns the type of the exception.

Private Attributes
std::string	_errorText
	The text of the exception message.
std::string	_argId
	The argument related to this exception.
std::string	_typeDescription
	Describes the type of the exception.
std::string	_ex
	The exception text.

Detailed Description

A simple class that defines and argument exception.

Should be caught whenever a CmdLine is created and parsed.

Constructor & Destructor Documentation

DtCmdLine::ArgException::ArgException ( const std::string &  text = "undefined exception", const std::string &  id = "undefined", const std::string &  td = "Generic ArgException"  )

inline

Constructor.

Parameters

text	- The text of the exception.
id	- The text identifying the argument source.
td	- Text describing the type of ArgException it is. of the exception.

virtual DtCmdLine::ArgException::~ArgException ( ) throw ()

inlinevirtual

Destructor.

Member Function Documentation

std::string DtCmdLine::ArgException::argId ( ) const

inline

Returns the argument id.

Referenced by DtCmdLine::StdOutput::failure().

std::string DtCmdLine::ArgException::error ( ) const

inline

Returns the error text.

Referenced by DtCmdLine::StdOutput::failure(), and DtCmdLine::CmdLine::parse().

std::string DtCmdLine::ArgException::typeDescription ( ) const

inline

Returns the type of the exception.

Used to explain and distinguish between different child exceptions.

const char* DtCmdLine::ArgException::what ( ) const throw ()

inline

Returns the arg id and error text.

Referenced by DtCmdLine::DocBookOutput::failure().

Member Data Documentation

std::string DtCmdLine::ArgException::_argId

private

The argument related to this exception.

std::string DtCmdLine::ArgException::_errorText

private

The text of the exception message.

std::string DtCmdLine::ArgException::_ex

mutableprivate

The exception text.

Created when calling what().

std::string DtCmdLine::ArgException::_typeDescription

private

Describes the type of the exception.

Used to distinguish between different child exceptions.

---

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

• cmdArgException.h