integra_api::CError Class Reference

Represents an enumeration of error codes. More...

#include "api/error.h"

Public Types
enum	code {   INPUT_ERROR = -1, SUCCESS = 0, FAILED = 1, TYPE_ERROR = 2,   PATH_ERROR = 3, CONSTRAINT_ERROR = 4, REENTRANCE_ERROR = 5, FILE_VALIDATION_ERROR = 6,   FILE_MORE_RECENT_ERROR = 7, MODULE_ALREADY_INSTALLED = 8 }

Public Member Functions
	CError (code error_code)
	Create a CError from an enumeration constant.
	operator code () const
	Casting operator, allows direct comparison of CError and enumeration constants.
string	get_text () const

Detailed Description

Represents an enumeration of error codes.

These error codes are used internally and within libIntegra's api. The enumeration is implemented as a class to allow inline stringification where needed

Member Enumeration Documentation

enum integra_api::CError::code

Error enumeration values

Enumerator
INPUT_ERROR	Error caused by unexpected or illegal input values
SUCCESS	No Error
FAILED	Generic function failure - anything not covered by other error codes
TYPE_ERROR	Mismatching type, eg trying to set an integer endpoint by passing a CStringValue
PATH_ERROR	Failed to lookup a node or node endpoint, for example by passing a path to an object which doesn't exist
CONSTRAINT_ERROR	Failed to adhere to a stateful endpoint's constraint (see IConstraint)
REENTRANCE_ERROR	Aborting a chain of set commands because reentrance has been detected, for example because of a circular chain of connections, or a circular interaction of connections and scripts
FILE_VALIDATION_ERROR	The .ixd representation of a node tree within a .integra file fails to conform to the schema defined in CollectionSchema.xsd
FILE_MORE_RECENT_ERROR	A file can't be loaded because it was saved in a more recent version of libIntegra
MODULE_ALREADY_INSTALLED	A module can't be installed because it is already installed

Member Function Documentation

string integra_api::CError::get_text

(

)

const

to string

Returns

a string representation of the error

---

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

• /Users/jamie/Documents/IntegraLive/libIntegra/api/error.h