Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Static Public Attributes | List of all members
Mezzanine::NotImplementedException Class Reference

Thrown when we just have not coded a thing yet, but we knew what the API should look like. More...

#include <exception.h>

+ Inheritance diagram for Mezzanine::NotImplementedException:
+ Collaboration diagram for Mezzanine::NotImplementedException:

Public Member Functions

 NotImplementedException (const String &TypeName, const String &JavaTypeName, const String &Message, const String &SrcFunction, const String &SrcFile, const Whole &FileLine)
 NotImplementedException Name overwriting constructor. More...
 
 NotImplementedException (const String &Message, const String &SrcFunction, const String &SrcFile, const Whole &FileLine)
 NotImplementedException constructor. More...
 
virtual ~NotImplementedException () throw ()
 Class destructor.
 
virtual Whole GetExceptionCode () const throw ()
 Gets the exception code for this exception. More...
 
- Public Member Functions inherited from Mezzanine::ExceptionBase
 ExceptionBase (const Mezzanine::String &TypeName, const Mezzanine::String &JavaTypeName, const Mezzanine::String &Message, const Mezzanine::String &SrcFunction, const Mezzanine::String &SrcFile, const Mezzanine::Whole &FileLine)
 Simple Constructor. More...
 
virtual ~ExceptionBase () throw ()
 Class destructor.
 
Mezzanine::String GetCompleteMessage () const throw ()
 Constructs the complete message from all the information provided about the exception. More...
 
const Mezzanine::StringGetExceptionJavaTypeName () const throw ()
 Gets the name of the exception type. More...
 
const Mezzanine::StringGetExceptionTypeName () const throw ()
 Gets the name of the exception type. More...
 
const Mezzanine::StringGetFile () const throw ()
 Gets the file of the exception. More...
 
const Mezzanine::StringGetFunction () const throw ()
 Gets the function of the exception. More...
 
const Mezzanine::WholeGetLine () const throw ()
 Gets the line number of the exception. More...
 
virtual const char * what () const throw ()
 Retrieves the error message. More...
 

Static Public Attributes

static const Whole ExceptionCode = ExceptionBase::NOT_IMPLEMENTED_EXCEPTION
 Thrown when we just have not coded a thing yet, but we knew what the API should look like.
 

Additional Inherited Members

- Public Types inherited from Mezzanine::ExceptionBase
enum  ExceptionCodes {
  FIRST_EXCEPTION = 0x01F00F00, IO_EXCEPTION = 0x01F00F00, IO_FILE_EXCEPTION = 0x01F01F00, IO_FILE_READ_EXCEPTION = 0x01F01F01,
  IO_FILE_WRITE_EXCEPTION = 0x01F01F02, IO_FILE_NOT_FOUND_EXCEPTION = 0x01F01F03, IO_FILE_PERMISSION_EXCEPTION = 0x01F01F04, IO_DIRECTORY_EXCEPTION = 0x01F02F00,
  IO_DIRECTORY_READ_EXCEPTION = 0x01F02F01, IO_DIRECTORY_WRITE_EXCEPTION = 0x01F02F02, IO_DIRECTORY_NOT_FOUND_EXCEPTION = 0x01F02F03, IO_DIRECTORY_PERMISSION_EXCEPTION = 0x01F02F04,
  IO_NETWORK_EXCEPTION = 0x01F03F00, IO_NETWORK_READ_EXCEPTION = 0x01F03F01, IO_NETWORK_WRITE_EXCEPTION = 0x01F03F02, IO_NETWORK_NOT_FOUND_EXCEPTION = 0x01F03F03,
  IO_NETWORK_URL_EXCEPTION = 0x01F03F04, IO_NETWORK_PERMISSION_EXCEPTION = 0x01F03F05, IO_WRITE_EXCEPTION = 0x01F08F00, IO_READ_EXCEPTION = 0x01F09F00,
  II_EXCEPTION = 0x02F00F00, II_IDENTITY_INVALID_EXCEPTION = 0x02F01F00, II_IDENTITY_NOT_FOUND_EXCEPTION = 0x02F02F00, II_DUPLICATE_IDENTITY_EXCEPTION = 0x02F03F00,
  MM_EXCEPTION = 0x03F00F00, MM_OUT_OF_MEMORY_EXCEPTION = 0x03F01F00, MM_OUT_OF_BOUNDS_EXCEPTION = 0x03F02F00, SYNTAX_ERROR_EXCEPTION = 0x04F00F00,
  SYNTAX_ERROR_EXCEPTION_XML = 0x04F01F00, SYNTAX_ERROR_EXCEPTION_XPATH = 0x04F02F00, SYNTAX_ERROR_EXCEPTION_LUA = 0x04F03F00, SCRIPT_EXCEPTION = 0x05F00F00,
  SCRIPT_EXCEPTION_LUA = 0x05F01F00, SCRIPT_EXCEPTION_LUA_YIELD = 0x05F01F01, SCRIPT_EXCEPTION_LUA_RUNTIME = 0x05F01F02, SCRIPT_EXCEPTION_LUA_ERRERR = 0x05F01F03,
  PARAMETERS_EXCEPTION = 0x06F01F00, PARAMETERS_CAST_EXCEPTION = 0x06F01F01, PARAMETERS_RANGE_EXCEPTION = 0x06F01F02, ARITHMETIC_EXCEPTION = 0x00F01F00,
  INVALID_VERSION_EXCEPTION = 0x00F02F00, INVALID_STATE_EXCEPTION = 0x00F03F00, RENDERINGAPI_EXCEPTION = 0x00F04F00, RT_ASSERTION_EXCEPTION = 0x00F05F00,
  INTERNAL_EXCEPTION = 0x00F06F00, NOT_IMPLEMENTED_EXCEPTION = 0x00F07F00, INVALID_ASSIGNMENT = 0x00F08F00, LAST_EXCEPTION = 0x01F00F00
}
 This enum provides mapping/naming for all the core Mezzanine. More...
 

Detailed Description

Thrown when we just have not coded a thing yet, but we knew what the API should look like.

When catching this in java look for java.lang.XXXXX

Definition at line 2907 of file exception.h.

Constructor & Destructor Documentation

Mezzanine::NotImplementedException::NotImplementedException ( const String TypeName,
const String JavaTypeName,
const String Message,
const String SrcFunction,
const String SrcFile,
const Whole FileLine 
)
inline

NotImplementedException Name overwriting constructor.

Parameters
TypeNameThe name of this class.
JavaTypeNameWhen passed to Java what does this convert to?
MessageA basic description of the error.
SrcFunctionThe name of the function from which this originated.
SrcFileThe name of the file from which this originated.
FileLineThe line on the named file from which this originated.
Warning
This probably shouldn't be called directly. Use MEZZ_EXCEPTION if possible.

Definition at line 2921 of file exception.h.

Mezzanine::NotImplementedException::NotImplementedException ( const String Message,
const String SrcFunction,
const String SrcFile,
const Whole FileLine 
)
inline

NotImplementedException constructor.

Parameters
MessageA basic description of the error.
SrcFunctionThe name of the function from which this originated.
SrcFileThe name of the file from which this originated.
FileLineThe line on the named file from which this originated.
Warning
This probably shouldn't be called directly. Use MEZZ_EXCEPTION if possible.

Definition at line 2937 of file exception.h.

Member Function Documentation

virtual Whole Mezzanine::NotImplementedException::GetExceptionCode ( ) const
throw (
)
inlinevirtual

Gets the exception code for this exception.

Returns
Returns the exception code for this exception.

Implements Mezzanine::ExceptionBase.

Definition at line 2948 of file exception.h.


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