HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_Error Class Reference

#include <UT_Error.h>

Public Member Functions

 UT_Error (const char *error_type, const int error_code, const char *error_string=nullptr, const UT_ErrorSeverity=UT_ERROR_ABORT, const UT_SourceLocation *location=nullptr)
 
virtual ~UT_Error ()
 
 UT_Error (const UT_Error &)=default
 
UT_Erroroperator= (const UT_Error &)=default
 
virtual int64 getMemoryUsage (bool inclusive) const
 
virtual void getErrorMessage (UT_String &error_str, UT_ErrorSeverity last_severity=UT_ERROR_NONE, bool useheaders=true) const
 
virtual void getErrorFormattedString (UT_WorkBuffer &error_str) const
 
const UT_StringgetErrorType () const
 
UT_ErrorSeverity getSeverity () const
 
bool hasError () const
 
int getErrorCode () const
 
const UT_StringgetString () const
 
const UT_SourceLocationgetLocation () const
 
void setErrorType (const char *type)
 
void setSeverity (UT_ErrorSeverity)
 
void setErrorString (const char *string)
 
void setErrorCode (int code)
 
void setErrorLocation (const UT_SourceLocation &loc)
 

Static Public Member Functions

static bool getErrorFormat (UT_StringHolder &format, const char *error_file, int error_code)
 
static bool getFileString (UT_String &error_str, const char *error_file, int error_code, UT_ErrorSeverity severity, UT_ErrorSeverity last_severity, bool useheaders)
 

Detailed Description

Definition at line 76 of file UT_Error.h.

Constructor & Destructor Documentation

UT_Error::UT_Error ( const char *  error_type,
const int  error_code,
const char *  error_string = nullptr,
const UT_ErrorSeverity  = UT_ERROR_ABORT,
const UT_SourceLocation location = nullptr 
)
virtual UT_Error::~UT_Error ( )
virtual
UT_Error::UT_Error ( const UT_Error )
default

Member Function Documentation

int UT_Error::getErrorCode ( ) const
inline

Definition at line 122 of file UT_Error.h.

static bool UT_Error::getErrorFormat ( UT_StringHolder format,
const char *  error_file,
int  error_code 
)
static
virtual void UT_Error::getErrorFormattedString ( UT_WorkBuffer error_str) const
virtual
virtual void UT_Error::getErrorMessage ( UT_String error_str,
UT_ErrorSeverity  last_severity = UT_ERROR_NONE,
bool  useheaders = true 
) const
virtual
const UT_String& UT_Error::getErrorType ( ) const
inline

Definition at line 119 of file UT_Error.h.

static bool UT_Error::getFileString ( UT_String error_str,
const char *  error_file,
int  error_code,
UT_ErrorSeverity  severity,
UT_ErrorSeverity  last_severity,
bool  useheaders 
)
static
const UT_SourceLocation& UT_Error::getLocation ( ) const
inline

Definition at line 124 of file UT_Error.h.

virtual int64 UT_Error::getMemoryUsage ( bool  inclusive) const
inlinevirtual

Definition at line 97 of file UT_Error.h.

UT_ErrorSeverity UT_Error::getSeverity ( ) const
inline

Definition at line 120 of file UT_Error.h.

const UT_String& UT_Error::getString ( ) const
inline

Definition at line 123 of file UT_Error.h.

bool UT_Error::hasError ( ) const
inline

Definition at line 121 of file UT_Error.h.

UT_Error& UT_Error::operator= ( const UT_Error )
default
void UT_Error::setErrorCode ( int  code)
void UT_Error::setErrorLocation ( const UT_SourceLocation loc)
void UT_Error::setErrorString ( const char *  string)
void UT_Error::setErrorType ( const char *  type)
void UT_Error::setSeverity ( UT_ErrorSeverity  )

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