FileFinder Class Reference

#include <FileFinder.hpp>

Collaboration diagram for FileFinder:

Public Member Functions
	FileFinder ()
	FileFinder (const std::string &rPath, RelativeTo::Value relativeTo)
	FileFinder (const std::string &rLeafName, const FileFinder &rParentOrSibling)
void	SetPath (const std::string &rPath, RelativeTo::Value relativeTo)
void	SetPath (const std::string &rLeafName, const FileFinder &rParentOrSibling)
bool	Exists () const
bool	IsFile () const
bool	IsDir () const
std::string	GetAbsolutePath () const
bool	IsNewerThan (const FileFinder &rOtherEntity) const
std::string	GetLeafName () const
FileFinder	GetParent () const
Static Public Member Functions
static bool	IsAbsolutePath (const std::string &rPath)
static void	FakePath (RelativeTo::Value fakeWhat, const std::string &rFakePath)
static void	StopFaking ()
Private Attributes
std::string	mAbsPath
Static Private Attributes
static bool	msFaking = false
static RelativeTo::Value	msFakeWhat = RelativeTo::Absolute
static std::string	msFakePath = ""

Detailed Description

A helper class for finding files or directories, given paths which can be relative to various locations (e.g. the Chaste source tree root, the current directory, the Chaste test output directory, or an absolute path).

Definition at line 59 of file FileFinder.hpp.

Constructor & Destructor Documentation

FileFinder::FileFinder ( )

Default constructor for subclasses to use. They must call SetAbsolutePath() in their constructor.

This also allows classes to store a FileFinder instance that hasn't been properly set up yet, and assign to it later using operator=.

Definition at line 45 of file FileFinder.cpp.

Referenced by GetParent().

FileFinder::FileFinder	(	const std::string &	rPath,
		RelativeTo::Value	relativeTo
	)

Main constructor.

Parameters:

	rPath	the path to the file/dir to find
	relativeTo	how to interpret this path

Definition at line 50 of file FileFinder.cpp.

References SetPath().

FileFinder::FileFinder	(	const std::string &	rLeafName,
		const FileFinder &	rParentOrSibling
	)

Find a file (or folder) relative to some file or directory. If the second argument is a directory, we look for the given leaf name within it. If the second argument is a file, then we look for a sibling. An exception is raised if rParentOrSibling does not exist.

Parameters:

	rLeafName	the leaf name of the file/dir to find
	rParentOrSibling	where to look for it

Definition at line 55 of file FileFinder.cpp.

References SetPath().

Member Function Documentation

bool FileFinder::Exists ( ) const

Test whether we exist.

Definition at line 128 of file FileFinder.cpp.

References GetAbsolutePath().

Referenced by ColumnDataReader::ColumnDataReader(), Hdf5DataReader::CommonConstructor(), CellMLToSharedLibraryConverter::Convert(), HeartConfig::CopySchema(), BidomainTissue< SPACE_DIM >::CreateExtracellularConductivityTensors(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::CreateIntracellularConductivityTensor(), IsNewerThan(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), AbstractCardiacTissue< SPACE_DIM >::save(), and SetPath().

void FileFinder::FakePath	(	RelativeTo::Value	fakeWhat,
		const std::string &	rFakePath
	)			`[static]`

For testing purposes, fake the value of one of the normally fixed paths, e.g. ChasteSourceRoot.

Parameters:

	fakeWhat	which path to fake
	rFakePath	its fake value

Definition at line 206 of file FileFinder.cpp.

References msFakePath, msFakeWhat, and msFaking.

std::string FileFinder::GetAbsolutePath ( ) const

Get the absolute path to this file/dir.

If this is a directory that exists, the absolute path is guaranteed to end in a '/'. If the directory doesn't exist, it will depend on what was supplied to the constructor.

Definition at line 169 of file FileFinder.cpp.

References mAbsPath.

Referenced by ColumnDataReader::ColumnDataReader(), Hdf5DataReader::CommonConstructor(), CellMLToSharedLibraryConverter::Convert(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), OutputFileHandler::CopyFileTo(), HeartConfig::CopySchema(), Exists(), FibreReader< DIM >::FibreReader(), GetLeafName(), DynamicModelLoaderRegistry::GetLoader(), GetParent(), IsDir(), IsFile(), IsNewerThan(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), AbstractCardiacTissue< SPACE_DIM >::save(), ArchiveLocationInfo::SetArchiveDirectory(), SetPath(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteNclFile().