Public Member Functions | Protected Attributes | List of all members
te::common::Exception Class Reference

This class is designed to declare objects to be thrown as exceptions by TerraLib. More...

#include <Exception.h>

Inheritance diagram for te::common::Exception:
te::common::LoggedException

Public Member Functions

virtual int code () const throw ()
 It gets the exception code. More...
 
 Exception () throw ()
 Default constructor. More...
 
 Exception (const std::string &what, int code=UNKNOWN_EXCEPTION) throw ()
 It initializes a new Exception. More...
 
 Exception (const char *const what, int code=UNKNOWN_EXCEPTION) throw ()
 It initializes a new Exception. More...
 
virtual const char * getClassName () const throw ()
 It return the exception class name. More...
 
virtual const char * what () const throw ()
 It outputs the exception message. More...
 
virtual ~Exception () throw ()
 Destructor. More...
 

Protected Attributes

int m_code
 The internal exception code. More...
 
std::string m_msg
 The internal exception message. More...
 

Detailed Description

This class is designed to declare objects to be thrown as exceptions by TerraLib.

What is an Exception?

  • It can be an error during a processing function: like out-of-memory, wrong path, wrong calculus;
  • It can be triggered by a missed value or pointer;
  • It can be triggered by a parameter out of range.

In other words, it can be any exception thrown by TerraLib when something goes wrong.

Note
TerraLib Exception class is a subclass of std::exception.
In future we must revisit this class and remove the embbed std::string.

Definition at line 58 of file Exception.h.

Constructor & Destructor Documentation

te::common::Exception::Exception ( )
throw (
)

Default constructor.

te::common::Exception::Exception ( const std::string &  what,
int  code = UNKNOWN_EXCEPTION 
)
throw (
)
explicit

It initializes a new Exception.

Parameters
whatA brief description of what has raised the exception.
te::common::Exception::Exception ( const char *const  what,
int  code = UNKNOWN_EXCEPTION 
)
throw (
)
explicit

It initializes a new Exception.

Parameters
whatA brief description of what has raised the exception.
virtual te::common::Exception::~Exception ( )
throw (
)
virtual

Destructor.

Member Function Documentation

virtual int te::common::Exception::code ( ) const
throw (
)
virtual

It gets the exception code.

Returns
The exception code.
virtual const char* te::common::Exception::getClassName ( ) const
throw (
)
virtual

It return the exception class name.

Returns
the exception class name.

Reimplemented in te::common::LoggedException.

virtual const char* te::common::Exception::what ( ) const
throw (
)
virtual

It outputs the exception message.

Returns
The exception message.

Member Data Documentation

int te::common::Exception::m_code
protected

The internal exception code.

Definition at line 105 of file Exception.h.

std::string te::common::Exception::m_msg
protected

The internal exception message.

Definition at line 106 of file Exception.h.

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