iEntry.hpp

Go to the documentation of this file.

/*------------------------------- phasicFlow ---------------------------------
      O        C enter of
     O O       E ngineering and
    O   O      M ultiscale modeling of
   OOOOOOO     F luid flow       
------------------------------------------------------------------------------
  Copyright (C): www.cemf.ir
  email: hamid.r.norouzi AT gmail.com
------------------------------------------------------------------------------  
Licence:
  This file is part of phasicFlow code. It is a free software for simulating 
  granular and multiphase flows. You can redistribute it and/or modify it under
  the terms of GNU General Public License v3 or any other later versions. 
 
  phasicFlow is distributed to help others in their research in the field of 
  granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the
  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-----------------------------------------------------------------------------*/
// based on OpenFOAM dictionary, with some modifications/simplifications
// to be tailored to our needs
 
#ifndef __iEntry_hpp__
#define __iEntry_hpp__
 
 
#include "types.hpp"
#include "typeInfo.hpp"
#include "uniquePtr.hpp"
 
 
namespace pFlow
{
 
 
class dictionary;
 
class iEntry
{
 
public:
    
 
        static bool readKeyword(iIstream &is, word& keyword, token& tok );
 
        static bool createEntry(dictionary& parDict, iIstream& is, bool hasBlockToken = false);
 
protected:
 
    // keyWord of entry
    word keyword_;
 
    bool writeKeyword(iOstream& os)const;
 
public:
    
    TypeInfo("iEntry");
 
 
        iEntry()
        {}
 
        iEntry(const word& key)
        {
            // this moved here due to a very strange core dumped error!
            keyword_ = key;
        }
 
        virtual ~iEntry()
        {}
 
 
 
        virtual const word& keyword() const
        {
            return keyword_;
        }
 
        virtual word& keyword()
        {
            return keyword_;
        }
 
        virtual word name()const
        {
            return keyword();
        }
 
        // global name of entry, separated with dots
        virtual word globalName()const = 0;
 
        virtual dictionary* dictPtr()
        {
            return nullptr;
        }
 
        virtual const dictionary* dictPtr() const
        {
            return nullptr;
        }
 
        virtual bool isDictionary() const
        {
            return false;
        }
 
        virtual const dictionary& parrentDict() const = 0;
        
        virtual dictionary& dict() = 0;
 
        virtual const dictionary& dict() const = 0;
 
        virtual iEntry* clonePtr() const = 0;
 
        virtual uniquePtr<iEntry> clone() const = 0;
 
        virtual iEntry* clonePtr(const dictionary& parDict) const = 0;
 
        virtual uniquePtr<iEntry> clone(const dictionary& parDict)const = 0;
 
 
        virtual bool read(iIstream& is) = 0;
 
        virtual bool write(iOstream& os) const =0;
 
};
 
 
iOstream& operator << (iOstream& os, const iEntry& e);
 
iIstream& operator >> (iIstream& is, iEntry& e);
 
 
} // pFlow
 
 
#endif //__iEntry_hpp__