clockwerkerrors.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Header file to define warnings and errors for clockwerk module.
Convention is as follows:
NO_ERROR is zero
ERRORS are numbers > 0
WARNINGS are numbers < 0
 
Author: Alex Reynolds
*/
 
/// ---------------------------------------------------------------------------------------------------
/// Matrix and math errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error code in the case where matrix math executed successfully
#define NO_ERROR 0
 
/// 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
#define ERROR_DIMENSIONS 1
 
/// Error code in the case where the matrix is too poorly conditioned
/// to perform an operation. For example, determinant close to zero
#define ERROR_POORLY_CONDITIONED 2
#define TOLERANCE_CONDITIONING 1e-12
 
/// Error code in the case where some fool tried to divide by zero
#define ERROR_DIVIDE_BY_ZERO 3
 
/// Error code in the case where a function is passed data that exceeds
/// its range of validity
#define ERROR_INVALID_RANGE 4
 
/// Error code in the case where some fool tried to take the square root
/// of a negative number
#define ERROR_NEGATIVE_SQRT 5
 
/// Error code in case of a null pointer
#define ERROR_NULLPTR 6
 
/// Error code with invalid subtraction
#define ERROR_SUBTRACTION_PARAMS 7
 
/// ---------------------------------------------------------------------------------------------------
/// 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
#define ERROR_TREE_NAME_EXISTS 10
 
/// Error code in the case where the expected node does not lie on a 
/// graph tree
#define ERROR_TREE_NODE_NOT_PRESENT 11
 
/// Warning in the case where the user attempts to log a graph tree object that
/// is not loggable
#define WARN_NOT_LOGGABLE -12
 
/// Error in the case where we have a circular reference
#define ERROR_CIRCULAR_REFERENCE 13
 
/// Error in case where tree is locked
#define ERROR_TREE_LOCKED 14
 
/// ---------------------------------------------------------------------------------------------------
/// Logger errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error code in the case where the message size passed to the logger exceeds
/// the maximum message size
#define ERROR_MAX_MSG_SIZE 20
 
/// Error code in the case where the logger was unable to write to file pointer
#define ERROR_FILE_WRITE 21
 
/// Warning code in case message was below debug level required for logging
#define WARN_LOG_LEVEL -22
 
/// ---------------------------------------------------------------------------------------------------
/// Data IO/Signal Errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error code for attempting to write to a signal/DataIO object without permission
#define ERROR_WRITE_PERMISSION 31
 
/// ---------------------------------------------------------------------------------------------------
/// Logging errors
/// ---------------------------------------------------------------------------------------------------
 
/// Variable to raise an error if logger is not locked appropriately before logging
#define ERROR_LOGGER_LOCK 40
 
/// Variable to raise an error if an appropriate buffer is not in place
#define ERROR_BUFFER_NOT_IMPLEMENTED 41
 
/// ---------------------------------------------------------------------------------------------------
/// Frame errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error in the case where parent of a frame is not a frame
#define ERROR_PARENT_NOT_FRAME 50
 
/// Error in the case where two frames are not part of the same tree
#define ERROR_DIFFERENT_TREE 51
 
/// Error in the case where a root frame is not present
#define ERROR_NO_ROOT_FRAME 52
 
/// Error in the case where you attempt to modify a frame without permission
#define ERROR_FRAME_MOD_PERMISSION 53
 
/// Error in the case where we attempt to add an invalid derived
/// frame type as the parent of a derived frame type
#define ERROR_FRAME_PARENT_TYPE 54
 
/// ---------------------------------------------------------------------------------------------------
/// Integrator and dynamics errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error in the case where dynamics model overruns steps or gets out of whack
#define ERROR_STEP_OVERRUN 60
 
/// Error in the case where an invalid integrator type is passed as an argument
#define ERROR_INVALID_INTEGRATOR_TYPE 61
 
/// ---------------------------------------------------------------------------------------------------
/// General model errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error in the case where dynamics model overruns steps or gets out of whack
#define ERROR_NOT_FOUND 70
 
/// Warning in the case an iterative solver was unable to converge
#define WARNING_NOT_CONVERGED -71
 
/// ---------------------------------------------------------------------------------------------------
/// IO and General Simulation Errors
/// ---------------------------------------------------------------------------------------------------
 
/// Error in the case where dynamics model overruns steps or gets out of whack
#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 the sim exec is not set up
#define ERROR_NOT_SETUP 82