basecode/Element.h

Go to the documentation of this file.

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

class SrcFinfo;
class FuncOrder;

class Element
{
    public:
        Element( Id id, const Cinfo* c, const string& name );

        virtual ~Element();

        virtual Element* copyElement( Id newParent, Id newId, 
                    unsigned int n, bool toGlobal ) const = 0;
        // Information access fields

        const string& getName() const;
        
        void setName( const string& val );

        virtual unsigned int numData() const = 0;

        virtual unsigned int numLocalData() const = 0;

        virtual unsigned int localDataStart() const = 0;

        virtual unsigned int numField( unsigned int rawIndex ) const = 0;

        virtual unsigned int totNumLocalField() const = 0;

        virtual unsigned int getNode( unsigned int dataIndex ) const = 0;

        virtual unsigned int startDataIndex( unsigned int nodeNum ) const = 0;

        virtual unsigned int rawIndex( unsigned int dataIndex ) const = 0;

        Id id() const;

        virtual bool hasFields() const = 0;

        virtual bool isGlobal() const = 0;

        virtual unsigned int getNumOnNode( unsigned int node ) const = 0;

        int getTick() const;

        void setTick( int t );

        void innerSetTick( unsigned int tick );

        // data access stuff

        virtual char* data( unsigned int rawIndex, 
                        unsigned int fieldIndex = 0 ) const = 0;

        virtual void resize( unsigned int newNumData ) = 0;

        virtual void resizeField( 
                unsigned int rawIndex, unsigned int newNumField ) = 0;



        void addMsg( ObjId mid );

        void dropMsg( ObjId mid );
        
        void clearBinding( BindIndex b );

        void addMsgAndFunc( ObjId mid, FuncId fid, BindIndex bindIndex );

        const vector< MsgFuncBinding >* getMsgAndFunc( BindIndex b ) const;

        bool hasMsgs( BindIndex b ) const;

        void showFields() const;

        void showMsg() const;

        void digestMessages();

        void putTargetsInDigest(
                        unsigned int srcNum, const MsgFuncBinding& mfb,
                        const FuncOrder& fo,
                        vector< vector< bool > >& targetNodes
        );
        void putOffNodeTargetsInDigest(
            unsigned int srcNum, vector< vector< bool > >& targetNodes );

        const Cinfo* cinfo() const;

        static void destroyElementTree( const vector< Id >& tree );

        void markAsDoomed();
        bool isDoomed() const;

        void markRewired();

        void printMsgDigest( unsigned int srcIndex, unsigned int dataIndex ) const;

        void dropAllMsgsFromSrc( Id src );
    // Utility functions for message traversal
    
        const vector< MsgDigest >& msgDigest( unsigned int index );

         unsigned int findBinding( MsgFuncBinding b ) const;

         const vector< ObjId >& msgIn() const;

         ObjId findCaller( FuncId fid ) const;

        unsigned int getInputMsgs( vector< ObjId >& caller, FuncId fid)
            const;

        unsigned int getNeighbors( vector< Id >& ret, const Finfo* finfo )
            const;

        unsigned int getFieldsOfOutgoingMsg( 
            ObjId mid, vector< pair< BindIndex, FuncId > >& ret ) const;

        unsigned int getMsgTargetAndFunctions( DataId srcDataId,
                const SrcFinfo* finfo ,
                vector< ObjId >& tgt, 
                vector< string >& func
                ) const;

        unsigned int getMsgSourceAndSender( FuncId fid,
                vector< ObjId >& src, 
                vector< string >& sender
                ) const;

        vector< ObjId > getMsgTargets( DataId srcDataId,
                const SrcFinfo* finfo  ) const;

        void clearAllMsgs();

        virtual void zombieSwap( const Cinfo* zCinfo );

        void replaceCinfo( const Cinfo* newCinfo );

    private:
        unsigned int getOutputs( vector< Id >& ret, const SrcFinfo* finfo )
            const;

        unsigned int getInputs( vector< Id >& ret, const DestFinfo* finfo )
            const;

        string name_; 

        Id id_; 

        const Cinfo* cinfo_;

        vector< ObjId > m_;

        vector< vector < MsgFuncBinding > > msgBinding_;

        vector< vector < MsgDigest > > msgDigest_;

        int tick_;

        bool isRewired_; 

        bool isDoomed_;
};

#endif // _ELEMENT_H

---