AbstractDataWriter.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2010
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 
00030 #ifndef ABSTRACTDATAWRITER_HPP
00031 #define ABSTRACTDATAWRITER_HPP
00032 
00033 #include <string>
00034 
00039 class AbstractDataWriter
00040 {
00041 public:
00042 
00053     virtual int DefineFixedDimension(const std::string& rDimensionName,
00054                                      const std::string& rDimensionUnits,
00055                                      long dimensionSize)=0;
00056 
00066     virtual int  DefineUnlimitedDimension(const std::string& rDimensionName,
00067                                           const std::string& rDimensionUnits)=0;
00068 
00078     virtual int DefineVariable(const std::string& rVariableName,
00079                                const std::string& rVariableUnits)=0;
00080 
00085     virtual void EndDefineMode()=0;
00086 
00091     virtual void AdvanceAlongUnlimitedDimension()=0;
00092 
00102     virtual void PutVariable(int variableID, double variableValue, long dimensionPosition=-1)=0;
00103 
00108     virtual void Close()=0;
00109 
00113     virtual ~AbstractDataWriter()
00114     {}
00115 
00116 };
00117 
00118 #endif //ABSTRACTDATAWRITER_HPP

Generated by  doxygen 1.6.2