Pool.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**           Copyright (C) 2003-2010 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 _POOL_H
#define _POOL_H
#include "PoolBase.h"
class Pool: public PoolBase
{
public:
    Pool();
    ~Pool();

    // Field assignment stuff. All override virtual funcs in the Pool
    // base class.

    void vSetN( const Eref& e, double v );
    double vGetN( const Eref& e ) const;
    void vSetNinit( const Eref& e, double v );
    double vGetNinit( const Eref& e ) const;
    void vSetDiffConst( const Eref& e, double v );
    double vGetDiffConst( const Eref& e ) const;
    void vSetMotorConst( const Eref& e, double v );
    double vGetMotorConst( const Eref& e ) const;

    void vSetConc( const Eref& e, double v );
    double vGetConc( const Eref& e ) const;
    void vSetConcInit( const Eref& e, double v );
    // double vGetConcInit( const Eref& e ) const;

    void vSetVolume( const Eref& e, double v );
    double vGetVolume( const Eref& e ) const;

    void vSetSpecies( const Eref& e, SpeciesId v );
    SpeciesId vGetSpecies( const Eref& e ) const;


    void vSetIsBuffered( const Eref& e, bool v );
    bool vGetIsBuffered( const Eref& e) const;

    // Dest funcs. These too override virtual funcs in the Pool base
    // class.

    void vHandleMolWt( const Eref& e, double v );
    void vProcess( const Eref& e, ProcPtr p );
    void vReinit( const Eref& e, ProcPtr p );
    void vReac( double A, double B );
    void vIncrement( double val );
    void vDecrement( double val );
    void vnIn( double val );

    // Novel Dest funcs not present in Pool base class.

    static const Cinfo* initCinfo();
private:
    double n_; 
    double nInit_; 
    double diffConst_;  
    double motorConst_; 
    double A_; 
    double B_;

    unsigned int species_;
};

#endif  // _POOL_H