Cinfo.h

Go to the documentation of this file.

/**********************************************************************
** This program is part of 'MOOSE', the
** Messaging Object Oriented Simulation Environment,
** also known as GENESIS 3 base code.
**           copyright (C) 2003-2009 Upinder S. Bhalla. and NCBS
** It is made available under the terms of the
** GNU General Public License version 2
** See the file COPYING.LIB for the full notice.
**********************************************************************/
#ifndef _CINFO_H
#define _CINFO_H

class DinfoBase;

class Cinfo
{
        public:
            Cinfo( const std::string& name,
                    const Cinfo* baseCinfo, // Base class
                    Finfo** finfoArray, // Field information array
                    unsigned int nFinfos,
                    DinfoBase* d,   // A handle to lots of utility functions for the Data class.
                    const string* doc = 0,
                    unsigned int numDoc = 0,
                    bool banCreation = false
            );

            Cinfo();

            Cinfo( const Cinfo& other );

            ~Cinfo();

            void init( Finfo** finfoArray, unsigned int nFinfos );

            void registerFinfo( Finfo* f );

            FuncId registerOpFunc( const OpFunc* f );

            void overrideFunc( FuncId fid, const OpFunc* f );

            BindIndex registerBindIndex();

            void postCreationFunc( Id newId, Element* newElm ) const;

            void registerPostCreationFinfo( const Finfo* f );

            bool banCreation() const;

            const OpFunc* getOpFunc( FuncId fid ) const;
            // FuncId getOpFuncId( const string& funcName ) const;

            const std::string& name() const;

            static const Cinfo* find( const std::string& name );

            /*
             * Returns base Cinfo class. The Neutral returns 0.
             */
            const Cinfo* baseCinfo() const;

            const Finfo* findFinfo( const string& name) const;

            unsigned int numBindIndex() const;

            const map< string, Finfo* >& finfoMap() const;

            const DinfoBase* dinfo() const;

            bool isA( const string& ancestor ) const;

            void reportFids() const;

        // Functions here for the MOOSE Cinfo inspection class

            string getDocs() const;

            string getBaseClass() const;


            Finfo* getSrcFinfo( unsigned int i ) const;

            unsigned int getNumSrcFinfo() const;

            Finfo* getDestFinfo( unsigned int i ) const;

            unsigned int getNumDestFinfo() const;

            Finfo* getValueFinfo( unsigned int i ) const;

            unsigned int getNumValueFinfo() const;

            Finfo* getLookupFinfo( unsigned int i ) const;
            unsigned int getNumLookupFinfo() const;

            Finfo* getSharedFinfo( unsigned int i );

            unsigned int getNumSharedFinfo() const;

            Finfo* getFieldElementFinfo( unsigned int i ) const;

            unsigned int getNumFieldElementFinfo() const;

            void setNumFinfo( unsigned int v );

             const string& srcFinfoName( BindIndex bid ) const;

             const string& destFinfoName( FuncId fid ) const;



            static void makeCinfoElements( Id parent );

            static void rebuildOpIndex();

            static const Cinfo* initCinfo();

        private:
            string name_;

            // const std::string author_;
            // const std::string description_;
            const Cinfo* baseCinfo_;
            const DinfoBase* dinfo_;

            BindIndex numBindIndex_;
            std::map< std::string, std::string > doc_;

            bool banCreation_;

            map< string, Finfo* > finfoMap_;

            vector< Finfo* > srcFinfos_;

            vector< Finfo* > destFinfos_;

            vector< Finfo* > valueFinfos_;

            vector< Finfo* > lookupFinfos_;

            vector< Finfo* > sharedFinfos_;

            vector< Finfo* > fieldElementFinfos_;

            vector< const Finfo* > postCreationFinfos_;
            vector< const OpFunc* > funcs_;

            // Useful to know in case we have transient OpFuncs made and
            //destroyed.
            static unsigned int numCoreOpFunc_;
//          map< string, FuncId > opFuncNames_;

            static map< string, Cinfo* >& cinfoMap();

            // Many opfuncs share same FuncId
            // static map< OpFunc*, FuncId >& funcMap();
};

#endif // _CINFO_H