Clock.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**           Copyright (C) 2003-2007 Upinder S. Bhalla. and NCBS
** It is made available under the terms of the
** GNU Lesser General Public License version 2.1
** See the file COPYING.LIB for the full notice.
**********************************************************************/

#ifndef _CLOCK_H
#define _CLOCK_H

class Clock
{
    friend void testClock();
    public:
    Clock();
    ~Clock();

    //  Field assignment functions
    void setDt( double v );
    double getDt() const;
    double getRunTime() const;
    double getCurrentTime() const;
    unsigned long getNsteps( ) const;
    unsigned long getCurrentStep() const;
    unsigned int getStride( ) const;

    void setTickStep( unsigned int i, unsigned int v );
    unsigned int getTickStep( unsigned int i ) const;
    void setTickDt( unsigned int i, double v );
    double getTickDt( unsigned int i ) const;
    unsigned int getDefaultTick( string className ) const;

    vector< double > getDts() const;

    //  Dest functions

    void stop();

    void handleStart( const Eref& e, double runtime, bool notify );

    void handleStep( const Eref& e, unsigned long steps );

    void handleReinit( const Eref& e );

    // Stuff for new scheduling.
    // Goes through the process loop.
    void process();


    unsigned int getNumTicks() const;

    bool isRunning() const;
    bool isDoingReinit() const;

    static void reportClock();
    void innerReportClock() const;

    // static void* threadStartFunc( void* threadInfo );
    static const Cinfo* initCinfo();

    bool checkTickNum( const string& funcName, unsigned int i ) const;

    static unsigned int lookupDefaultTick( const string& className );

    static void buildDefaultTick();

    /*
     * Does nasty message traversal to look up the clock tick that
     * sends the Process/reinit message to the Dsolve (specified by e)
     * and then figure out the dt used.
     static double findDt( const Eref& e );
     */

    static const unsigned int numTicks;

    private:
    void buildTicks( const Eref& e );
    double runTime_;
    double currentTime_;
    unsigned long nSteps_;
    unsigned long currentStep_;
    unsigned int stride_; // Increment to currentStep each cycle.
    double dt_; 

    bool isRunning_;

    bool doingReinit_;

    ProcInfo info_;

    vector< unsigned int > ticks_;

    vector< unsigned int > activeTicks_;
    vector< unsigned int > activeTicksMap_;

    static map< string, unsigned int > defaultTick_;

    static vector< double > defaultDt_;

    bool notify_;
};

#endif // _CLOCK_H