Neutral.h

Go to the documentation of this file.

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


#ifdef  CYMOOSE

#include "../basecode/ProcInfo.h"

class Cinfo;

#endif     /* -----  CYMOOSE  ----- */

class Neutral
{
    public:
        friend istream& operator >>( istream& s, Neutral& d );
        friend ostream& operator <<( ostream& s, const Neutral& d );
        Neutral();

        // Field access functions

        void setThis( Neutral v );

        Neutral getThis() const;

        void setName( const Eref& e, string name );
        string getName( const Eref& e ) const;

        vector< ObjId > getOutgoingMsgs( const Eref& e ) const;

        vector< ObjId > getIncomingMsgs( const Eref& e ) const;

        vector< Id > getNeighbors( const Eref& e, string field ) const;

        vector< ObjId > getMsgDests( const Eref& e, string src ) const;

        vector< string > getMsgDestFunctions(
                        const Eref& e, string src ) const;

        bool isA( const Eref& e, string className ) const;

        ObjId getObjId( const Eref& e ) const;

        ObjId getParent( const Eref& e ) const;

        vector< Id > getChildren( const Eref& e ) const;

        unsigned int buildTree( const Eref& e, vector< Id >& tree ) const;

        string getPath( const Eref& e ) const;

        string getClass( const Eref& e ) const;

        void setNumData( const Eref& e, unsigned int num );
        unsigned int getNumData( const Eref& e ) const;

        void setNumField( const Eref& e, unsigned int num );
        unsigned int getNumField( const Eref& e ) const;

        unsigned int getId( const Eref& e ) const;
        unsigned int getIndex( const Eref& e ) const;
        unsigned int getFieldIndex( const Eref& e ) const;

        void setTick( const Eref& e, int num );
        int getTick( const Eref& e ) const;

        double getDt( const Eref& e ) const;

        vector< string > getValueFields( const Eref& e ) const;
        vector< string > getSourceFields( const Eref& e ) const;
        vector< string > getDestFields( const Eref& e ) const;
        // DestFinfo functions

        void destroy( const Eref& e, int stage );

        void blockNodeBalance( const Eref& e,
            unsigned int, unsigned int, unsigned int );

        void generalNodeBalance( const Eref& e,
            unsigned int myNode, vector< unsigned int > nodeAssignment );


        // Static utility functions

        static Id child( const Eref& e, const string& name );

        static ObjId parent( const Eref& e );
        static ObjId parent( ObjId id );

        static bool isDescendant( Id me, Id ancestor );

        static const Cinfo* initCinfo();

        static void children( const Eref& e, vector< Id >& ret );

        static string path( const Eref& e );

        static bool isGlobalField( const string& field );

    private:
        // string name_;
};

#endif // _NEUTRAL_H