AbstractDataWriter.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2009
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 /*
00029  * Abstract base class for data output. Loosely based on
00030  * NetCDF api.
00031  *
00032  *
00033 */
00034 #ifndef ABSTRACTDATAWRITER_HPP
00035 #define ABSTRACTDATAWRITER_HPP
00036 
00037 #include <string>
00038 class AbstractDataWriter
00039 {
00040 
00041 public:
00042 
00043     virtual int  DefineFixedDimension(std::string dimensionName,
00044                                       std::string dimensionUnits,
00045                                       long dimensionSize) = 0;
00046     virtual int  DefineUnlimitedDimension(std::string dimensionName, std::string dimensionUnits) = 0;
00047     virtual int  DefineVariable(std::string variableName, std::string variableUnits) = 0;
00048     virtual void EndDefineMode() = 0;
00049     virtual void AdvanceAlongUnlimitedDimension() = 0;
00050     virtual void PutVariable(int variableID, double variableValue, long dimensionPosition=-1) = 0;
00051     virtual void Close() = 0;
00052 
00053     virtual ~AbstractDataWriter()
00054     {}
00055 
00056 };
00057 
00058 #endif

Generated on Wed Mar 18 12:51:52 2009 for Chaste by  doxygen 1.5.5