ArchiveLocationInfo.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 ARCHIVELOCATIONINFO_HPP_
#define ARCHIVELOCATIONINFO_HPP_

#include <string>
#include <sstream>
#include <cassert>
#include <iostream>

#include "Exception.hpp"
#include "PetscTools.hpp"
#include "OutputFileHandler.hpp"

class ArchiveLocationInfo
{
private:

    static std::string mDirPath;

    static bool mDirIsRelativeToChasteTestOutput;

    static std::string mMeshFilename;


public:
    static void SetMeshPathname(const std::string& rDirectory, const std::string& rFilename)
    {
        SetArchiveDirectory(rDirectory);
        mMeshFilename = rFilename;
    }

    static void SetMeshFilename(const std::string& rFilename)
    {
        mMeshFilename = rFilename;
    }

    static std::string GetMeshFilename()
    {
        if (mMeshFilename == "")
        {
            EXCEPTION("ArchiveLocationInfo::mMeshFilename has not been set");
        }
        return mMeshFilename;
    }

    static std::string GetArchiveDirectory()
    {
        if (mDirPath == "")
        {
            EXCEPTION("ArchiveLocationInfo::mDirPath has not been set");
        }
        return mDirPath;
    }

    static std::string GetProcessUniqueFilePath(const std::string& rFileName,
                                                unsigned procId=PetscTools::GetMyRank())
    {
        std::stringstream filepath;
        filepath << GetArchiveDirectory() << rFileName << "." << procId;
        return filepath.str();
    }

    static void SetArchiveDirectory(const std::string& rDirectory, bool relativeToChasteTestOutput=true)
    {
        mDirPath = rDirectory;
        if (! ( *(mDirPath.end()-1) == '/'))
        {
            mDirPath = mDirPath + "/";
        }

        mDirIsRelativeToChasteTestOutput = relativeToChasteTestOutput;
    }

    static std::string GetArchiveRelativePath()
    {
        if (mDirIsRelativeToChasteTestOutput)
        {
            std::string chaste_output=OutputFileHandler::GetChasteTestOutputDirectory();
            //Find occurrence of CHASTE_TEST_OUTPUT in string
            std::string::size_type pos=mDirPath.find(chaste_output, 0);
            if (pos == std::string::npos)
            {
                EXCEPTION("Full path doesn't give a directory relative to CHASTE_TEST_OUTPUT");
            }
            assert(pos == 0); //Expect this as a prefix, not in the middle of the string

            return mDirPath.substr(chaste_output.length());
        }
        else
        {
            return mDirPath;
        }
    }

    static bool GetIsDirRelativeToChasteTestOutput()
    {
        return mDirIsRelativeToChasteTestOutput;
    }
};

#endif /*ARCHIVELOCATIONINFO_HPP_*/