openfoam/applications/utilities/preProcessing/FoamX/C++/FoamXLib/RootDictionary.H
2008-04-15 18:56:58 +01:00

112 lines
3.1 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2007 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::IDictionaryEntryImpl
Description
SourceFiles
RootDictionary.C
\*---------------------------------------------------------------------------*/
#ifndef RootDictionary_H
#define RootDictionary_H
// FoamX header files.
#include "IDictionaryEntryImpl.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace FoamX
{
/*---------------------------------------------------------------------------*\
Class RootDictionary Declaration
\*---------------------------------------------------------------------------*/
class RootDictionary
:
public IDictionaryEntryImpl
{
// Private data
Foam::fileName caseRoot_;
Foam::fileName caseName_;
public:
// Constructors
RootDictionary
(
FoamXServer::ITypeDescriptor_ptr typeDesc,
const Foam::fileName& caseRoot,
const Foam::fileName& caseName
);
// Destructor
virtual ~RootDictionary();
// Member Functions
//- Return the dictPath with root and case if it isn't absolute
static Foam::fileName path
(
const Foam::fileName& rootDir,
const Foam::fileName& caseName,
const Foam::fileName& dictPath
);
//- Return the full path of the dictionary
Foam::fileName pathName();
// Overridden IDictionaryEntry load
virtual void load(Foam::Istream&);
//- Load the dictionary if the it's file exists
void load();
// Overridden IDictionaryEntry save
virtual void save();
//- Write the dictionary entries using the dictWriter
void writeEntries(DictionaryWriter& dictWriter);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace FoamX
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //