Public Member Functions | Private Attributes | Friends
karto::Exception Class Reference

#include <Karto.h>

List of all members.

Public Member Functions

 Exception (const std::string &rMessage="Karto Exception", kt_int32s errorCode=0)
 Exception (const Exception &rException)
kt_int32s GetErrorCode ()
const std::string & GetErrorMessage () const
Exceptionoperator= (const Exception &rException)
virtual ~Exception ()

Private Attributes

kt_int32s m_ErrorCode
std::string m_Message

Friends

KARTO_EXPORT std::ostream & operator<< (std::ostream &rStream, Exception &rException)

Detailed Description

Exception class. All exceptions thrown from Karto will inherit from this class or be of this class

Definition at line 83 of file Karto.h.


Constructor & Destructor Documentation

karto::Exception::Exception ( const std::string &  rMessage = "Karto Exception",
kt_int32s  errorCode = 0 
) [inline]

Constructor with exception message

Parameters:
rMessageexception message (default: "Karto Exception")
errorCodeerror code (default: 0)

Definition at line 91 of file Karto.h.

karto::Exception::Exception ( const Exception rException) [inline]

Copy constructor

Definition at line 100 of file Karto.h.

virtual karto::Exception::~Exception ( ) [inline, virtual]

Destructor

Definition at line 109 of file Karto.h.


Member Function Documentation

Gets error code

Returns:
error code

Definition at line 139 of file Karto.h.

const std::string& karto::Exception::GetErrorMessage ( ) const [inline]

Gets the exception message

Returns:
error message as string

Definition at line 130 of file Karto.h.

Exception& karto::Exception::operator= ( const Exception rException) [inline]

Assignment operator

Definition at line 117 of file Karto.h.


Friends And Related Function Documentation

KARTO_EXPORT std::ostream& operator<< ( std::ostream &  rStream,
Exception rException 
) [friend]

Write exception to output stream

Parameters:
rStreamoutput stream
rExceptionexception to write

Definition at line 129 of file Karto.cpp.


Member Data Documentation

Definition at line 154 of file Karto.h.

std::string karto::Exception::m_Message [private]

Definition at line 153 of file Karto.h.


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


open_karto
Author(s):
autogenerated on Thu Aug 27 2015 14:14:06