TempDir Class Reference

A uniquely named temporary directory, removed when the object is destroyed. More...

#include <OpenMS/SYSTEM/TempFiles.h>

Public Member Functions
	TempDir (bool keep_dir=false)
	TempDir (const std::string &base_dir, bool keep_dir=false)
	~TempDir ()
	Destroy temporary folder (can be prohibited in Constructor)
	TempDir (const TempDir &)=delete
	delete all means to copy or move a TempDir
TempDir &	operator= (const TempDir &)=delete
	TempDir (TempDir &&)=delete
TempDir &	operator= (TempDir &&)=delete
const std::string &	getPath () const
	Return path to temporary folder.

Private Attributes
std::string	temp_dir_
bool	keep_dir_

Detailed Description

A uniquely named temporary directory, removed when the object is destroyed.

The directory is created below SystemSettings::getTempDirectory() unless an explicit base directory is given. Destruction removes it recursively unless keep_dir was set.

Constructor & Destructor Documentation

TempDir() [1/4]

TempDir

(

bool

keep_dir = false

)

Construct temporary folder under system temp directory If keep_dir is set to true, the folder will not be deleted on destruction of the object.

TempDir() [2/4]

TempDir	(	const std::string &	base_dir,
		bool	keep_dir = false
	)

Construct temporary folder under a custom base directory Creates a unique subdirectory with a generated name under base_dir. If keep_dir is set to true, the folder will not be deleted on destruction of the object.

Parameters

base_dir	The base directory under which to create the temp folder (e.g., user-specified temp path)
keep_dir	If true, the folder will not be deleted on destruction

~TempDir()

~TempDir

(

)

Destroy temporary folder (can be prohibited in Constructor)

TempDir() [3/4]

TempDir ( const TempDir &  )

delete

delete all means to copy or move a TempDir

TempDir() [4/4]

TempDir ( TempDir &&  )

delete

Member Function Documentation

getPath()

const std::string & getPath

(

)

const

Return path to temporary folder.

operator=() [1/2]

TempDir & operator= ( const TempDir &  )

delete

operator=() [2/2]

TempDir & operator= ( TempDir &&  )

delete

Member Data Documentation

keep_dir_

bool keep_dir_

private

temp_dir_

std::string temp_dir_

private