Class CLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.jocl.CLException

All Implemented Interfaces:

Serializable

public class CLException
extends RuntimeException

An exception that may be thrown due to a OpenCL error.

Exceptions may be enabled or disabled using CL#setExceptionsEnabled(boolean). If exceptions are enabled, the JOCL methods will throw a CLException if the OpenCL function did not return CL_SUCCESS.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CLException(String message)	Creates a new CLException with the given error message.
CLException(String message, int status)	Creates a new CLException with the given error message.
CLException(String message, Throwable cause)	Creates a new CLException with the given error message.
CLException(String message, Throwable cause, int status)	Creates a new CLException with the given error message.

Method Summary

Modifier and Type	Method	Description
int	getStatus()	Returns the status code from OpenCL that caused this exception.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CLException

public CLException(String message)

Creates a new CLException with the given error message.

Parameters:

message - The error message for this CLException

CLException

public CLException(String message,
 int status)

Creates a new CLException with the given error message.

Parameters:

message - The error message for this CLException

status - The status code from OpenCL

CLException

public CLException(String message,
 Throwable cause)

Creates a new CLException with the given error message.

Parameters:

message - The error message for this CLException

cause - The throwable that caused this exception

CLException

public CLException(String message,
 Throwable cause,
 int status)

Creates a new CLException with the given error message.

Parameters:

message - The error message for this CLException

cause - The throwable that caused this exception

status - The status code from OpenCL

Method Details

getStatus

public int getStatus()

Returns the status code from OpenCL that caused this exception. For example, the value of CL.CL_INVALID_DEVICE

Returns:

The OpenCL status code