Eref.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 _EREF_H
#define _EREF_H

#ifdef  CYMOOSE

#include <iostream>
#include <vector>
using namespace std;

class Element;
class Id;
class ObjId;
class MsgDigest;

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

class Eref
{
public:

    friend ostream& operator <<( ostream& s, const Eref& e );
    Eref();
    Eref( Element* e, unsigned int index, unsigned int field = 0 );

    char* data() const;

    Element* element() const
    {
        return e_;
    }

    unsigned int dataIndex() const
    {
        return i_;
    }

    unsigned int fieldIndex() const
    {
        return f_;
    }

    ObjId objId() const;

    Id id() const;

    const vector< MsgDigest >& msgDigest(unsigned int bindIndex ) const;

    bool isDataHere() const;

    unsigned int getNode() const;
private:
    Element* e_;
    unsigned int i_;
    unsigned int f_;
};

#endif // _EREF_H