HF::Exceptions Namespace Reference

Custom exceptions and error codes used interally by DHARTAPI. More...

Classes
struct	FileNotFound
	Thrown when desired file is not found. More...
struct	InvalidOBJ
	The OBJ file was not valid. More...
struct	MissingDependency
	Thrown when a dependency is missing such as Embree. More...
struct	NoCost
	Thrown when a dependency is missing such as Embree. More...
class	NotImplemented

Enumerations
enum	HF_STATUS {   OK = 1 , NOT_IMPLEMENTED = -54 , GENERIC_ERROR = 0 , NOT_FOUND = -1 ,   INVALID_OBJ = -2 , NO_GRAPH = -3 , INVALID_COST = -4 , MISSING_DEPEND = -5 ,   OUT_OF_MEMORY = -6 , MALFORMED_DB = -7 , DB_BUSY = -8 , INVALID_PTR = -9 ,   OUT_OF_RANGE = -10 , NO_PATH = -11 , NO_COST = -12 , NOT_COMPRESSED = -13 }
	A set of error codes standard throughout every DHARTAPI codebase. More...

Detailed Description

Custom exceptions and error codes used interally by DHARTAPI.

Remarks

These were mostly created as needed for the CInterface. If a certain error code needs to be returned, it should have a unique exception unless one can already be found in the std library or we want to differentiate between the exceptions we thrown and the exceptions the standard library throws.

Enumeration Type Documentation

HF_STATUS

enum HF::Exceptions::HF_STATUS

A set of error codes standard throughout every DHARTAPI codebase.

Remarks

Consider adding new error codes if the specific code you require can't be found here. Just make sure to update C# and Python interface's enums as well.

Enumerator
OK	Operation was successful.
NOT_IMPLEMENTED	This function hasn't been implemented yet.
GENERIC_ERROR	Not sure what happened here (If this gets thrown, either fix it or give it a status code!).
NOT_FOUND	The path given did not lead to any file.
INVALID_OBJ	The given path did not point to a valid obj file.
NO_GRAPH	This requires a valid graph in the DB to execute successfully.
INVALID_COST	The given cost name does not exist in the database.
MISSING_DEPEND	A dependency for this object is missing.
OUT_OF_MEMORY	Ran out of memory during the last operation.
MALFORMED_DB	The database exists, but is in some kind of error state.
DB_BUSY	The database is busy (is there some external connection?).
INVALID_PTR	One or more of the given pointers didn't lead to anything.
OUT_OF_RANGE	Tried to reference something not in the given container.
NO_PATH	There is no path between the start and end points.
NO_COST	There is no cost with the given name in the given graph.
NOT_COMPRESSED	Graph wasn't compressed!

Definition at line 31 of file HFExceptions.h.