#include <iaPath.h>

Public Member Functions
	iaPath (const iaString &path)

	iaPath ()

iaPath	operator= (const iaString &path)

bool	operator== (const iaString &other)

bool	operator!= (const iaString &other)

const iaString	getAbsolutePath () const

const iaString	getName () const

const iaString	getParentPath () const

const iaString	getStem () const

const iaString	getExtension () const

std::vector< iaPath >	getDirectories (bool recursive=false, bool orderAlphabetically=true) const

std::vector< iaFile >	getFiles (const iaString &searchPattern=L"*", bool recursive=false, bool orderAlphabetically=true) const

bool	isDirectory () const

bool	isFile () const

bool	isSymlink () const

bool	exists () const

bool	isRoot ()

iaTime	getLastModifiedTime () const

Static Public Member Functions
static const iaString	getName (const iaString &path)

static const iaString	getParentPath (const iaString &path)

static const iaString	getStem (const iaString &path)

static const iaString	getExtension (const iaString &path)

static iaString	getRelativePath (const iaString &from, const iaString &to)

static void	setCurrentDirectory (const iaString &path)

static iaString	getCurrentDirectory ()

static bool	directoryIsAbsolute (const iaString &path)

static bool	isDirectory (const iaString &path)

static bool	isFile (const iaString &path)

static bool	isSymlink (const iaString &path)

static void	remove (const iaString &path)

static void	copy (const iaString &src, const iaString &dst)

static void	rename (const iaString &src, const iaString &dst, bool replaceExisting=false)

static void	makeDirectory (const iaString &path)

static bool	exists (const iaString &path)

static bool	isEmpty (const iaString &path)

static iaString	fixPath (const iaString &path)

static iaString	generateUniqueFilename (const iaString &filename)

static iaTime	getLastModifiedTime (const iaString &path)

Detailed Description

handles directories and containing files

Constructor & Destructor Documentation

◆ iaPath() [1/2]

iaux::iaPath::iaPath ( const iaString & path )

creates an object for some directory

Parameters

path	path of directory

◆ iaPath() [2/2]

iaux::iaPath::iaPath ( )

empty directory ctor

Member Function Documentation

◆ copy()

void iaux::iaPath::copy	(	const iaString &	src,
		const iaString &	dst
	)

static

copys the file to a new destination

Parameters

newFileName name of copy destination

◆ directoryIsAbsolute()

bool iaux::iaPath::directoryIsAbsolute ( const iaString & path )

static

Returns: true: if a path is absolute; false: if path is relative

Parameters

path	the given path

◆ exists() [1/2]

bool iaux::iaPath::exists ( ) const

Returns: true if given directory exists

◆ exists() [2/2]

bool iaux::iaPath::exists ( const iaString & path )

static

Returns: true if given directory exists

relative to current or absolute

Parameters

path	the given path

◆ fixPath()

iaString iaux::iaPath::fixPath ( const iaString & path )

static

fixes the path from something like "../bla\blubber/temp.txt" to an absolute c:\bla\blubber\temp.txt

Parameters

path	path to fix

Returns: fixed path

◆ generateUniqueFilename()

iaString iaux::iaPath::generateUniqueFilename ( const iaString & filename )

static

Returns: valid unique filename for given filename

Parameters

filename the given filename

◆ getAbsolutePath()

const iaString iaux::iaPath::getAbsolutePath ( ) const

Returns: get the absolute path (if possible)

To generate an absolute path it check if it exists relative to the current directory

◆ getCurrentDirectory()

iaString iaux::iaPath::getCurrentDirectory ( )

static

Returns: the current or working directory

◆ getDirectories()

std::vector< iaPath > iaux::iaPath::getDirectories	(	bool	recursive = `false`,
		bool	orderAlphabetically = `true`
	)		const

Returns: all sub directories

Parameters

recursive	true: search recursively; false: search only in current directory
orderAlphabetically	true: returns directories in alphabetical order

◆ getExtension() [1/2]

const iaString iaux::iaPath::getExtension ( ) const

Returns: the file extension

◆ getExtension() [2/2]

const iaString iaux::iaPath::getExtension ( const iaString & path )

static

Returns: the file extension from given path

Parameters

path	the given path

◆ getFiles()

std::vector< iaFile > iaux::iaPath::getFiles	(	const iaString &	searchPattern = `L"*"`,
		bool	recursive = `false`,
		bool	orderAlphabetically = `true`
	)		const

Returns: files of given directory

assuming path is an existing directory

Parameters

searchPattern	what to search for using regular expression
recursive	true: search recursively; false: search only in current directory
orderAlphabetically	true: returns files in alphabetical order

◆ getLastModifiedTime() [1/2]

iaTime iaux::iaPath::getLastModifiedTime ( ) const

Returns: last modified time of path

◆ getLastModifiedTime() [2/2]

iaTime iaux::iaPath::getLastModifiedTime ( const iaString & path )

static

Returns: last modified time of given path

Parameters

path	the given path

◆ getName() [1/2]

const iaString iaux::iaPath::getName ( ) const

Returns: the last name in path

examples: "c:\foo\bar" -> "bar" "/foo/bar.txt" -> "bar.txt"

◆ getName() [2/2]

const iaString iaux::iaPath::getName ( const iaString & path )

static

Returns: the last name from given path

examples: "c:\foo\bar" -> "bar" "/foo/bar.txt" -> "bar.txt"

Parameters

path	the given path

◆ getParentPath() [1/2]

const iaString iaux::iaPath::getParentPath ( ) const

Returns: the absolute path name of parent directory

e.g. if the path is c:\foo\bar then this returns c:\foo

◆ getParentPath() [2/2]

const iaString iaux::iaPath::getParentPath ( const iaString & path )

static

Returns: the absolute path name of parent directory from given path

e.g. if the path is c:\foo\bar then this returns c:\foo

Parameters

path	the given path

◆ getRelativePath()

iaString iaux::iaPath::getRelativePath	(	const iaString &	from,
		const iaString &	to
	)

static

Returns: relative path from path to path

Parameters

from	the path from where the relative path comes from (can also be a full file path)
to	the path the relative path will point to

◆ getStem() [1/2]

const iaString iaux::iaPath::getStem ( ) const

Returns: filename without extension

"" if this is not a file

◆ getStem() [2/2]

const iaString iaux::iaPath::getStem ( const iaString & path )

static

Returns: filename without extension from given path

"" if this is not a file

Parameters

path	the given path

◆ isDirectory() [1/2]

bool iaux::iaPath::isDirectory ( ) const

Returns: true: if a path is directory; false: if path is not a directory

◆ isDirectory() [2/2]

bool iaux::iaPath::isDirectory ( const iaString & path )

static

Returns: true: if a path is directory; false: if path is not a directory

Parameters

path	the given path

◆ isEmpty()

bool iaux::iaPath::isEmpty ( const iaString & path )

static

Returns: true if given directory is empty

Parameters

path	the given directory

◆ isFile() [1/2]

bool iaux::iaPath::isFile ( ) const

Returns: true: if a path is a file or a symbolic link

◆ isFile() [2/2]

bool iaux::iaPath::isFile ( const iaString & path )

static

Returns: true: if a path is a file or a symbolic link

Parameters

path	the given path

◆ isRoot()

bool iaux::iaPath::isRoot ( )

Returns: true: if root folder

eg c:, d: (windows) / (linux)

◆ isSymlink() [1/2]

bool iaux::iaPath::isSymlink ( ) const

Returns: true if given path is a symbolic link

◆ isSymlink() [2/2]

bool iaux::iaPath::isSymlink ( const iaString & path )

static

Returns: true if given path is a symbolic link

Parameters

path	the given path

◆ makeDirectory()

void iaux::iaPath::makeDirectory ( const iaString & path )

static

creates directory at given path

Parameters

path	given path

◆ operator!=()

bool iaux::iaPath::operator!= ( const iaString & other )

unequal operator

Parameters

other the other path to compare with

◆ operator=()

iaPath iaux::iaPath::operator= ( const iaString & path )

copy operator

Parameters

path	path of directory

◆ operator==()

bool iaux::iaPath::operator== ( const iaString & other )

equal operator

Parameters

other the other path to compare with

◆ remove()

void iaux::iaPath::remove ( const iaString & path )

static

deletes/removes path from filesystem

Parameters

path	the file or directory to remove

◆ rename()

void iaux::iaPath::rename	(	const iaString &	src,
		const iaString &	dst,
		bool	replaceExisting = `false`
	)

static

renames path to a new name

Parameters

src	the source path
dst	the destination path
replaceExisting	true: destination will be replaced; false: no action will be taken if destination already exists

◆ setCurrentDirectory()

void iaux::iaPath::setCurrentDirectory ( const iaString & path )

static

set's the current or working directory

Parameters

path	the directory path

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

/home/martin/dev/Igor/src/iaux/iaux/system/iaPath.h
/home/martin/dev/Igor/src/iaux/iaux/system/iaPath.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ iaPath() [1/2]

◆ iaPath() [2/2]

Member Function Documentation

◆ copy()

◆ directoryIsAbsolute()

◆ exists() [1/2]

◆ exists() [2/2]

◆ fixPath()

◆ generateUniqueFilename()

◆ getAbsolutePath()

◆ getCurrentDirectory()

◆ getDirectories()

◆ getExtension() [1/2]

◆ getExtension() [2/2]

◆ getFiles()

◆ getLastModifiedTime() [1/2]

◆ getLastModifiedTime() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getParentPath() [1/2]

◆ getParentPath() [2/2]

◆ getRelativePath()

◆ getStem() [1/2]

◆ getStem() [2/2]

◆ isDirectory() [1/2]

◆ isDirectory() [2/2]

◆ isEmpty()

◆ isFile() [1/2]

◆ isFile() [2/2]

◆ isRoot()

◆ isSymlink() [1/2]

◆ isSymlink() [2/2]

◆ makeDirectory()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ remove()

◆ rename()

◆ setCurrentDirectory()