Chaste  Release::2018.1
ColumnDataWriter.hpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef COLUMNDATAWRITER_HPP_
37 #define COLUMNDATAWRITER_HPP_
38 
39 #include <string>
40 #include <vector>
41 
42 #include "AbstractDataWriter.hpp"
43 #include "DataWriterVariable.hpp"
44 #include "OutputFileHandler.hpp"
45 
52 {
53 protected:
54 
57  std::string mDirectory;
58  std::string mBaseName;
64  out_stream mpCurrentOutputFile;
72  std::string mFixedDimensionName;
73  std::string mFixedDimensionUnits;
75  std::vector<DataWriterVariable> mVariables;
77  const unsigned mFieldWidth;
78  const unsigned mPrecision;
79  static const int SPACING = 1;
80  static const int FIXED_DIMENSION_VAR_ID = -1;
81  static const int UNLIMITED_DIMENSION_VAR_ID = -2;
83  std::string mFileExtension;
86  int mRowWidth;
98  std::string mCommentForInfoFile;
99 
105  void CreateFixedDimensionFile(const std::string& rFileName);
106 
112  void CreateInfoFile(const std::string& rFileName);
113 
119  void CheckVariableName(const std::string& rName);
120 
126  void CheckUnitsName(const std::string& rName);
127 
133 
134 public:
135 
146  ColumnDataWriter(const std::string& rDirectory,
147  const std::string& rBaseName,
148  bool cleanDirectory=true,
149  unsigned precision=8);
150 
154  virtual ~ColumnDataWriter();
155 
164  int DefineUnlimitedDimension(const std::string& rDimensionName,
165  const std::string& rDimensionUnits);
166 
176  int DefineFixedDimension(const std::string& rDimensionName,
177  const std::string& rDimensionUnits,
178  long dimensionSize);
179 
188  int DefineVariable(const std::string& rVariableName,
189  const std::string& rVariableUnits);
190 
197  void SetCommentForInfoFile(std::string comment)
198  {
199  mCommentForInfoFile = comment;
200  }
201 
205  virtual void EndDefineMode();
206 
210  virtual void AdvanceAlongUnlimitedDimension();
211 
220  virtual void PutVariable(int variableID, double variableValue, long dimensionPosition = -1);
221 
225  virtual void Close();
226 
230  std::string GetOutputDirectory();
231 };
232 
233 #endif //COLUMNDATAWRITER_HPP_
void CheckVariableName(const std::string &rName)
static const int SPACING
std::string mFileExtension
out_stream mpCurrentOutputFile
virtual void PutVariable(int variableID, double variableValue, long dimensionPosition=-1)
int DefineUnlimitedDimension(const std::string &rDimensionName, const std::string &rDimensionUnits)
virtual void AdvanceAlongUnlimitedDimension()
const unsigned mPrecision
void DoAdvanceAlongUnlimitedDimension()
virtual void Close()
std::vector< DataWriterVariable > mVariables
virtual void EndDefineMode()
static const int UNLIMITED_DIMENSION_VAR_ID
std::string GetOutputDirectory()
std::string mDirectory
out_stream mpCurrentAncillaryFile
const unsigned mFieldWidth
DataWriterVariable * mpFixedDimensionVariable
virtual ~ColumnDataWriter()
ColumnDataWriter(const std::string &rDirectory, const std::string &rBaseName, bool cleanDirectory=true, unsigned precision=8)
void CreateFixedDimensionFile(const std::string &rFileName)
int DefineVariable(const std::string &rVariableName, const std::string &rVariableUnits)
void SetCommentForInfoFile(std::string comment)
int DefineFixedDimension(const std::string &rDimensionName, const std::string &rDimensionUnits, long dimensionSize)
std::string mCommentForInfoFile
std::string mFixedDimensionName
std::string mFixedDimensionUnits
std::string mUnlimitedDimensionName
void CheckUnitsName(const std::string &rName)
std::string mUnlimitedDimensionUnits
static const int FIXED_DIMENSION_VAR_ID
void CreateInfoFile(const std::string &rFileName)
DataWriterVariable * mpUnlimitedDimensionVariable
bool mNeedAdvanceAlongUnlimitedDimension
OutputFileHandler mOutputFileHandler