public

Inheritance Graph

graph BT
	TemporaryDirectory
	TemporaryDirectory --> ReferenceCounter
	click TemporaryDirectory "classUtil_1_1TemporaryDirectory"
	click ReferenceCounter "classUtil_1_1ReferenceCounter"

Description

Creation and deletion of temporary directories.

When creating an object of this class, a new directory is created, which can be used to store temporary files. When the object is destroyed, the directory will be deleted together with all files inside.

Author: Benjamin Eikel

Date: 2011-08-15

Public Functions

   
   
  TemporaryDirectory(const std::string & fragment)
   
  ~TemporaryDirectory()
Delete the directory and all its contents.
   
const FileName & getPath() const

Documentation

function
Util::TemporaryDirectory::TemporaryDirectory

public
     
     
TemporaryDirectory( const std::string & fragment )

Create a new temporary directory. The part will contain the current process identifier, an automatically increasing counter and the given fragment.

Parameters

fragment
String that will be used as part of the path. This must not contain characters that are invalid in file names.

Defined in Util/IO/TemporaryDirectory.h:49


function
Util::TemporaryDirectory::~TemporaryDirectory

public
   
   
~TemporaryDirectory( )

Delete the directory and all its contents.

Defined in Util/IO/TemporaryDirectory.h:52


function
Util::TemporaryDirectory::getPath

public const inline
   
   
const FileName & getPath( ) const

Retrieve the path to the directory.

Returns

Directory location that can be used for temporary files.

Defined in Util/IO/TemporaryDirectory.h:59