HOM_Errors.h File Reference

#include "HOM_API.h"
#include "HOM_Defines.h"
#include <string>

Include dependency graph for HOM_Errors.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	HOM_SystemExit
class	HOM_Error

Macros
#define	SIMPLE_EXCEPTION(exception_name, description_value)
#define	DERIVED_EXCEPTION(exception_name, base_exception, description_value)
#define	SIMPLE_EXCEPTION_DFLT_INSTANCE(exception_name, description_value, default_instance_value)

Functions
	SIMPLE_EXCEPTION (NotAvailable,"Not available in this context") SIMPLE_EXCEPTION(ObjectWasDeleted
Attempt to access an object that no longer exists in Houdini	SIMPLE_EXCEPTION (InvalidInput,"Invalid input") SIMPLE_EXCEPTION(InvalidSize
Attempt to access an object that no longer exists in Houdini Invalid size	SIMPLE_EXCEPTION (TypeError,"Invalid type") SIMPLE_EXCEPTION(ValueError
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value	SIMPLE_EXCEPTION (OperationFailed,"The attempted operation failed") SIMPLE_EXCEPTION(InvalidNodeType
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid	SIMPLE_EXCEPTION (InitScriptFailed,"Node initialization script failed") SIMPLE_EXCEPTION(MatchDefinitionError
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition	SIMPLE_EXCEPTION_DFLT_INSTANCE (PermissionError,"","Failed to modify node or parameter because of a permission ""error. Possible causes include locked assets, takes, ""product permissions or user specified permissions") SIMPLE_EXCEPTION(GeometryPermissionError
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only	SIMPLE_EXCEPTION (KeyframeValueNotSet,"This keyframe value is not set") SIMPLE_EXCEPTION(OperationInterrupted
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only The requested operation was interrupted	SIMPLE_EXCEPTION (LoadWarning,"Warnings were generated during load") SIMPLE_EXCEPTION(NodeError
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only The requested operation was interrupted Error generated by Python node	SIMPLE_EXCEPTION (NodeWarning,"Warning generated by Python node") SIMPLE_EXCEPTION(NameConflict
Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only The requested operation was interrupted Error generated by Python node Name conflict was detected	SIMPLE_EXCEPTION (StateNotRegistered,"Attempt to unregister a non-registered state") SIMPLE_EXCEPTION(HandleNotRegistered

Macro Definition Documentation

#define DERIVED_EXCEPTION	(		exception_name,
			base_exception,
			description_value
	)

Value:

SWIGOUT(%rename(exception_name) HOM_ ## exception_name;) \
class HOM_API HOM_ ## exception_name : public HOM_ ## base_exception \
{ \
public: \
    HOM_ ## exception_name(const char* instance_message = "") \
    : HOM_ ## base_exception(instance_message) \
    {} \
    HOM_Error* clone() override { return new HOM_ ## exception_name(*this); } \
    std::string exceptionTypeName() override { return #exception_name; } \
    std::string description() override { return description_value; } \
    SWIGOUT(std::string __repr__();) \
    SWIGOUT(std::string __str__();) \
};

Definition at line 118 of file HOM_Errors.h.

#define SIMPLE_EXCEPTION	(		exception_name,
			description_value
	)

Value:

SWIGOUT(%rename(exception_name) HOM_ ## exception_name;) \
class HOM_API HOM_ ## exception_name : public HOM_Error \
{ \
public: \
    HOM_ ## exception_name(const char* instance_message = "") \
    : HOM_Error(instance_message) \
    {} \
    HOM_Error* clone() override { return new HOM_ ## exception_name(*this); } \
    std::string exceptionTypeName() override { return #exception_name; } \
    std::string description() override { return description_value; } \
    SWIGOUT(std::string __repr__();) \
    SWIGOUT(std::string __str__();) \
};

Definition at line 97 of file HOM_Errors.h.

#define SIMPLE_EXCEPTION_DFLT_INSTANCE	(		exception_name,
			description_value,
			default_instance_value
	)

Value:

SWIGOUT(%rename(exception_name) HOM_ ## exception_name;) \
class HOM_API HOM_ ## exception_name : public HOM_Error \
{ \
public: \
    HOM_ ## exception_name(const char* instance_message = "") \
    : HOM_Error(instance_message) \
    {} \
    HOM_Error* clone() override { return new HOM_ ## exception_name(*this); } \
    std::string exceptionTypeName() override { return #exception_name; } \
    std::string description() override { return description_value; } \
    std::string instanceMessage() override \
    { \
	std::string instance_msg = HOM_Error::instanceMessage(); \
	if (!instance_msg.size()) instance_msg = default_instance_value; \
        return instance_msg; \
    } \
    SWIGOUT(std::string __repr__();) \
    SWIGOUT(std::string __str__();) \
};

Definition at line 133 of file HOM_Errors.h.

Function Documentation

SIMPLE_EXCEPTION	(	NotAvailable	,
		"Not available in this context"
	)

Attempt to access an object that no longer exists in Houdini SIMPLE_EXCEPTION	(	InvalidInput	,
		"Invalid input"
	)

Attempt to access an object that no longer exists in Houdini Invalid size SIMPLE_EXCEPTION	(	TypeError	,
		"Invalid type"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value SIMPLE_EXCEPTION	(	OperationFailed	,
		"The attempted operation failed"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid SIMPLE_EXCEPTION	(	InitScriptFailed	,
		"Node initialization script failed"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only SIMPLE_EXCEPTION	(	KeyframeValueNotSet	,
		"This keyframe value is not set"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only The requested operation was interrupted SIMPLE_EXCEPTION	(	LoadWarning	,
		"Warnings were generated during load"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only The requested operation was interrupted Error generated by Python node SIMPLE_EXCEPTION	(	NodeWarning	,
		"Warning generated by Python node"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition Geometry is read only The requested operation was interrupted Error generated by Python node Name conflict was detected SIMPLE_EXCEPTION	(	StateNotRegistered	,
		"Attempt to unregister a non-registered state"
	)

Attempt to access an object that no longer exists in Houdini Invalid size Invalid value The node type is invalid Failed to match node type definition SIMPLE_EXCEPTION_DFLT_INSTANCE	(	PermissionError	,
		""	,
		"Failed to modify node or parameter because of a permission ""error. Possible causes include locked	assets,
		takes	,
		" "product permissions or user specified permissions"
	)