GeoGen API Reference
Public Member Functions | List of all members
geogen::ApiUsageException Class Reference

Exception thrown when the API detects incorrect usage (such as incorrect parameter or a method being called in incorrect context). More...

Inherits geogen::GeoGenException.

Public Member Functions

 ApiUsageException (String const &message)
 Constructor. More...
 
virtual String GetDetailMessage ()
 Gets a detailed message of the exception. More...
 
- Public Member Functions inherited from geogen::GeoGenException
 GeoGenException (ErrorCode code)
 
virtual const char * what () const throw ()
 
ErrorCode GetErrorCode () const
 Gets an error code representing the error. More...
 

Detailed Description

Exception thrown when the API detects incorrect usage (such as incorrect parameter or a method being called in incorrect context).

Constructor & Destructor Documentation

geogen::ApiUsageException::ApiUsageException ( String const &  message)
inlineexplicit

Constructor.

Parameters
messageThe message.

Member Function Documentation

virtual String geogen::ApiUsageException::GetDetailMessage ( )
inlinevirtual

Gets a detailed message of the exception.

Returns
The detail message.

Reimplemented from geogen::GeoGenException.