Class ArgException

Defined in File arg_exception.hpp

Inheritance Relationships

Base Type

public std::exception

Derived Types

public ecl::ArgParseException (Class ArgParseException)
public ecl::CmdLineParseException (Class CmdLineParseException)
public ecl::SpecificationException (Class SpecificationException)

Class Documentation

class ArgException : public std::exception

Defines the exception that is thrown whenever a command line is created and parsed.

A simple class that defines an argument exception. Should be caught whenever a CmdLine is created and parsed.

Subclassed by ecl::ArgParseException, ecl::CmdLineParseException, ecl::SpecificationException

Public Functions

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

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.

inline virtual ~ArgException(): Destructor.

inline std::string error() const: Returns the error text.

inline std::string argId() const: Returns the argument id.

inline const char *what() const: Returns the arg id and error text.

inline std::string typeDescription() const: Returns the type of the exception. Used to explain and distinguish between different child exceptions.