AMOS::ArgumentException_t Class Reference

An exception for invalid arguments. More...

#include <exceptions_AMOS.hh>

Inheritance diagram for AMOS::ArgumentException_t:

[legend]Collaboration diagram for AMOS::ArgumentException_t:

[legend]List of all members.

Public Member Functions
	ArgumentException_t (const std::string &what, int line=0, const std::string &file=NULL_STRING)
	Informative constructor.
virtual const char *	file () const
	Returns the file (if available) of the exception.
virtual int	line () const
	Returns the line number (if available) of the exception.
virtual const char *	what () const throw ( )
	Returns a short description (if available) of the exception.

---

Detailed Description

An exception for invalid arguments.

Usually thrown when a function argument does not satisfy the preconditions. The reason for the exception can be retrieved with the what( ) function inherited from the Exception_t class. This is primarily a logic error and can usually be avoided entirely, so the user probably does not need to catch for this exception except for debugging purposes.

Definition at line 194 of file exceptions_AMOS.hh.

---

Constructor & Destructor Documentation

AMOS::ArgumentException_t::ArgumentException_t (  const std::string &  what, int  line = 0, const std::string &  file = NULL_STRING )  [inline]

Informative constructor. Parameters: what  Brief description of the exception line  Line number of the exception file  File name of the exception Definition at line 206 of file exceptions_AMOS.hh.

---

Member Function Documentation

virtual const char* AMOS::Exception_t::file (   )  const [inline, virtual, inherited]

Returns the file (if available) of the exception. Definition at line 67 of file exceptions_AMOS.hh. Referenced by AMOS::Exception_t::Exception_t().

virtual int AMOS::Exception_t::line (   )  const [inline, virtual, inherited]

Returns the line number (if available) of the exception. Definition at line 76 of file exceptions_AMOS.hh.

virtual const char* AMOS::Exception_t::what (   )  const throw ( ) [inline, virtual, inherited]

Returns a short description (if available) of the exception. Definition at line 85 of file exceptions_AMOS.hh.

---

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

• exceptions_AMOS.hh

---