C++ class Util::IO::FileLocator
FileLocator

public

Inheritance Graph

graph BT
	FileLocator
	click FileLocator "classUtil_1_1FileLocator"

Description

A FileLocator locates a file that is placed relative to a search path. It can be applied to locate resources using only relative paths.

Public Functions

	FileLocator()
	FileLocator(const FileLocator & void)
	FileLocator( FileLocator && void)
	~FileLocator()
FileLocator &	operator=(const FileLocator & void)
FileLocator &	operator=( FileLocator && void)
void	addSearchPath(std::string s)
const std::vector< std::string > &	getSearchPaths() const
void	setSearchPaths(std::vector< std::string > p)
std::pair< bool, FileName >	locateFile(const FileName & relFile) const

---

Documentation

function
Util::FileLocator::FileLocator

public

FileLocator(	)

_{Defined in Util/IO/FileLocator.h:27}

---

function
Util::FileLocator::FileLocator

public

FileLocator(	const FileLocator &	void )

_{Defined in Util/IO/FileLocator.h:28}

---

function
Util::FileLocator::FileLocator

public

FileLocator(	FileLocator &&	void )

_{Defined in Util/IO/FileLocator.h:29}

---

function
Util::FileLocator::~FileLocator

public

~FileLocator(	)

_{Defined in Util/IO/FileLocator.h:30}

---

function
Util::FileLocator::operator=

public

FileLocator & operator=(	const FileLocator &	void )

_{Defined in Util/IO/FileLocator.h:32}

---

function
Util::FileLocator::operator=

public

FileLocator & operator=(	FileLocator &&	void )

_{Defined in Util/IO/FileLocator.h:33}

---

function
Util::FileLocator::addSearchPath

public

inline

void addSearchPath(	std::string	s )

_{Defined in Util/IO/FileLocator.h:35}

---

function
Util::FileLocator::getSearchPaths

public

const

inline

const std::vector< std::string > & getSearchPaths(	) const

_{Defined in Util/IO/FileLocator.h:36}

---

function
Util::FileLocator::setSearchPaths

public

inline

void setSearchPaths(	std::vector< std::string >	p )

_{Defined in Util/IO/FileLocator.h:37}

---

function
Util::FileLocator::locateFile

public

const

std::pair< bool, FileName > locateFile(	const FileName &	relFile ) const

If the file can be found in one of the the searchPaths, <true, searchPath/relFile> is returned; Otherwise, <false,relFile> is returned.

_{Defined in Util/IO/FileLocator.h:41}

---