global.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment,
** also known as GENESIS 3 base code.
**           copyright (C) 2003-2004 Upinder S. Bhalla. and NCBS
** It is made available under the terms of the
** GNU Lesser Public License version 2.1
** See the file COPYING.LIB for the full notice.
**********************************************************************/


#ifndef  __MOOSE_GLOBAL_INC_
#define  __MOOSE_GLOBAL_INC_

#include <ctime>
#include <map>
#include <sstream>

#include "../randnum/RNG.h"                        /* Use inbuilt rng */
#include "../utility/print_function.hpp"

using namespace std;

extern stringstream errorSS;

extern unsigned int totalTests;


#define TEST_BEGIN cout << endl << "Test(" << totalTests << "): " << SIMPLE_CURRENT_FUNCTION;
#define TEST_END totalTests++; \
    cout << std::right <<  setw(20) << "test of " << SIMPLE_CURRENT_FUNCTION << " finished.";

#define MISSING_BRACKET_AT_END                  -1
#define EMPTY_PATH                              -2
#define SPACES_AT_THE_BEGINING                  -3
#define SPACES_AT_THE_END                       -4
#define SPACES_IN_BETWEEN                       -5
#define BAD_CHARACTER_IN_PATH                   -6


/*-----------------------------------------------------------------------------
 *  Global functions in namespace moose
 *-----------------------------------------------------------------------------*/
namespace moose
{

    extern moose::RNG<double> rng;

    extern unsigned long __rng_seed__;

    string fixPath(string path);

    int checkPath( const string& path );

    string joinPath(string pathA, string pathB);

    void mtseed( unsigned int seed );

    double mtrand( void );

    string createMOOSEPath( const string& path );

    string toString( double x );

    bool createParentDirs( const string& path );

    string toFilename( const string& path );

    string getExtension( const string& path, bool without_dot = true );

    string pathToName( const string& path );

    string moosePathToUserPath( string path );

    /* --------------------------------------------------------------------------*/
    /* ----------------------------------------------------------------------------*/
    int getGlobalSeed( );

    /* --------------------------------------------------------------------------*/
    /* ----------------------------------------------------------------------------*/
    void setGlobalSeed( int seed );
}

#endif   /* ----- #ifndef __MOOSE_GLOBAL_INC_  ----- */