FilePath Class Reference

Dedicated class for storing path to input and output files. More...

#include <file_path.hh>

Collaboration diagram for FilePath:

Public Types
enum	FileType { input_file, output_file }
	Possible types of file. More...

Public Member Functions
	TYPEDEF_ERR_INFO (EI_Path, string)
	DECLARE_EXCEPTION (ExcAbsOutputPath,<< "Can not set absolute path "<< EI_Path::qval<< "for an output file.")
	FilePath ()
	FilePath (const string file_path, const FileType ft)
	operator string () const

Static Public Member Functions
static void	set_io_dirs (const string working_dir, const string root_input, const string input, const string output)
static void	add_placeholder (string key, string value)
	Add new item to place holder. More...

Private Member Functions
void	substitute_value ()

Private Attributes
string	abs_file_path
	Final absolute path to the file. More...

Static Private Attributes
static std::map< string, string >	placeholder
	dictionary of placeholders More...
static string	output_dir =""
	Prefix path for output files. More...
static string	root_dir =""
	Prefix path for input files (directory of the main input file). More...

Detailed Description

Dedicated class for storing path to input and output files.

FilePath objects are constructed from given absolute or relative path to the file and its type (input or output). Before you create any instance of the class you have to call static method set_io_dirs to set:

• working directory of the program (when it was started)
• root input directory, i.e. directory of the main input file (given by -s parameter)
• input directory, used to replace ${INPUT} placeholder (given by -i parameter)
• output directory, where all output files should be placed (given by -o parameter)

Definition at line 34 of file file_path.hh.

Member Enumeration Documentation

enum FilePath::FileType

Possible types of file.

Enumerator
input_file
output_file

Definition at line 42 of file file_path.hh.

Constructor & Destructor Documentation

FilePath::FilePath ( )

inline

Default constructor, necessary when using Input::Record::opt_val() to initialize a FilePath.

Definition at line 50 of file file_path.hh.

FilePath::FilePath	(	const string	file_path,
		const FileType	ft
	)

Translates the given absolute or relative path to a file file_path depending on the file type ft.

For input files:

• For relative path prepend absolute path of the directory of the main input file (root directory).
• Replace ${INPUT} place holder with the input directory given at command line.

For output files:

• Forbids absolute output paths.
• For relative output path prepends it by the output directory given at the command line.

Definition at line 17 of file file_path.cc.

Member Function Documentation

void FilePath::add_placeholder ( string  key, string  value  )

static

Add new item to place holder.

Placeholder is extended by adding a single new item. The item can be used in the name of the input or output file name. Currently, the only supported placeholder is ${INPUT}.

Example usage:

FilePath::add_placeholder_item("${SUBST_VAL}", "path/value");

Parameters

[in]	key	Key of new item.
[in]	value	Value of new item.

Definition at line 53 of file file_path.cc.

Here is the caller graph for this function:

FilePath::DECLARE_EXCEPTION	(	ExcAbsOutputPath	,
		<< "Can not set absolute path "<< EI_Path::qval<< "for an output file."
	)

FilePath::operator string ( ) const

inline

This class is implicitly convertible to string.

Definition at line 77 of file file_path.hh.

void FilePath::set_io_dirs ( const string  working_dir, const string  root_input, const string  input, const string  output  )

static

Set:

• working directory (used only if the output directory is relative)
• root directory (of the main input file)
• input directory to replace ${INPUT} place holder
• output directory used as prefix to the output files (relative output dirs are relative to the working directory)

Definition at line 38 of file file_path.cc.

Here is the caller graph for this function:

void FilePath::substitute_value ( )

private

Substitutes placeholders in abs_file_path.

Definition at line 58 of file file_path.cc.

Here is the caller graph for this function:

FilePath::TYPEDEF_ERR_INFO	(	EI_Path	,
		string
	)

Member Data Documentation

string FilePath::abs_file_path

private

Final absolute path to the file.

Definition at line 105 of file file_path.hh.

string FilePath::output_dir =""

staticprivate

Prefix path for output files.

Definition at line 111 of file file_path.hh.

map< string, string > FilePath::placeholder

staticprivate

dictionary of placeholders

Definition at line 108 of file file_path.hh.

string FilePath::root_dir =""

staticprivate

Prefix path for input files (directory of the main input file).

Definition at line 114 of file file_path.hh.

---

The documentation for this class was generated from the following files:

• /home/jb/workspace/flow123d/src/system/file_path.hh
• /home/jb/workspace/flow123d/src/system/file_path.cc