ObjId.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 _OBJ_ID_H
#define _OBJ_ID_H

#include "Id.h"

class ObjId
{
    friend ostream& operator <<( ostream& s, const ObjId& i );
    friend istream& operator >>( istream& s, ObjId& i );
    public:
        //  ObjId creation

        ObjId()
            : id(), dataIndex( 0 ), fieldIndex( 0 )
        {;}

        ObjId( Id i, unsigned int d, unsigned int f = 0 )
            : id( i ), dataIndex( d ), fieldIndex( f )
        {;}

        ObjId( Id i )
            : id( i ), dataIndex( 0 ), fieldIndex( 0 )
        {;}

        ObjId( const string& path );

        string path() const;

        Eref eref() const;

        bool operator==( const ObjId& other ) const;
        bool operator!=( const ObjId& other ) const;

        bool operator<( const ObjId& other ) const;

        bool isDataHere() const;

        bool isGlobal() const;

        bool isOffNode() const;

        char* data() const;

        Element* element() const;

        Id id;
        unsigned int dataIndex;
        unsigned int fieldIndex;

        bool bad() const;

    private:
};

#endif // _OBJ_ID_H