basecode/MsgElement.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 _MSG_ELEMENT_H
#define _MSG_ELEMENT_H

class SrcFinfo;
class FuncOrder;

class MsgElement: public Element
{
    public:
        MsgElement( Id id, const Cinfo* c, const string& name,
             unsigned int( *numMsg )(), 
             char* ( *lookupMsg )( unsigned int ) )
                : 
                    Element( id, c, name ),
                    numMsg_( numMsg ),
                    lookupMsg_( lookupMsg )
        {;} 

        ~MsgElement()
        {;}

        Element* copyElement( Id newParent, Id newId, unsigned int n, 
            bool toGlobal ) const
        {
            return 0;
        }

        // Information access fields

        unsigned int numData() const
        {
            return numMsg_();
        }

        unsigned int numLocalData() const
        {
            return numMsg_();
        }

        unsigned int localDataStart() const
        {
            return 0;
        }

        unsigned int numField( unsigned int rawIndex ) const
        {
                return 1;
        }

        unsigned int totNumLocalField() const
        {
            return numMsg_();
        }

        unsigned int getNode( unsigned int dataIndex ) const
        {
                return Shell::myNode();
        }

        unsigned int startDataIndex( unsigned int node ) const
        {
                return 0;
        }

        unsigned int rawIndex( unsigned int dataIndex ) const
        {
                return dataIndex;
        }

        bool hasFields() const {
            return false;
        }

        bool isGlobal() const {
            return true;
        }

        unsigned int getNumOnNode( unsigned int node ) const {
            return numMsg_();
        }

        // data access stuff

        char* data( unsigned int rawIndex, 
                        unsigned int fieldIndex = 0 ) const
        {
            return lookupMsg_( rawIndex );
        }

        void resize( unsigned int newNumData )
        {;}

        void resizeField( unsigned int rawIndex, unsigned int newNumField )
        {;}


        void zombieSwap( const Cinfo* newCinfo ) {
            replaceCinfo( newCinfo );
            Element::zombieSwap( newCinfo );
        }


    private:
         unsigned int( *numMsg_ )();

         char* ( *lookupMsg_ )( unsigned int );
};

#endif // _Msg_ELEMENT_H

---