Definitions

Collaboration diagram for Definitions:

Macros
#define	DMX512_CHANNEL_ADDRESS_MIN   0
	DMX512 min channel address. More...
#define	DMX512_CHANNEL_ADDRESS_MAX   512
	DMX512 max channel address. More...
#define	DMX512_CHANNEL_VALUE_MIN   0
	DMX512 min channel value. More...
#define	DMX512_CHANNEL_VALUE_MAX   255
	DMX512 max channel value. More...

Enumerations
enum	DMX512_engine_err_e {   DMX512_ENGINE_OK ,   DMX512_ENGINE_INSTANCE_DUPLICATE = -1 ,   DMX512_ENGINE_INSTANCE_INVALID = -2 ,   DMX512_ENGINE_INSTANCE_UNDEFINED = -3 ,   DMX512_ENGINE_CONFIG_DUMP_EXCEPTION = -4 ,   DMX512_ENGINE_CONFIG_LOAD_EXCEPTION = -5 ,   DMX512_ENGINE_MEMORY_OVERFLOW = -6 ,   DMX512_ENGINE_API_ENDPOINT_UNDEF = -7 ,   DMX512_ENGINE_API_METHOD_UNDEF = -8 }
	DMX512 engine error index constants. More...

Variables
static char *const	DMX512_engine_errs_str []
	DMX512 engine error strings constants TODO: this should be put into DMX512 API TODO: largely extend set of error messages to offer ease of debugging. More...

Detailed Description

Definition of fundamental constant values to be used by the DMX512 engine

Macro Definition Documentation

DMX512_CHANNEL_ADDRESS_MAX

#define DMX512_CHANNEL_ADDRESS_MAX   512

DMX512 max channel address.

Definition at line 13 of file DMX512_defs.h.

DMX512_CHANNEL_ADDRESS_MIN

#define DMX512_CHANNEL_ADDRESS_MIN   0

DMX512 min channel address.

Definition at line 12 of file DMX512_defs.h.

DMX512_CHANNEL_VALUE_MAX

#define DMX512_CHANNEL_VALUE_MAX   255

DMX512 max channel value.

Definition at line 15 of file DMX512_defs.h.

DMX512_CHANNEL_VALUE_MIN

#define DMX512_CHANNEL_VALUE_MIN   0

DMX512 min channel value.

Definition at line 14 of file DMX512_defs.h.

Enumeration Type Documentation

DMX512_engine_err_e

enum DMX512_engine_err_e

DMX512 engine error index constants.

Series of pre-defined constant error values to be used throughout the whole DMX512 engine lifecycle. TODO: Very important !! UPDATE Erro enumerations and error strings to avoid confusion !!!!

Enumerator
DMX512_ENGINE_OK	No error
DMX512_ENGINE_INSTANCE_DUPLICATE	A duplicate id was found
DMX512_ENGINE_INSTANCE_INVALID	Provided arguments are not valid
DMX512_ENGINE_INSTANCE_UNDEFINED	The instance id could not be found
DMX512_ENGINE_CONFIG_DUMP_EXCEPTION	An error occurred during configuration load process
DMX512_ENGINE_CONFIG_LOAD_EXCEPTION	An error occurted during configuration save process
DMX512_ENGINE_MEMORY_OVERFLOW	Not enough memory
DMX512_ENGINE_API_ENDPOINT_UNDEF	Requested API endpoint does not exist (this shouldn't be defined here)
DMX512_ENGINE_API_METHOD_UNDEF	Requested API endpoint does not exist (this shouldn't be defined here)

Definition at line 24 of file DMX512_defs.h.

Variable Documentation

DMX512_engine_errs_str

char* const DMX512_engine_errs_str[]

static

Initial value:

= {
    "Success",
    "Ressource id already exist",
    "Wrong parameter values",
    "Ressource id not found",
    "Load config error",
    "Save config error",
    "mem overflow",
    "API endoint doesn't exist",
    "Unauthorised method",
}

DMX512 engine error strings constants TODO: this should be put into DMX512 API TODO: largely extend set of error messages to offer ease of debugging.

Definition at line 41 of file DMX512_defs.h.