Ocean::IO::ScopedDirectory Class Reference

This class implements a scoped directory object which will delete the underlying directory (and sub-directories including all files) from the filesystem when the scope ends. More...

#include <Directory.h>

Inheritance diagram for Ocean::IO::ScopedDirectory:

Public Member Functions
	ScopedDirectory ()=default
	Default constructor creating an invalid object not holding any directory.
	ScopedDirectory (ScopedDirectory &&scopedDirectory)
	Move constructor.
	ScopedDirectory (const Directory &directory)
	Create a new scoped directory.
	ScopedDirectory (const std::string &directory)
	Create a new scoped directory.
	~ScopedDirectory ()
	Destructs this object and deletes the actual directory.
ScopedDirectory &	operator= (ScopedDirectory &&scopedDirectory)
	Move operator.
Public Member Functions inherited from Ocean::IO::Directory
	Directory ()
	Creates an empty directory.
	Directory (const std::string &path)
	Creates a new directory.
	Directory (const File &file)
	Creates a new directory by a given file.
	Directory (const Path &path)
	Creates a new directory by a given path.
virtual bool	isValid () const
	Returns whether the directory is valid.
virtual bool	exists () const
	Returns whether the directory exists already.
bool	remove (const bool recursively=false) const
	Removes this directory from the filesystem.
bool	create () const
	Create all necessary sub-directories for the given path, if they do not exist.
std::string	base () const
	Returns the base of this directory.
std::string	name () const
	Returns the name of a directory.
Files	findFiles (const std::string &fileType=std::string("*"), const bool recursive=false) const
	Returns all files in the directory with the given file format.
Directories	findDirectories (const bool recursive=false) const
	Returns all directories of this directory.
File	operator+ (const File &file) const
	Returns a file composed of this directory and a relative file.
Directory	operator+ (const Directory &path) const
	Returns a directory composed of this and a relative directory.
Directory &	operator+= (const Directory &path)
	Adds an relative path to this directory.
Directory &	operator-- ()
	Removes the last sub-directory from this directory.
Directory	operator-- (int)
	Removes the last sub-directory from this directory.
Public Member Functions inherited from Ocean::IO::Path
virtual	~Path ()=default
	Destructs a path.
Type	type () const
	Returns the type of this path.
bool	isAbsolute () const
	Returns whether this path is absolute.
bool	isRelative () const
	Returns whether this path is relative.
bool	isNull () const
	Returns whether this path holds no valid.
bool	operator== (const Path &right) const
	Returns whether two paths are equal.
bool	operator!= (const Path &path) const
	Returns whether two paths are not equal.
const std::string &	operator() () const
	Returns the value of this path.
bool	operator< (const Path &path) const
	Less operator comparing the actual strings of two paths.

Protected Member Functions
	ScopedDirectory (const ScopedDirectory &scopedDirectory)=delete
	Disabled copy constructor.
ScopedDirectory &	operator= (const ScopedDirectory &scopedDirectory)=delete
	Disabled copy constructor.
Protected Member Functions inherited from Ocean::IO::Path
	Path ()=default
	Creates a new undefined path.
	Path (const Path &path)=default
	Copy constructor.
	Path (const std::string &value)
	Creates a new path.
void	checkPath (const Type expectType)
	Checks the type of this path and trims it.
void	trim ()
	Trims this path.
Path &	operator= (const Path &path)=default
	Default assign operator.

Additional Inherited Members
Public Types inherited from Ocean::IO::Path
enum	Type {   TYPE_INVALID = 0 , TYPE_FILE = 1 , TYPE_DIRECTORY = 2 , TYPE_ABSOLUTE = 4 ,   TYPE_RELATIVE = 8 , TYPE_NETWORK = 16 }
	Definition of different path types. More...
enum	Separator { SEPARATOR_UNDEFINED = 0 , SEPARATOR_SLASH = '/' , SEPARATOR_BACKSLASH = '\\' }
	Definition of path separators. More...
Static Public Member Functions inherited from Ocean::IO::Directory
static Directory	createTemporaryDirectory ()
	Creates a new temporary directory.
Static Public Member Functions inherited from Ocean::IO::Path
static bool	isSeparator (const char character)
	Returns whether a given character is a separator.
static char	defaultSeparator ()
	Returns the default separator of a path.
Static Protected Member Functions inherited from Ocean::IO::Directory
static Directory	createTemporaryDirectoryApple ()
	Creates a new temporary directory (specialization for Apple platforms).
static bool	existsApple (const std::string &directory)
	Returns whether a directory exists (specialization for Apple platforms).
Protected Attributes inherited from Ocean::IO::Path
Type	pathType_ = TYPE_INVALID
	Path type.
std::string	pathValue_
	Path value.

Detailed Description

This class implements a scoped directory object which will delete the underlying directory (and sub-directories including all files) from the filesystem when the scope ends.

See also

Directory

Constructor & Destructor Documentation

ScopedDirectory() [1/5]

Ocean::IO::ScopedDirectory::ScopedDirectory ( )

default

Default constructor creating an invalid object not holding any directory.

ScopedDirectory() [2/5]

Ocean::IO::ScopedDirectory::ScopedDirectory ( ScopedDirectory &&  scopedDirectory )

inline

Move constructor.

Parameters

scopedDirectory

The scoped directory to be moved

ScopedDirectory() [3/5]

Ocean::IO::ScopedDirectory::ScopedDirectory ( const Directory &  directory )

inlineexplicit

Create a new scoped directory.

Parameters

directory

The directory for which the new scoped object will be created

ScopedDirectory() [4/5]

Ocean::IO::ScopedDirectory::ScopedDirectory ( const std::string &  directory )

inlineexplicit

Create a new scoped directory.

Parameters

directory

The name of the directory for which a new scoped object will be created

~ScopedDirectory()

Ocean::IO::ScopedDirectory::~ScopedDirectory

(

)

Destructs this object and deletes the actual directory.

ScopedDirectory() [5/5]

Ocean::IO::ScopedDirectory::ScopedDirectory ( const ScopedDirectory &  scopedDirectory )

protecteddelete

Disabled copy constructor.

Parameters

scopedDirectory

Directory which would be copied

Member Function Documentation

operator=() [1/2]

ScopedDirectory & Ocean::IO::ScopedDirectory::operator= ( const ScopedDirectory &  scopedDirectory )

protecteddelete

Disabled copy constructor.

Parameters

scopedDirectory

Directory which would be copied

Returns

Reference to this object

operator=() [2/2]

ScopedDirectory & Ocean::IO::ScopedDirectory::operator=

(

ScopedDirectory &&

scopedDirectory

)

Move operator.

Parameters

scopedDirectory

The scoped directory to be moved

Returns

Reference to this object

---

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

• Directory.h