Msg.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 _MSG_H
#define _MSG_H

class Msg
{
    public:
        Msg( ObjId mid, Element* e1, Element* e2 );

        virtual ~Msg();

        static void deleteMsg( ObjId mid );

        virtual Eref firstTgt( const Eref& src ) const = 0;

         virtual void sources ( vector< vector< Eref > >& v ) const = 0;

         virtual void targets( vector< vector< Eref > >& v ) const = 0;

        Element* e1() const {
            return e1_;
        }

        Element* e2() const {
            return e2_;
        }

         Id getE1() const;

         Id getE2() const;


         vector< string > getSrcFieldsOnE1() const;

         vector< string > getDestFieldsOnE2() const;

         vector< string > getSrcFieldsOnE2() const;

         vector< string > getDestFieldsOnE1() const;

        ObjId mid() const {
            return mid_;
        }

        virtual ObjId findOtherEnd( ObjId ) const = 0;


        ObjId getAdjacent( ObjId ) const;

        virtual Msg* copy( Id origSrc, Id newSrc, Id newTgt,
            FuncId fid, unsigned int b, unsigned int n ) const = 0;

        bool isForward( const Element* src ) const {
            return ( e1_ == src );
        }

        static const Msg* getMsg( ObjId m );

        static const Cinfo* initCinfo();

        static unsigned int initMsgManagers();

        static void clearAllMsgs();

        static const Msg* lastMsg();

        static bool isLastTrump();
    protected:
        ObjId mid_; 

        Element* e1_; 
        Element* e2_; 

        static Id msgManagerId_;

        static bool lastTrump_;

    private:
        static const Msg* lastMsg_;
};

#endif // _MSG_H