HHChannel.h

Go to the documentation of this file.

#ifndef _HHChannel_h
#define _HHChannel_h
/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment,
** also known as GENESIS 3 base code.
**           copyright (C) 2003-2014 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 HHChannel: public HHChannelBase, public ChanCommon
{
#ifdef DO_UNIT_TESTS
    friend void testHHChannel();
    friend void testHHGateCreation();
#endif // DO_UNIT_TESTS
    public:
        HHChannel();
        ~HHChannel();

        // Value field access function definitions

        void vSetXpower( const Eref& e, double Xpower );
        void vSetYpower( const Eref& e, double Ypower );
        void vSetZpower( const Eref& e, double Zpower );
        void vSetInstant( const Eref& e, int Instant );
        int vGetInstant( const Eref& e ) const;
        void vSetX( const Eref& e, double X );
        double vGetX( const Eref& e ) const;
        void vSetY( const Eref& e, double Y );
        double vGetY( const Eref& e ) const;
        void vSetZ( const Eref& e, double Z );
        double vGetZ( const Eref& e ) const;
        void vSetUseConcentration( const Eref& e, int value );
        void vSetModulation( const Eref& e, double modulation );
        double vGetModulation( const Eref& e ) const;

        void innerSetXpower( double Xpower );
        void innerSetYpower( double Ypower );
        void innerSetZpower( double Zpower );

        // Dest function definitions

        void vProcess( const Eref& e, ProcPtr p );

        void vReinit( const Eref& e, ProcPtr p );

        void vHandleConc( const Eref& e, double conc );

        // Gate handling functions

        HHGate* vGetXgate( unsigned int i ) const;

        HHGate* vGetYgate( unsigned int i ) const;

        HHGate* vGetZgate( unsigned int i ) const;

        void innerCreateGate(
             const string& gateName,
            HHGate** gatePtr, Id chanId, Id gateId );

        bool checkOriginal( Id chanId ) const;

        void vCreateGate( const Eref& e, string gateType );
        void destroyGate( const Eref& e, string gateType );

        void innerDestroyGate( const string& gateName,
            HHGate** gatePtr, Id chanId );

        bool setGatePower( const Eref& e, double power,
            double* assignee, const string& gateType );

        static const Cinfo* initCinfo();

    private:
        double conc_;

        double ( *takeXpower_ )( double, double );
        double ( *takeYpower_ )( double, double );
        double ( *takeZpower_ )( double, double );

        int instant_;
        double X_;
        double Y_;
        double Z_;

        bool xInited_, yInited_, zInited_; // true when a state variable
            // has been initialized
        double g_;  

        double integrate( double state, double dt, double A, double B );

        HHGate* xGate_;

        HHGate* yGate_;

        HHGate* zGate_;

        Id myId_;

        static const double EPSILON;
        static const int INSTANT_X;
        static const int INSTANT_Y;
        static const int INSTANT_Z;
};


#endif // _HHChannel_h