Public Member Functions | Private Attributes | Friends | List of all members
karto::Exception Class Reference

#include <Karto.h>

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 97 of file Karto.h.

Constructor & Destructor Documentation

◆ Exception() [1/2]

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 105 of file Karto.h.

◆ Exception() [2/2]

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

Copy constructor

Definition at line 114 of file Karto.h.

◆ ~Exception()

virtual karto::Exception::~Exception ( )
inlinevirtual

Destructor

Definition at line 123 of file Karto.h.

Member Function Documentation

◆ GetErrorCode()

kt_int32s karto::Exception::GetErrorCode ( )
inline

Gets error code

Returns
error code

Definition at line 153 of file Karto.h.

◆ GetErrorMessage()

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

Gets the exception message

Returns
error message as string

Definition at line 144 of file Karto.h.

◆ operator=()

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

Assignment operator

Definition at line 131 of file Karto.h.

Friends And Related Function Documentation

◆ operator<<

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 151 of file Karto.cpp.

Member Data Documentation

◆ m_ErrorCode

kt_int32s karto::Exception::m_ErrorCode
private

Definition at line 168 of file Karto.h.

◆ m_Message

std::string karto::Exception::m_Message
private

Definition at line 167 of file Karto.h.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Sat Oct 3 2020 03:51:02