HHGate.h

Go to the documentation of this file.

#ifndef _HHGate_h
#define _HHGate_h
/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment.
**           copyright (C) 2003-2011 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.
**********************************************************************/

class HHGate
{
    friend void testHHGateLookup();
    friend void testHHGateSetup();
    public:
        HHGate();

        HHGate( Id originalChanId, Id originalGateId );

        // LookupValueFinfos

        double lookupA( double v ) const;

        double lookupB( double v ) const;

        // Field functions
        void setAlpha( const Eref& e, vector< double > val);
        vector< double > getAlpha( const Eref& e) const;
        void setBeta( const Eref& e, vector< double > val );
        vector< double > getBeta( const Eref& e) const;
        void setTau( const Eref& e, vector< double > val );
        vector< double > getTau( const Eref& e) const;
        void setMinfinity( const Eref& e,
            vector< double > val );
        vector< double > getMinfinity( const Eref& e) const;

        void setMin( const Eref& e, double val );
        double getMin( const Eref& e) const;
        void setMax( const Eref& e, double val );
        double getMax( const Eref& e) const;
        void setDivs( const Eref& e, unsigned int val );
        unsigned int getDivs( const Eref& e) const;

        void setTableA( const Eref& e, vector< double > v);
        vector< double > getTableA( const Eref& e) const;

        void setTableB( const Eref& e, vector< double > v);
        vector< double > getTableB( const Eref& e) const;

        void setUseInterpolation( const Eref& e, bool val );
        bool getUseInterpolation( const Eref& e) const;

        void setupAlpha( const Eref& e, vector< double > parms );
        vector< double > getAlphaParms( const Eref& e ) const;

        // DestFinfos
        void setupTau( const Eref& e,
            vector< double > parms );
        void tweakAlpha();
        void tweakTau();
        void setupGate( const Eref& e,
            vector< double > parms );
        void setupTables( const vector< double >& parms, bool doTau );
        void tweakTables( bool doTau );

        void lookupBoth( double v, double* A, double* B ) const;


        // Utility funcs

        double lookupTable( const vector< double >& tab, double v ) const;

        bool checkOriginal( Id id, const string& field ) const;

        bool isOriginalChannel( Id id ) const;

        bool isOriginalGate( Id id ) const;

        Id originalChannelId() const;

        Id originalGateId() const;

        void tabFill( vector< double >& table,
            unsigned int newXdivs, double newXmin, double newXmax );

        void updateTauMinf();

        void updateAlphaBeta();

        void updateTables();

        static const Cinfo* initCinfo();
    private:
        vector< double > alpha_;

        vector< double > beta_;

        vector< double > tau_;

        vector< double > mInfinity_;

        vector< double > A_;

        vector< double > B_;

        double xmin_;

        double xmax_;

        double invDx_;

        Id originalChanId_;

        Id originalGateId_;

        bool lookupByInterpolation_;

        bool isDirectTable_;
};

#endif // _HHGate_h