mxberry::io::TmpDataManager Class Reference

TMPDATAMANAGER implements a basic functionality for managing temporary data folders. More...

Inheritance diagram for mxberry::io::TmpDataManager:

Collaboration diagram for mxberry::io::TmpDataManager:

Static Public Member Functions
static function	setRootDir (in dirName)
	SETROOTDIR sets up a root of temporary folders directory tree. More...
static function	getDirByCallerKey (in keyName, in nStepsUp)
	GETDIRBYCALLERKEY returns a unique temporary directory name based on caller name and optionally based on a specified key and makes sure that this directory is empty. More...
static function	getDirByKey (in keyName)
	GETDIRBYKEY returns a unique temporary directory name based on specified key and makes sure that this directory is empty. More...

Static Protected Member Functions
static function	getPropInternal (in propName, in isPresenceChecked)
	GETPROPINTERNAL gets corresponding property from storage. More...
static function	setPropInternal (in propName, in propVal)
	SETPROPINTERNAL sets value for corresponding property within storage. More...
static function	setDefaultRootDir ()
Static Protected Member Functions inherited from mxberry::core::obj::StaticPropStorage
static function	getPropInternal (in branchName, in propName, in isPresenceChecked)
static function	setPropInternal (in branchName, in propName, in propVal)
static function	flushInternal (in branchName)

Detailed Description

TMPDATAMANAGER implements a basic functionality for managing temporary data folders.

Definition at line 5 of file TmpDataManager.m.

Member Function Documentation

getDirByCallerKey()

static function mxberry::io::TmpDataManager::getDirByCallerKey ( in  keyName, in  nStepsUp  )

static

GETDIRBYCALLERKEY returns a unique temporary directory name based on caller name and optionally based on a specified key and makes sure that this directory is empty.

*  Input:
*    optional:
*        keyName: char[1,] key name
*        nStepsUp: numeric[1,1] - number of steps
*            up in the call stacks,  =1 by default
* 
*  Output:
*    resDir: char[1,] - resulting directory name
* 

Author

Peter Gagarinov, PhD pgaga.nosp@m.rino.nosp@m.v@gma.nosp@m.il.c.nosp@m.om

Copyright

2015-2016 Peter Gagarinov, PhD
2015 Moscow State University
Faculty of Computational Mathematics and Computer Science
System Analysis Department

getDirByKey()

static function mxberry::io::TmpDataManager::getDirByKey ( in  keyName )

static

GETDIRBYKEY returns a unique temporary directory name based on specified key and makes sure that this directory is empty.

*  Input:
*    regular:
*        keyName: char[1,] key name
* 
*  Output:
*    resDir: char[1,] - resulting directory name
* 

getPropInternal()

static function mxberry::io::TmpDataManager::getPropInternal ( in  propName, in  isPresenceChecked  )

staticprotected

GETPROPINTERNAL gets corresponding property from storage.

*  Usage: [propVal,isThere]=. . .
*             getPropInternal(propName,isPresenceChecked)
* 
*  input:
*    regular:
*      propName: char - property name
*      isPresenceChecked: logical [1,1] - if true, then presence
*          of given property is checked before its value is
*          retrieved from the storage, otherwise value is
*          retrieved without any check (that may lead to error
*          if property is not yet logged into the storage)
*  output:
*    regular:
*      propVal: empty or matrix of some type - value of given
*          property in the storage (if it is absent, empty is
*          returned)
*    optional:
*      isThere: logical [1,1] - if true, then property is in the
*          storage, otherwise false
* 

setDefaultRootDir()

static function mxberry::io::TmpDataManager::setDefaultRootDir ( )

staticprotected

setPropInternal()

static function mxberry::io::TmpDataManager::setPropInternal ( in  propName, in  propVal  )

staticprotected

SETPROPINTERNAL sets value for corresponding property within storage.

*  Usage: setPropInternal(propName,propVal)
* 
*  input:
*    regular:
*      propName: char - property name
*      propVal: matrix of some type - value of given property to
*          be set in the storage
* 

setRootDir()

static function mxberry::io::TmpDataManager::setRootDir ( in  dirName )

static

SETROOTDIR sets up a root of temporary folders directory tree.

*  Note: By default, is setRootDir is not called a directory
*    returned by built-in function 'tempdir' is used
* 

---

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

• +mxberry/+io/@TmpDataManager/TmpDataManager.m