ldas-tools-al  2.6.7
Public Member Functions | Private Attributes | List of all members
ErrorInfo Class Reference

System Includes. More...

#include <errorinfo.hh>

Public Member Functions

 ErrorInfo (int library, int code, const std::string &1, const std::string &info="", const char *file=0, size_t line=0)
 Constructor. More...
 
 ErrorInfo (const ErrorInfo &e)
 Copy constructor. More...
 
 ~ErrorInfo ()
 Destructor. More...
 
const ErrorInfooperator= (const ErrorInfo &e)
 Assign. More...
 
bool operator== (const ErrorInfo &e) const
 Equal Comparison. More...
 
bool operator!= (const ErrorInfo &e) const
 Not-Equal Comparison. More...
 
int getLibrary () const
 Get Library. More...
 
int getCode () const
 Get Error Code. More...
 
const std::string & getMessage () const
 Get Error Message. More...
 
const std::string & getInfo () const
 Get Error Information. More...
 
const char * getFile () const
 Get File Name. More...
 
size_t getLine () const
 Get Line Number. More...
 
 ErrorInfo (int library, int code, const std::string &1, const std::string &info="", const char *file=0, size_t line=0)
 Constructor. More...
 
 ErrorInfo (const ErrorInfo &e)
 Copy constructor. More...
 
 ~ErrorInfo ()
 Destructor. More...
 
const ErrorInfooperator= (const ErrorInfo &e)
 Assign. More...
 
bool operator== (const ErrorInfo &e) const
 
bool operator!= (const ErrorInfo &e) const
 
int getLibrary () const
 
int getCode () const
 
const std::string & getMessage () const
 
const std::string & getInfo () const
 
const char * getFile () const
 
size_t getLine () const
 
 ErrorInfo (int library, int code, const std::string &1, const std::string &info="", const char *file=0, size_t line=0)
 Constructor. More...
 
 ErrorInfo (const ErrorInfo &e)
 Copy constructor. More...
 
 ~ErrorInfo ()
 Destructor. More...
 
const ErrorInfooperator= (const ErrorInfo &e)
 Assign. More...
 
bool operator== (const ErrorInfo &e) const
 
bool operator!= (const ErrorInfo &e) const
 
int getLibrary () const
 
int getCode () const
 
const std::string & getMessage () const
 
const std::string & getInfo () const
 
const char * getFile () const
 
size_t getLine () const
 

Private Attributes

int mLibrary
 The library in which the error occurred (int). More...
 
int mCode
 The error code (int) More...
 
std::string mMsg
 A string representation of the error code (string). More...
 
std::string mInfo
 Additional information specific to the error (string) More...
 
char * mFile
 The file in which the error was thrown (const char*) More...
 
size_t mLine
 The line on which the error was thrown (size_t) More...
 

Detailed Description

System Includes.

Error Information

This class is used by the LdasException class to store information about a thrown exception.

Constructor & Destructor Documentation

◆ ErrorInfo() [1/6]

ErrorInfo::ErrorInfo ( int  library,
int  code,
const std::string &  1,
const std::string &  info = "",
const char *  file = 0,
size_t  line = 0 
)

Constructor.

Parameters
libraryLibrary enumerated type
codeError code
msgString representation of error code.
infoAddition information specific to the error
fileFile in which the error was thrown.
lineLine number in file where error was thrown.
library
code
msg
info
file
line

◆ ErrorInfo() [2/6]

ErrorInfo::ErrorInfo ( const ErrorInfo e)

Copy constructor.

Copy Constructor.

Parameters
eSource
e

◆ ~ErrorInfo() [1/3]

ErrorInfo::~ErrorInfo ( )

Destructor.

◆ ErrorInfo() [3/6]

ErrorInfo::ErrorInfo ( int  library,
int  code,
const std::string &  1,
const std::string &  info = "",
const char *  file = 0,
size_t  line = 0 
)

Constructor.

Parameters
libraryLibrary enumerated type
codeError code
msgString representation of error code.
infoAddition information specific to the error
fileFile in which the error was thrown.
lineLine number in file where error was thrown.

◆ ErrorInfo() [4/6]

ErrorInfo::ErrorInfo ( const ErrorInfo e)

Copy constructor.

Parameters
eSource

◆ ~ErrorInfo() [2/3]

ErrorInfo::~ErrorInfo ( )

Destructor.

◆ ErrorInfo() [5/6]

ErrorInfo::ErrorInfo ( int  library,
int  code,
const std::string &  1,
const std::string &  info = "",
const char *  file = 0,
size_t  line = 0 
)

Constructor.

Parameters
libraryLibrary enumerated type
codeError code
msgString representation of error code.
infoAddition information specific to the error
fileFile in which the error was thrown.
lineLine number in file where error was thrown.

◆ ErrorInfo() [6/6]

ErrorInfo::ErrorInfo ( const ErrorInfo e)

Copy constructor.

Parameters
eSource

◆ ~ErrorInfo() [3/3]

ErrorInfo::~ErrorInfo ( )

Destructor.

Member Function Documentation

◆ getCode() [1/3]

int ErrorInfo::getCode ( ) const
inline

Get Error Code.

Returns
int

◆ getCode() [2/3]

int ErrorInfo::getCode ( ) const

◆ getCode() [3/3]

int ErrorInfo::getCode ( ) const

◆ getFile() [1/3]

const char* ErrorInfo::getFile ( ) const

◆ getFile() [2/3]

const char * ErrorInfo::getFile ( ) const
inline

Get File Name.

Get the name of the file in which the error was thrown.

Returns
const char*

◆ getFile() [3/3]

const char* ErrorInfo::getFile ( ) const

◆ getInfo() [1/3]

const std::string& ErrorInfo::getInfo ( ) const

◆ getInfo() [2/3]

const std::string& ErrorInfo::getInfo ( ) const

◆ getInfo() [3/3]

const std::string & ErrorInfo::getInfo ( ) const
inline

Get Error Information.

Returns additional information about the error.

Returns
const std::string&

◆ getLibrary() [1/3]

int ErrorInfo::getLibrary ( ) const
inline

Get Library.

Returns
int The number of the library which threw the exception.

◆ getLibrary() [2/3]

int ErrorInfo::getLibrary ( ) const

◆ getLibrary() [3/3]

int ErrorInfo::getLibrary ( ) const

◆ getLine() [1/3]

size_t ErrorInfo::getLine ( ) const

◆ getLine() [2/3]

size_t ErrorInfo::getLine ( ) const

◆ getLine() [3/3]

size_t ErrorInfo::getLine ( ) const
inline

Get Line Number.

Get the line number on which the error was thrown.

Returns
size_t

◆ getMessage() [1/3]

const std::string& ErrorInfo::getMessage ( ) const

◆ getMessage() [2/3]

const std::string & ErrorInfo::getMessage ( ) const
inline

Get Error Message.

Returns a text representation of the error code.

return const std::string&

◆ getMessage() [3/3]

const std::string& ErrorInfo::getMessage ( ) const

◆ operator!=() [1/3]

bool ErrorInfo::operator!= ( const ErrorInfo e) const

◆ operator!=() [2/3]

bool ErrorInfo::operator!= ( const ErrorInfo e) const

◆ operator!=() [3/3]

bool ErrorInfo::operator!= ( const ErrorInfo e) const
inline

Not-Equal Comparison.

Parameters
e
Returns
bool

◆ operator=() [1/3]

const ErrorInfo & ErrorInfo::operator= ( const ErrorInfo e)

Assign.

Assignment Operator.

Parameters
e
Returns
const ErrorInfo&

◆ operator=() [2/3]

const ErrorInfo& ErrorInfo::operator= ( const ErrorInfo e)

Assign.

◆ operator=() [3/3]

const ErrorInfo& ErrorInfo::operator= ( const ErrorInfo e)

Assign.

◆ operator==() [1/3]

bool ErrorInfo::operator== ( const ErrorInfo e) const

Equal Comparison.

Parameters
e
Returns
bool

◆ operator==() [2/3]

bool ErrorInfo::operator== ( const ErrorInfo e) const

◆ operator==() [3/3]

bool ErrorInfo::operator== ( const ErrorInfo e) const

Member Data Documentation

◆ mCode

int ErrorInfo::mCode
private

The error code (int)

◆ mFile

char * ErrorInfo::mFile
private

The file in which the error was thrown (const char*)

◆ mInfo

std::string ErrorInfo::mInfo
private

Additional information specific to the error (string)

◆ mLibrary

int ErrorInfo::mLibrary
private

The library in which the error occurred (int).

◆ mLine

size_t ErrorInfo::mLine
private

The line on which the error was thrown (size_t)

◆ mMsg

std::string ErrorInfo::mMsg
private

A string representation of the error code (string).


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