MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
InternalError Class Reference

Internal error. This error is thrown when something unexpected happens during execution. More...

#include <mip/error.h>

Inheritance diagram for InternalError:
Error

Public Member Functions

 InternalError (const std::string &message, const std::string &name="InternalError")
 
 InternalError (const std::string &message, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="InternalError")
 
std::shared_ptr< ErrorClone () const override
 Clone the error.
 
- Public Member Functions inherited from Error
char const * what () const noexcept override
 Get the error message.
 
virtual ErrorType GetErrorType () const
 Get the error type.
 
const std::string & GetErrorName () const
 Get the error name.
 
const std::string & GetMessage (bool maskPII=false) const
 Get the error message.
 
void SetMessage (const std::string &msg)
 Set the error message.
 
void AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
 Add debug info entry.
 
const std::map< std::string, std::string > & GetDebugInfo () const
 Get debug info.
 
virtual ~Error ()
 

Additional Inherited Members

- Protected Member Functions inherited from Error
 Error (const std::string &message, const std::string &name, ErrorType type)
 
 Error (const std::string &message, const std::map< std::string, std::string > debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name, ErrorType type)
 
- Protected Attributes inherited from Error
std::string mMessage
 
std::map< std::string, std::string > mDebugInfo
 
std::string mName
 
ErrorType mType
 

Detailed Description

Internal error. This error is thrown when something unexpected happens during execution.

Constructor & Destructor Documentation

◆ InternalError() [1/2]

InternalError::InternalError ( const std::string & message,
const std::string & name = "InternalError" )
inlineexplicit

◆ InternalError() [2/2]

InternalError::InternalError ( const std::string & message,
const std::map< std::string, std::string > & debugInfo,
const std::map< std::string, std::string > sensitiveDebugInfo,
const std::string & name = "InternalError" )
inlineexplicit

Member Function Documentation

◆ Clone()

std::shared_ptr< Error > InternalError::Clone ( ) const
inlineoverridevirtual

Clone the error.

Returns
a clone of the error.

Implements Error.


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