ColumnDataWriter.hpp

/*

Copyright (C) University of Oxford, 2005-2010

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/>.

*/

#ifndef COLUMNDATAWRITER_HPP_
#define COLUMNDATAWRITER_HPP_

#include <string>
#include <vector>

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


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; 
    const unsigned mFieldWidth; 
    const unsigned mPrecision; 
    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(const std::string& rFileName);

    void CreateInfoFile(const std::string& rFileName);

    void CheckVariableName(const std::string& rName);

    void CheckUnitsName(const std::string& rName);

    void DoAdvanceAlongUnlimitedDimension();

public:
    ColumnDataWriter(const std::string& rDirectory,
                     const std::string& rBaseName,
                     bool cleanDirectory=true,
                     unsigned precision=8);

    virtual ~ColumnDataWriter();

    int DefineUnlimitedDimension(const std::string& rDimensionName,
                                 const std::string& rDimensionUnits);

    int DefineFixedDimension(const std::string& rDimensionName,
                             const std::string& rDimensionUnits,
                             long dimensionSize);

    int DefineVariable(const std::string& rVariableName,
                       const std::string& rVariableUnits);

    virtual void EndDefineMode();

    virtual void AdvanceAlongUnlimitedDimension();

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

    virtual void Close();

    std::string GetOutputDirectory();
};

#endif //COLUMNDATAWRITER_HPP_