WarpTwin
Documentation for WarpTwin models and classes.
Loading...
Searching...
No Matches
clockwerkerrors.h File Reference

Go to the source code of this file.

Macros

#define NO_ERROR   0
 Error code in the case where matrix math executed successfully.
#define ERROR_DIMENSIONS   1
#define ERROR_POORLY_CONDITIONED   2
#define TOLERANCE_CONDITIONING   1e-12
#define ERROR_DIVIDE_BY_ZERO   3
 Error code in the case where some fool tried to divide by zero.
#define ERROR_INVALID_RANGE   4
#define ERROR_NEGATIVE_SQRT   5
#define ERROR_NULLPTR   6
 Error code in case of a null pointer.
#define ERROR_SUBTRACTION_PARAMS   7
 Error code with invalid subtraction.
#define ERROR_NAN   8
 Error code in case nan is detected.
#define ERROR_TREE_NAME_EXISTS   10
#define ERROR_TREE_NODE_NOT_PRESENT   11
#define WARN_NOT_LOGGABLE   -12
#define ERROR_CIRCULAR_REFERENCE   13
 Error in the case where we have a circular reference.
#define ERROR_TREE_LOCKED   14
 Error in case where tree is locked.
#define WARN_NAME_LENGTH   -15
#define ERROR_MAX_MSG_SIZE   20
#define ERROR_FILE_WRITE   21
 Error code in the case where the logger was unable to write to file pointer.
#define ERROR_FILE_READ   22
 Error code in the case where the logger was unable to read from file pointer.
#define WARN_LOG_LEVEL   -22
 Warning code in case message was below debug level required for logging.
#define ERROR_WRITE_PERMISSION   31
 Error code for attempting to write to a signal/DataIO object without permission.
#define ERROR_LOGGER_LOCK   40
 Variable to raise an error if logger is not locked appropriately before logging.
#define ERROR_BUFFER_NOT_IMPLEMENTED   41
 Variable to raise an error if an appropriate buffer is not in place.
#define ERROR_PARENT_NOT_FRAME   50
 Error in the case where parent of a frame is not a frame.
#define ERROR_DIFFERENT_TREE   51
 Error in the case where two frames are not part of the same tree.
#define ERROR_NO_ROOT_FRAME   52
 Error in the case where a root frame is not present.
#define ERROR_FRAME_MOD_PERMISSION   53
 Error in the case where you attempt to modify a frame without permission.
#define ERROR_FRAME_PARENT_TYPE   54
#define ERROR_STEP_OVERRUN   60
 Error in the case where dynamics model overruns steps or gets out of whack.
#define ERROR_INVALID_INTEGRATOR_TYPE   61
 Error in the case where an invalid integrator type is passed as an argument.
#define ERROR_NOT_FOUND   70
 Error in the case where dynamics model overruns steps or gets out of whack.
#define WARNING_NOT_CONVERGED   -71
 Warning in the case an iterative solver was unable to converge.
#define WARNING_POORLY_MATCHED_RATES   -72
 Warning when certain a simulation and model rate don't match well and may cause issues.
#define WARNING_NOT_OVERRIDDEN   -73
 Warning when a virtual function is not called but not overwridden and should not result in fault worthy behavior, this error should be the default return of all virtual functions that do not have to be overridden.
#define ERROR_NOT_OVERRIDDEN   74
 Error when a virtual function is not called but not overwridden and should result in fault worthy behavior, this error should be the default return of all virtual functions that must be overridden.
#define ERROR_CANNOT_CONVERT_STRING   80
 Error in the case where dynamics model overruns steps or gets out of whack.
#define WARNING_NO_MATCH   -81
 Error in the case where dynamics model overruns steps or gets out of whack.
#define ERROR_NOT_SETUP   82
 Error in the case where the sim exec is not set up.
#define ERROR_QUEUE_FULL   90
 Error in case the queue is full.
#define ERROR_QUEUE_EMPTY   91
 Error in case the queue is empty.
#define WARNING_BUFFER_FULL   -92
 Warning in case buffer byte(s) need to be popped to write new values.

Macro Definition Documentation

◆ ERROR_BUFFER_NOT_IMPLEMENTED

#define ERROR_BUFFER_NOT_IMPLEMENTED   41

Variable to raise an error if an appropriate buffer is not in place.

◆ ERROR_CANNOT_CONVERT_STRING

#define ERROR_CANNOT_CONVERT_STRING   80

Error in the case where dynamics model overruns steps or gets out of whack.


IO and General Simulation Errors

◆ ERROR_CIRCULAR_REFERENCE

#define ERROR_CIRCULAR_REFERENCE   13

Error in the case where we have a circular reference.

◆ ERROR_DIFFERENT_TREE

#define ERROR_DIFFERENT_TREE   51

Error in the case where two frames are not part of the same tree.

◆ ERROR_DIMENSIONS

#define ERROR_DIMENSIONS   1

Error code in the case where dimensions were mismatched for an operation. This error could be returned due to internal mismatches (i.e. attempt to take determinant of non-square matrix) or due to mismatches with external sources, i.e. matrix multiplication dimension mismatch

◆ ERROR_DIVIDE_BY_ZERO

#define ERROR_DIVIDE_BY_ZERO   3

Error code in the case where some fool tried to divide by zero.

◆ ERROR_FILE_READ

#define ERROR_FILE_READ   22

Error code in the case where the logger was unable to read from file pointer.

◆ ERROR_FILE_WRITE

#define ERROR_FILE_WRITE   21

Error code in the case where the logger was unable to write to file pointer.

◆ ERROR_FRAME_MOD_PERMISSION

#define ERROR_FRAME_MOD_PERMISSION   53

Error in the case where you attempt to modify a frame without permission.

◆ ERROR_FRAME_PARENT_TYPE

#define ERROR_FRAME_PARENT_TYPE   54

Error in the case where we attempt to add an invalid derived frame type as the parent of a derived frame type

◆ ERROR_INVALID_INTEGRATOR_TYPE

#define ERROR_INVALID_INTEGRATOR_TYPE   61

Error in the case where an invalid integrator type is passed as an argument.

◆ ERROR_INVALID_RANGE

#define ERROR_INVALID_RANGE   4

Error code in the case where a function is passed data that exceeds its range of validity

◆ ERROR_LOGGER_LOCK

#define ERROR_LOGGER_LOCK   40

Variable to raise an error if logger is not locked appropriately before logging.


Logging errors

◆ ERROR_MAX_MSG_SIZE

#define ERROR_MAX_MSG_SIZE   20

Logger errors

Error code in the case where the message size passed to the logger exceeds the maximum message size

◆ ERROR_NAN

#define ERROR_NAN   8

Error code in case nan is detected.

◆ ERROR_NEGATIVE_SQRT

#define ERROR_NEGATIVE_SQRT   5

Error code in the case where some fool tried to take the square root of a negative number

◆ ERROR_NO_ROOT_FRAME

#define ERROR_NO_ROOT_FRAME   52

Error in the case where a root frame is not present.

◆ ERROR_NOT_FOUND

#define ERROR_NOT_FOUND   70

Error in the case where dynamics model overruns steps or gets out of whack.


General model errors

◆ ERROR_NOT_OVERRIDDEN

#define ERROR_NOT_OVERRIDDEN   74

Error when a virtual function is not called but not overwridden and should result in fault worthy behavior, this error should be the default return of all virtual functions that must be overridden.

◆ ERROR_NOT_SETUP

#define ERROR_NOT_SETUP   82

Error in the case where the sim exec is not set up.

◆ ERROR_NULLPTR

#define ERROR_NULLPTR   6

Error code in case of a null pointer.

◆ ERROR_PARENT_NOT_FRAME

#define ERROR_PARENT_NOT_FRAME   50

Error in the case where parent of a frame is not a frame.


Frame errors

◆ ERROR_POORLY_CONDITIONED

#define ERROR_POORLY_CONDITIONED   2

Error code in the case where the matrix is too poorly conditioned to perform an operation. For example, determinant close to zero

◆ ERROR_QUEUE_EMPTY

#define ERROR_QUEUE_EMPTY   91

Error in case the queue is empty.

◆ ERROR_QUEUE_FULL

#define ERROR_QUEUE_FULL   90

Error in case the queue is full.


Queue/Buffer errors

◆ ERROR_STEP_OVERRUN

#define ERROR_STEP_OVERRUN   60

Error in the case where dynamics model overruns steps or gets out of whack.


Integrator and dynamics errors

◆ ERROR_SUBTRACTION_PARAMS

#define ERROR_SUBTRACTION_PARAMS   7

Error code with invalid subtraction.

◆ ERROR_TREE_LOCKED

#define ERROR_TREE_LOCKED   14

Error in case where tree is locked.

◆ ERROR_TREE_NAME_EXISTS

#define ERROR_TREE_NAME_EXISTS   10

Graph tree errors

Error code in the case where the graph tree tries to add a new element to a tree, but that element already exists on the tree

◆ ERROR_TREE_NODE_NOT_PRESENT

#define ERROR_TREE_NODE_NOT_PRESENT   11

Error code in the case where the expected node does not lie on a graph tree

◆ ERROR_WRITE_PERMISSION

#define ERROR_WRITE_PERMISSION   31

Error code for attempting to write to a signal/DataIO object without permission.


Data IO/Signal Errors

◆ NO_ERROR

#define NO_ERROR   0

Error code in the case where matrix math executed successfully.


Matrix and math errors

◆ TOLERANCE_CONDITIONING

#define TOLERANCE_CONDITIONING   1e-12

◆ WARN_LOG_LEVEL

#define WARN_LOG_LEVEL   -22

Warning code in case message was below debug level required for logging.

◆ WARN_NAME_LENGTH

#define WARN_NAME_LENGTH   -15

Warning in the case where the user attempts to log a graph tree object that is not loggable

◆ WARN_NOT_LOGGABLE

#define WARN_NOT_LOGGABLE   -12

Warning in the case where the user attempts to log a graph tree object that is not loggable

◆ WARNING_BUFFER_FULL

#define WARNING_BUFFER_FULL   -92

Warning in case buffer byte(s) need to be popped to write new values.

◆ WARNING_NO_MATCH

#define WARNING_NO_MATCH   -81

Error in the case where dynamics model overruns steps or gets out of whack.

◆ WARNING_NOT_CONVERGED

#define WARNING_NOT_CONVERGED   -71

Warning in the case an iterative solver was unable to converge.

◆ WARNING_NOT_OVERRIDDEN

#define WARNING_NOT_OVERRIDDEN   -73

Warning when a virtual function is not called but not overwridden and should not result in fault worthy behavior, this error should be the default return of all virtual functions that do not have to be overridden.

◆ WARNING_POORLY_MATCHED_RATES

#define WARNING_POORLY_MATCHED_RATES   -72

Warning when certain a simulation and model rate don't match well and may cause issues.