TwiceAsNice  2019-02-18
Public Member Functions | Private Attributes | List of all members
Nice::FileByPath Class Reference

#include <FileByPath.h>

Collaboration diagram for Nice::FileByPath:
Collaboration graph

Public Member Functions

 FileByPath ()
 
 FileByPath (const std::string &_searchPath)
 
void setSearchPath (const std::string &_searchPath)
 set up the directory search tree. More...
 
void setSearchPath (const Nice::SeqString _searchPath)
 
std::string find (const std::string &_f, bool _create=false)
 construct a file name More...
 
const Nice::SeqStringsearchPath ()
 
 FileByPath ()
 
 FileByPath (const std::string &_searchPath)
 
void setSearchPath (const std::string &_searchPath)
 
void setSearchPath (const Nice::SeqString _searchPath)
 
std::string find (const std::string &_f, bool _create=false)
 
const Nice::SeqStringsearchPath ()
 

Private Attributes

Nice::SeqString m_searchPath
 

Constructor & Destructor Documentation

◆ FileByPath() [1/4]

Nice::FileByPath::FileByPath ( )
inline

◆ FileByPath() [2/4]

Nice::FileByPath::FileByPath ( const std::string &  _searchPath)
inline

◆ FileByPath() [3/4]

Nice::FileByPath::FileByPath ( )
inline

◆ FileByPath() [4/4]

Nice::FileByPath::FileByPath ( const std::string &  _searchPath)
inline

Member Function Documentation

◆ find() [1/2]

std::string Nice::FileByPath::find ( const std::string &  _f,
bool  _create = false 
)

construct a file name


Parameters
_fthe trailing part of the full file's path name. This may contain shell-style dollar expressions equivalent to shell environment variables.
_create
Returns
The first regular file in the search path that ends with _f.

◆ find() [2/2]

std::string Nice::FileByPath::find ( const std::string &  _f,
bool  _create = false 
)

◆ searchPath() [1/2]

const Nice::SeqString& Nice::FileByPath::searchPath ( )
inline

◆ searchPath() [2/2]

const Nice::SeqString& Nice::FileByPath::searchPath ( )
inline

◆ setSearchPath() [1/4]

void Nice::FileByPath::setSearchPath ( const std::string &  _searchPath)

◆ setSearchPath() [2/4]

void Nice::FileByPath::setSearchPath ( const std::string &  _searchPath)

set up the directory search tree.


Parameters
_searchPathA colon-separated list of directories. This may contain shell-type dollars like environment variables. Note that this will not be interpreted recursively by find().

◆ setSearchPath() [3/4]

void Nice::FileByPath::setSearchPath ( const Nice::SeqString  _searchPath)
inline

◆ setSearchPath() [4/4]

void Nice::FileByPath::setSearchPath ( const Nice::SeqString  _searchPath)
inline

Member Data Documentation

◆ m_searchPath

Nice::SeqString Nice::FileByPath::m_searchPath
private

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