ColumnDataWriter.hpp

/*

Copyright (C) University of Oxford, 2005-2009

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste 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 Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/
/*
 * Concrete DataWriter class. Writes grid-formatted data in space separated column form.
 * Each file has a header row with names and optional units for each column.
 *
*/
#ifndef COLUMNDATAWRITER_HPP
#define COLUMNDATAWRITER_HPP

#include "AbstractDataWriter.hpp"
#include "DataWriterVariable.hpp"
#include "OutputFileHandler.hpp"
#include "Exception.hpp"

#include <string>
#include <fstream>
#include <iostream>
#include <sstream>
#include <iomanip>
#include <cassert>
#include <ctype.h>
//#include <sys/stat.h> // For chmod()

const int FILE_SUFFIX_WIDTH = 6;


class ColumnDataWriter : public AbstractDataWriter
{
protected:
    OutputFileHandler mOutputFileHandler; 

    std::string mDirectory; 
    std::string mBaseName; 
    bool mIsInDefineMode; 
    bool mIsFixedDimensionSet; 
    bool mIsUnlimitedDimensionSet; 
    long mUnlimitedDimensionPosition; 
    long mFixedDimensionSize; 
    out_stream mpCurrentOutputFile; 
    out_stream mpCurrentAncillaryFile; 
    DataWriterVariable *mpUnlimitedDimensionVariable; 
    DataWriterVariable *mpFixedDimensionVariable; 
    std::string mUnlimitedDimensionName; 
    std::string mUnlimitedDimensionUnits; 
    std::string mFixedDimensionName; 
    std::string mFixedDimensionUnits; 
    std::vector<DataWriterVariable> mVariables; 
    static const int FIELD_WIDTH = 10; 
    static const int SPACING = 2; 
    static const int FIXED_DIMENSION_VAR_ID = -1; 
    static const int UNLIMITED_DIMENSION_VAR_ID = -2;
    std::string mFileExtension; 
    int mRowStartPosition; 
    int mRowWidth; 
    int mAncillaryRowStartPosition; 
    int mAncillaryRowWidth; 
    bool mHasPutVariable;
    bool mNeedAdvanceAlongUnlimitedDimension;

    void CreateFixedDimensionFile(std::string filepath);

    void CreateInfoFile(std::string filepath);

    void CheckVariableName(std::string name); 
    void CheckUnitsName(std::string name); 
    void DoAdvanceAlongUnlimitedDimension();

public:

    ColumnDataWriter(std::string directory, std::string baseName, bool cleanDirectory=true);
    virtual ~ColumnDataWriter();
    int DefineUnlimitedDimension(std::string dimensionName, std::string dimensionUnits);
    int DefineFixedDimension(std::string dimensionName, std::string dimensionUnits, long dimensionSize);
    int DefineVariable(std::string variableName, std::string variableUnits);
    virtual void EndDefineMode();
    virtual void AdvanceAlongUnlimitedDimension();

    virtual void PutVariable(int variableID, double variableValue, long dimensionPosition = -1);
    virtual void Close();

    std::string GetOutputDirectory(void);
};

#endif

---