user_errors.h

Go to the documentation of this file.

#ifndef _USER_ERRORS_H_
#define _USER_ERRORS_H_

#include "carlsim_api.h"

#include <string>       // std::string

class CARLSIM_API UserErrors {
public:
    // +++++ PUBLIC PROPERTIES ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //

    enum errorType {
        ALL_NOT_ALLOWED,        
        CAN_ONLY_BE_CALLED_IN_MODE, 
        CAN_ONLY_BE_CALLED_IN_STATE,
        CANNOT_BE_CALLED_IN_MODE,   
        CANNOT_BE_CALLED_IN_STATE,  
        CANNOT_BE_CONN_SYN_AND_COMP, 
        CANNOT_BE_CONN_TWICE,   
        CANNOT_BE_IDENTICAL,    
        CANNOT_BE_NEGATIVE,     
        CANNOT_BE_NULL,         
        CANNOT_BE_LARGER,       
        CANNOT_BE_SMALLER,      
        CANNOT_BE_OFF,          
        CANNOT_BE_ON,           
        CANNOT_BE_POSITIVE,     
        CANNOT_BE_SET_TO,       
        CANNOT_BE_UNKNOWN,      
        CANNOT_BE_ZERO,         
        FILE_CANNOT_CREATE,     
        FILE_CANNOT_OPEN,       
        FILE_CANNOT_READ,       
        IS_DEPRECATED,          
        MUST_BE_LOGGER_CUSTOM,  
        MUST_BE_IDENTICAL,      
        MUST_BE_IN_RANGE,       
        MUST_BE_NEGATIVE,       
        MUST_BE_OFF,            
        MUST_BE_ON,             
        MUST_BE_POSITIVE,       
        MUST_BE_SET_TO,         
        MUST_BE_LARGER,         
        MUST_BE_SMALLER,        
        MUST_BE_ZERO,           
        MUST_HAVE_SAME_SIGN,    
        NETWORK_ALREADY_RUN,    
        UNKNOWN_GROUP_ID,       
        UNKNOWN,                
        WRONG_NEURON_TYPE       
    };


    // +++++ PUBLIC METHODS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //

    static void assertTrue(bool statement, errorType errorIfAssertionFails, std::string errorFunc,
                                std::string errorMsgPrefix="", std::string errorMsgSuffix="");

//  static void userAssertNonZero();
//  static void userAssertNonNegative();

private:
    // +++++ PRIVATE METHODS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //

    static void throwError(std::string errorFunc, errorType error, std::string errorMsgPrefix="",
        std::string errorMsgSuffix="");
};

#endif