#include <CInvalidArgumentException.h>
Inheritance diagram for CInvalidArgumentException:
Collaboration diagram for CInvalidArgumentException:
Public Member Functions | |
| CInvalidArgumentException (std::string argument, std::string whybad, std::string wasDoing) | |
| CInvalidArgumentException (const CInvalidArgumentException &rhs) | |
| virtual | ~CInvalidArgumentException () |
| CInvalidArgumentException & | operator= (const CInvalidArgumentException &rhs) |
| int | operator== (const CInvalidArgumentException &rhs) const |
| int | operator!= (const CInvalidArgumentException &rhs) const |
| virtual const char * | ReasonText () const |
 Public Member Functions inherited from CException | |
| CException (const char *pszAction) | |
| CException (const std::string &rsAction) | |
| CException (const CException &aCException) | |
| CException & | operator= (const CException &aCException) |
| int | operator== (const CException &aCException) const |
| int | operator!= (const CException &rException) const |
| const char * | getAction () const |
| virtual int | ReasonCode () const |
| const char * | WasDoing () const |
Additional Inherited Members | |
| Protected Member Functions inherited from CException | |
| void | setAction (const char *pszAction) |
| void | setAction (const std::string &rsAction) |
| virtual void | DoAssign (const CException &rhs) |
Detailed Description
This class is ressponsible for reporting exceptions that occur because some function (member or otherwise) has been passed an invalid argument of some sort.
To use this exception type, the thrower must be able to create a textual equivalent of the bad argument, a string that describes why the argument is bad as well as supplying the usual context string.
Constructor & Destructor Documentation
◆ CInvalidArgumentException() [1/2]
| CInvalidArgumentException::CInvalidArgumentException | ( | std::string | argument, |
| std::string | whybad, | ||
| std::string | wasDoing | ||
| ) |
- Parameters
-
argument - The texulized version of the bad argument. whybad - The reason the argument is bad. wasdoing - Context information about what was happening when the exception was thrown.
◆ CInvalidArgumentException() [2/2]
| CInvalidArgumentException::CInvalidArgumentException | ( | const CInvalidArgumentException & | rhs | ) |
Copy construction
- Parameters
-
rhs Object from which a new copy is constructed.
◆ ~CInvalidArgumentException()
|
virtual |
Destructor just needs to chain to the base class.
Member Function Documentation
◆ operator!=()
| int CInvalidArgumentException::operator!= | ( | const CInvalidArgumentException & | rhs | ) | const |
Inequality is the logical inverse of equality.
- Parameters
-
rhs - Object being compared to *this.
- Returns
- int
- Return values
-
!operator==(rhs)
◆ operator=()
| CInvalidArgumentException & CInvalidArgumentException::operator= | ( | const CInvalidArgumentException & | rhs | ) |
Assignement from rhs.
- Parameters
-
rhs - The object that will be assigned into *this.
- Returns
- CInvalidArgumentException&
- Return values
-
*this
◆ operator==()
| int CInvalidArgumentException::operator== | ( | const CInvalidArgumentException & | rhs | ) | const |
- Parameters
-
rhs - Object compared for equality with *this.
- Returns
- int
- Return values
-
1 - Equal. 0 - Not equal.
◆ ReasonText()
|
virtual |
- Returns
- const char*
- Return values
-
A human readable string that describes the error that caused the exception to be thrown.
Reimplemented from CException.
The documentation for this class was generated from the following files:
- libtclplus/include/exception/CInvalidArgumentException.h
- libtclplus/exception/CInvalidArgumentException.cpp
