Chaste Release::3.1
AbstractDataWriter.hpp
00001 /*
00002 
00003 Copyright (c) 2005-2012, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #ifndef ABSTRACTDATAWRITER_HPP
00037 #define ABSTRACTDATAWRITER_HPP
00038 
00039 #include <string>
00040 
00045 class AbstractDataWriter
00046 {
00047 public:
00048 
00059     virtual int DefineFixedDimension(const std::string& rDimensionName,
00060                                      const std::string& rDimensionUnits,
00061                                      long dimensionSize)=0;
00062 
00072     virtual int  DefineUnlimitedDimension(const std::string& rDimensionName,
00073                                           const std::string& rDimensionUnits)=0;
00074 
00084     virtual int DefineVariable(const std::string& rVariableName,
00085                                const std::string& rVariableUnits)=0;
00086 
00091     virtual void EndDefineMode()=0;
00092 
00097     virtual void AdvanceAlongUnlimitedDimension()=0;
00098 
00108     virtual void PutVariable(int variableID, double variableValue, long dimensionPosition=-1)=0;
00109 
00114     virtual void Close()=0;
00115 
00119     virtual ~AbstractDataWriter()
00120     {}
00121 };
00122 
00123 #endif //ABSTRACTDATAWRITER_HPP