Finfo.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 _FINFO_H
#define _FINFO_H

class Finfo
{
public:
    Finfo( const string& name, const string& doc );
    virtual ~Finfo()
    {
        ;
    }

    const string& name() const;

    const string& docs() const;

    virtual void registerFinfo( Cinfo* c ) = 0;

    virtual bool strSet( const Eref& tgt, const string& field,
                         const string& arg ) const = 0;

    virtual bool strGet( const Eref& tgt, const string& field,
                         string& returnValue ) const = 0;

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

    virtual bool checkTarget( const Finfo* target) const
    {
        return 0;
    }

    virtual bool addMsg( const Finfo* target, ObjId mid, Element* src ) const
    {
        return 0;
    }

    // Functions for handling MOOSE Element inspection

    virtual string rttiType() const;

    virtual vector< string > innerSrc() const;

    virtual vector< string > innerDest() const;

    static const Cinfo* initCinfo();

private:
    string name_;
    string doc_;
};

// Wrapper to handle the access functions to the Finfo objects.
class FinfoWrapper
{
public:
    FinfoWrapper( const Finfo* other )
        : f_( other )
    {
        ;
    }

    string getName( ) const;
    string docs( ) const;
    string type( ) const;
    vector< string > src( ) const;
    vector< string > dest( ) const;

private:
    const Finfo* f_;
};

#endif // _FINFO_H