C++ Utilities  4.17.0
Useful C++ classes and routines such as argument parser, IO and conversion utilities
Public Member Functions | List of all members
ApplicationUtilities::Failure Class Reference

The Failure class is thrown by an ArgumentParser when a parsing error occurs. More...

#include <failure.h>

Inheritance diagram for ApplicationUtilities::Failure:
[legend]
Collaboration diagram for ApplicationUtilities::Failure:
[legend]

Public Member Functions

 Failure ()
 Constructs a new Failure. More...
 
 Failure (const std::string &what)
 Constructs a new Failure. More...
 
 ~Failure () USE_NOTHROW
 Destroys the Failure. More...
 
virtual const char * what () const USE_NOTHROW
 Returns a C-style character string describing the cause of the Failure. More...
 

Detailed Description

The Failure class is thrown by an ArgumentParser when a parsing error occurs.

See also
ApplicationUtilities::ArgumentParser

Definition at line 12 of file failure.h.

Constructor & Destructor Documentation

◆ Failure() [1/2]

ApplicationUtilities::Failure::Failure ( )

Constructs a new Failure.

Definition at line 19 of file failure.cpp.

◆ Failure() [2/2]

ApplicationUtilities::Failure::Failure ( const std::string &  what)

Constructs a new Failure.

what is a std::string describing the cause of the Failure.

Definition at line 28 of file failure.cpp.

◆ ~Failure()

ApplicationUtilities::Failure::~Failure ( )

Destroys the Failure.

Definition at line 36 of file failure.cpp.

Member Function Documentation

◆ what()

const char * ApplicationUtilities::Failure::what ( ) const
virtual

Returns a C-style character string describing the cause of the Failure.

Definition at line 44 of file failure.cpp.


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