ChasteBuildRoot.hpp File Reference

#include <string>
Include dependency graph for ChasteBuildRoot.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

const char * ChasteBuildRootDir ()
std::string ChasteComponentBuildDir (const std::string &rComponent)
std::string ChasteBuildDirName ()
std::string ChasteBuildType ()

Detailed Description

A collection of functions providing information about the filesystem layout of this Chaste source tree.

Definition in file ChasteBuildRoot.hpp.


Function Documentation

std::string ChasteBuildDirName (  ) 
Returns:
the name of the folder within the 'build' dir of a component that contains the compiled files.

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo().

const char* ChasteBuildRootDir (  ) 
Returns:
the path to the root directory of the Chaste source tree. Will always give you the absolute path with a trailing slash.

Referenced by PetscSetupUtils::CommonSetup(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), and FileFinder::SetPath().

std::string ChasteBuildType (  ) 
Returns:
the build type string used in building Chaste.

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo().

std::string ChasteComponentBuildDir ( const std::string &  rComponent  ) 
Returns:
the folder in which compiled files are placed for the given Chaste component. Will always give you the absolute path with a trailing slash.
Parameters:
rComponent e.g. global, heart, pde, ...

Generated by  doxygen 1.6.2