In This Package:

System::PathResolver Class Reference

#include <PathResolver.h>


Public Types
	Ok
	EnvironmentVariableUndefined
	UnknownDirectory
	LocalSearch
	RecursiveSearch
enum	SearchPathStatus { Ok, EnvironmentVariableUndefined, UnknownDirectory }
enum	SearchType { LocalSearch, RecursiveSearch }
Static Public Member Functions
static std::string	find_file (const std::string &logical_file_name, const std::string &search_path, SearchType search_type=LocalSearch)
static std::string	find_file_from_list (const std::string &logical_file_name, const std::string &search_list, SearchType search_type=LocalSearch)
static std::string	find_directory (const std::string &logical_file_name, const std::string &search_path, SearchType search_type=LocalSearch)
static std::string	find_directory_from_list (const std::string &logical_file_name, const std::string &search_list, SearchType search_type=LocalSearch)
static SearchPathStatus	check_search_path (const std::string &search_path)

Definition at line 8 of file PathResolver.h.

Enumerator:

Ok
EnvironmentVariableUndefined
UnknownDirectory

Definition at line 11 of file PathResolver.h.

00012     {
00013       Ok,
00014       EnvironmentVariableUndefined,
00015       UnknownDirectory
00016     } SearchPathStatus;

Enumerator:

LocalSearch
RecursiveSearch

Definition at line 18 of file PathResolver.h.

00019     {
00020       LocalSearch,
00021       RecursiveSearch
00022     } SearchType;

static std::string System::PathResolver::find_file	(	const std::string &	logical_file_name,
		const std::string &	search_path,
		SearchType	search_type = `LocalSearch`
	)			`[static]`

logical_file_name the name of the file to locate in the search path
search_path the name of a path-like environment variable
search_type characterizes the type of search. Can be either LocalSearch or RecursiveSearch

Returns:: the physical name of the located file or empty string if not found

static std::string System::PathResolver::find_file_from_list	(	const std::string &	logical_file_name,
		const std::string &	search_list,
		SearchType	search_type = `LocalSearch`
	)			`[static]`

logical_file_name the name of the file to locate in the search path
search_list the prioritized list of possible locations separated by the usual path separator
search_type characterizes the type of search. Can be either LocalSearch or RecursiveSearch

Returns:: the physical name of the located file or empty string if not found

static std::string System::PathResolver::find_directory	(	const std::string &	logical_file_name,
		const std::string &	search_path,
		SearchType	search_type = `LocalSearch`
	)			`[static]`

logical_file_name the name of the directory to locate in the search path
search_path the name of a path-like environment variable
search_type characterizes the type of search. Can be either LocalSearch or RecursiveSearch

Returns:: the physical name of the located directory or empty string if not found

static std::string System::PathResolver::find_directory_from_list	(	const std::string &	logical_file_name,
		const std::string &	search_list,
		SearchType	search_type = `LocalSearch`
	)			`[static]`

logical_file_name the name of the directory to locate in the search path
search_list the prioritized list of possible locations separated by the usual path separator
search_type characterizes the type of search. Can be either LocalSearch or RecursiveSearch

Returns:: the physical name of the located directory or empty string if not found

static SearchPathStatus System::PathResolver::check_search_path ( const std::string & search_path ) [static]

Returns:: the result of the verification. Can be one of Ok, EnvironmentVariableUndefined, UnknownDirectory

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/gaudi/GaudiKernel/GaudiKernel/PathResolver.h

Generated on Mon Apr 11 19:57:21 2011 for GaudiKernel by 1.4.7