Internal Error API

The Internal Error API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::Error::Error (vx_context context, vx_reference scope)
	Construct a new Error object.
	coreflow::Error::~Error ()
	Destroy the Error object.
static vx_bool	coreflow::Error::createConstErrors (vx_context context)
	Creates all the status codes as error objects.
static vx_error	coreflow::Error::allocateError (vx_context context, vx_status status)
	Creates an Error Object.
static void	coreflow::Error::releaseError (vx_error *error)
	Releases an error object.
static vx_error	coreflow::Error::getError (vx_context context, vx_status status)
	Matches the status code against all known error objects in the context.
static vx_status	coreflow::Error::getStatus (vx_reference ref)
	Provides a generic API to return status values from Object constructors if they fail.

Detailed Description

The Internal Error API.

Function Documentation

allocateError()

static vx_error coreflow::Error::allocateError ( vx_context context, vx_status status )

static

#include <vx_error.h>

Creates an Error Object.

createConstErrors()

static vx_bool coreflow::Error::createConstErrors ( vx_context context )

static

#include <vx_error.h>

Creates all the status codes as error objects.

Error()

coreflow::Error::Error	(	vx_context	context,
		vx_reference	scope )

#include <vx_error.h>

Construct a new Error object.

getError()

static vx_error coreflow::Error::getError ( vx_context context, vx_status status )

static

#include <vx_error.h>

Matches the status code against all known error objects in the context.

Parameters

[in]	context	The pointer to the overall context.
[in]	status	The status code to find.

Returns

Returns a matching error object.

getStatus()

static vx_status coreflow::Error::getStatus ( vx_reference ref )

static

#include <vx_error.h>

Provides a generic API to return status values from Object constructors if they fail.

Parameters

[in]

ref

The reference to check for construction errors.

Returns

vx_status VX_SUCCESS if successful, any other value indicates failure.

releaseError()

static void coreflow::Error::releaseError ( vx_error * error )

static

#include <vx_error.h>

Releases an error object.

~Error()

coreflow::Error::~Error

(

)

#include <vx_error.h>

Destroy the Error object.