OutputFileHandler Class Reference

#include <OutputFileHandler.hpp>

Collaboration diagram for OutputFileHandler:

Public Member Functions
	OutputFileHandler (const std::string &rDirectory, bool cleanOutputDirectory=true)
std::string	GetOutputDirectoryFullPath ()
void	SetArchiveDirectory ()
out_stream	OpenOutputFile (const std::string &rFileName, std::ios_base::openmode mode=std::ios::out\|std::ios::trunc)
out_stream	OpenOutputFile (const std::string &rFileName, unsigned number, const std::string &rFileFormat, std::ios_base::openmode mode=std::ios::out\|std::ios::trunc)
Static Public Member Functions
static std::string	GetChasteTestOutputDirectory ()
Private Member Functions
std::string	MakeFoldersAndReturnFullPath (const std::string &rDirectory)
Static Private Member Functions
static void	AddTrailingSlash (std::string &rDirectory)
Private Attributes
std::string	mDirectory
	The directory to store output files in (always ends in "/").

Detailed Description

This file abstracts stuff that needs to be done when creating output files for tests. It defines some helpful functions, so that things that are otherwise repeated in lots of places are just done here.

Definition at line 47 of file OutputFileHandler.hpp.

Constructor & Destructor Documentation

OutputFileHandler::OutputFileHandler	(	const std::string &	rDirectory,
		bool	cleanOutputDirectory = `true`
	)

Create an OutputFileHandler that will create output files in the given directory. The directory name should be relative to the place where Chaste test output is stored. If the user needs to know where this is, use the GetChasteTestOutputDirectory method.

Will check that the directory exists and create it if needed.

Note:: This MUST be called collectively, since it contains a barrier call.

Parameters:

	rDirectory	the directory to put output files in.
	cleanOutputDirectory	whether to remove any existing files in the output directory

Definition at line 40 of file OutputFileHandler.cpp.

References PetscTools::AmMaster(), PetscTools::Barrier(), MakeFoldersAndReturnFullPath(), and mDirectory.

Member Function Documentation

void OutputFileHandler::AddTrailingSlash ( std::string & rDirectory ) [static, private]

Takes a reference to a string and adds a trailing slash if one is not already present

Parameters:

rDirectory

The directory name to add a trailing slash to.

Definition at line 164 of file OutputFileHandler.cpp.

Referenced by GetChasteTestOutputDirectory(), and MakeFoldersAndReturnFullPath().

std::string OutputFileHandler::GetChasteTestOutputDirectory ( ) [static]

Static method for getting the test output directory (the directory where chaste stores test output). This is set from the environment variable CHASTE_TESTOUTPUT, and defaults to "./testoutput" if it is not set.

Attempts to return an absolute path, but may get confused by odd setups. Eventually we'll move to using boost::filesystem, which would be more robust.

Static so an output file handler does not have to be created if the test output directory is wanted for, say, reading a file.

Definition at line 74 of file OutputFileHandler.cpp.

References AddTrailingSlash().

Referenced by OutputDirectoryFifoQueue::CreateNextDir(), ArchiveLocationInfo::GetArchiveRelativePath(), TissueSimulationArchiver< DIM, SIM >::Load(), MakeFoldersAndReturnFullPath(), and FileFinder::SetAbsolutePath().

std::string OutputFileHandler::GetOutputDirectoryFullPath ( )

Return the full pathname to the directory this object will create files in.

Definition at line 132 of file OutputFileHandler.cpp.

References mDirectory.

Referenced by ColumnDataReader::ColumnDataReader(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), Hdf5DataWriter::EndDefineMode(), AbstractMeshWriter< ELEMENT_DIM, SPACE_DIM >::GetOutputDirectory(), ColumnDataWriter::GetOutputDirectory(), Hdf5DataReader::Hdf5DataReader(), Hdf5DataWriter::Hdf5DataWriter(), HoneycombMeshGenerator::HoneycombMeshGenerator(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), TetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::PermuteNodesWithMetisBinaries(), QuadraticMesh< DIM >::QuadraticMesh(), MutableMesh< ELEMENT_DIM, SPACE_DIM >::ReMesh(), CardiacSimulationArchiver< PROBLEM_CLASS >::Save(), SetArchiveDirectory(), HeartConfig::Write(), and VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteVtkUsingMesh().

std::string OutputFileHandler::MakeFoldersAndReturnFullPath ( const std::string & rDirectory ) [private]

Check that the desired output directory exists and is writable by us. Create it if needed. Return the full pathname of the output directory.

The environment variable CHASTE_TEST_OUTPUT will be examined. If it is set and non-empty it is taken to be a directory where test output should be stored. Otherwise the current directory is used.

Note:: Contains a barrier, so must be called collectively.

Parameters:

rDirectory

pathname of the output directory, relative to where Chaste output will be stored (user shouldn't care about this).

Returns:: full pathname to the output directory

Todo:: Put the Chaste signature file in all folders we have created

Definition at line 104 of file OutputFileHandler.cpp.

References AddTrailingSlash(), PetscTools::AmMaster(), PetscTools::Barrier(), and GetChasteTestOutputDirectory().

Referenced by OutputFileHandler().

out_stream OutputFileHandler::OpenOutputFile	(	const std::string &	rFileName,
		unsigned	number,
		const std::string &	rFileFormat,
		std::ios_base::openmode	mode = `std::ios::out \| std::ios::trunc`
	)

This just calls the other OpenOutputFile after concatenating the first three arguments together to make the full filename. For example OpenOutputFile("results_", 3, ".dat") creates results_3.dat. See documentation for OpenOutputFile(std::string, std::ios_base::openmode).

Parameters:

	rFileName	the root name of the file to open
	number	the number to append to the root name of the file
	rFileFormat	the file format
	mode	optionally, flags to use when opening the file (defaults are as for std::ofstream).

Definition at line 149 of file OutputFileHandler.cpp.

References OpenOutputFile().

out_stream OutputFileHandler::OpenOutputFile	(	const std::string &	rFileName,
		std::ios_base::openmode	mode = `std::ios::out \| std::ios::trunc`
	)

Open an output file in our directory, and check it was opened successfully. Throws an Exception if not.

Parameters:

	rFileName	the name of the file to open, relative to the output directory.
	mode	optionally, flags to use when opening the file (defaults are as for std::ofstream).