#include <ITreeROOT.h>

Inheritance diagram for AIDA::ITreeROOT:

Public Member Functions
virtual	~ITreeROOT ()
	Destructor.

	ITreeROOT (const std::string &storeName, const std::string &storeType="", bool readOnly=false, bool createNew=false, const std::string &options="")
	Creates a new tree and associates it with a store. More...

virtual std::string	storeName () const
	Get the name of the store. More...

virtual bool	cd (const std::string &path)
	Get the IManagedObject at a given path in the ITree. More...

virtual std::string	pwd () const
	Get the path of the current working directory. More...

virtual bool	ls (const std::string &path=".", bool recursive=false, std::ostream &os=std::cout) const
	List, into a given output stream, all the IManagedObjects, including directories (but not "." and ".."), in a given path. More...

virtual bool	mkdir (const std::string &path)
	Get the list of names of the IManagedObjects under a given path, including directories (but not "." and ".."). More...

virtual bool	commit ()
	Create a directory recursively. More...

virtual bool	close ()
	Set the strategy of what should happen if two objects have the same path. More...

Public Member Functions inherited from AIDA::ITree
virtual	~ITree ()
	Destructor.

Detailed Description

class IManagedObject;

User level interface to a Tree.

All paths follow unix convention .., ., /, backslash is the escape character. Relative paths are allowed.

NOTE: - this tree keeps a current position(pwd) within the tree. This may be implemented on a per-thread basis.

Author: T. Kraemer, DESY

Version

Id:: ITreeROOT.h,v 1.5 2008-01-30 17:42:20 killenberg Exp

Constructor & Destructor Documentation

ITreeROOT::ITreeROOT	(	const std::string &	storeName,
		const std::string &	storeType = `""`,
		bool	readOnly = `false`,
		bool	createNew = `false`,
		const std::string &	options = `""`
	)

Creates a new tree and associates it with a store.

The store is assumed to be read/write. The store will be created if it does not exist.

Parameters

storeName	The name of the store, if empty (""), the tree is created in memory and therefore will not be associated with a file.
storeType	Implementation specific string, may control store type
readOnly	If true the store is opened readonly, an exception if it does not exist
createNew	If false the file must exist, if true the file will be created
options	Other options, currently are not specified

References storeName().

Member Function Documentation

bool ITreeROOT::cd ( const std::string & path )

virtual

Get the IManagedObject at a given path in the ITree.

The path can either be absolute or relative to the current working directory.

Parameters

path The path.

Returns: The corresponding IManagedObject.virtual IManagedObject * find(const std::string & path); Get a mounted ITree at a given path in the current ITree. The path can either be absolute or relative to the current working directory.

Parameters

path The path.

Returns: The corresponding ITree.virtual ITree * findTree(const std::string & path); Change to a given directory.

Parameters

path	The absolute or relative path of the directory we are changing to.

Returns: false If the path does not exist.

Implements AIDA::ITree.

References storeName().

Referenced by ls(), and mkdir().

bool ITreeROOT::close ( )

virtual

Set the strategy of what should happen if two objects have the same path.

Default is overwrite.

Parameters

overwrite	`true` to enable overwriting.virtual void setOverwrite(bool overwrite = true); Copy an object from a path to another.
oldPath	The path of the object to be copied.
newPath	The path where the object is to be copied.
recursive	`true` if a recursive copy has to be performed.

Returns: false If either path does not exist.virtual bool cp(const std::string & oldPath, const std::string & newPath, bool recursive = false); Create a symbolic link to an object in the ITree.

Parameters

path	The absolute or relative path of the object to be linked.
alias	The absolute or relative name of the link.

Returns

false If path or any subidrectory within path does not exist.virtual bool symlink(const std::string & path, const std::string & alias); Mounts a tree within another (target) tree. A tree can only be mounted once. Example:

    target.mount("/home/tonyj",tree,"/");

Parameters

path	The path in the target tree
tree	The tree to mount within the target tree
treePath	The mount point within the tree to be mounted.

Returns: false If something does not exist.virtual bool mount(const std::string & path, ITree & tree, const std::string & treePath) ; Unmount a subtree at a given path (mount point). Whenever a tree is destroyed it first unmounts all dependent trees.

Parameters

path	The path of the subtree to be unmounted.

Returns: false If path does not exist.virtual bool unmount(const std::string & path); Closes the underlying store. Changes will be saved only if commit() has been called before. The call is propagated to the dependent mounted trees.; false If there are problems writing out the underlying store.

Implements AIDA::ITree.

bool ITreeROOT::commit ( )

virtual

Create a directory recursively.

Given a path the last directory and all the intermediate non-existing subdirectories are created.

Parameters

path	The absolute or relative path of the new directory.

Returns: false If an intermediate subdirectory is not a directory, or if the directory already exists.virtual bool mkdirs(const std::string & path); Remove a directory and all the contents underneeth.

Parameters

path	The absolute or relative path of the directory to be removed.

Returns: false If path does not exist or if it is not a directory.virtual bool rmdir(const std::string & path); Remove an IManagedObject by specifying its path. If the path points to a mount point, the mount point should first commit, then close and delete the tree object.

Parameters

path	The absolute or relative path of the IManagedObject to be removed.

Returns: false If path does not exist.virtual bool rm(const std::string & path); Get the full path of an IManagedObject.

Parameters

object The IManagedObject whose path is to be returned.

Returns: The object's absolute path. In C++ if the object does not exist, an empty string is returned.virtual std::string findPath(const IManagedObject & object) const; Move an IManagedObject or a directory from one directory to another.

Parameters

oldPath	The path of the IManagedObject or direcoty to be moved.
newPath	The path of the diretory in which the object has to be moved to.

Returns: false If either path does not exist.virtual bool mv(const std::string & oldPath, const std::string & newPath); Commit any open transaction to the underlying store(s). It flushes objects into the disk for non-memory-mapped stores.; false If the underlying store cannot be written out.

Implements AIDA::ITree.

bool ITreeROOT::ls	(	const std::string &	path = `"."`,
		bool	recursive = `false`,
		std::ostream &	os = `std::cout`
	)		const

virtual

List, into a given output stream, all the IManagedObjects, including directories (but not "." and ".."), in a given path.

Directories end with "/". The list can be recursive.

Parameters

path	The path where the list has to be performed (by default the current directory ".").
recursive	If `true` the list is extended recursively in all the directories under path (the default is `false`.
os	The output stream into which the list is dumped (by default the standard output).

Returns: false If the path does not exist.

Implements AIDA::ITree.

References cd(), and pwd().

bool ITreeROOT::mkdir ( const std::string & path )

virtual

Get the list of names of the IManagedObjects under a given path, including directories (but not "." and "..").

Directories end with "/". The returned names are appended to the given path unless the latter is ".".

Parameters

path	The path where the list has to be performed (by default the current directory ".").
recursive	If `true` the list is extended recursively in all the directories under path (the default is `false`.virtual std::vector<std::string> listObjectNames(const std::string & path = ".", bool recursive = false) const; Get the list of types of the IManagedObjects under a given path. The types are the leaf class of the Interface, e.g. "IHistogram1D", "ITuple", etc. Directories are marked with "dir". The order of the types is the same as the order for the listObjectNames() method to achieve a one-to-one correspondance between object names and types.
path	The path where the list has to be performed (by default the current directory ".").
recursive	If `true` the list is extended recursively in all the directories under path (the default is `false`.virtual std::vector<std::string> listObjectTypes(const std::string & path = ".", bool recursive = false) const; Create a new directory. Given a path only the last directory in it is created if all the intermediate subdirectories already exist.
path	The absolute or relative path of the new directory.

Returns: false If a subdirectory within the path does not exist or it is not a directory. Also if the directory already exists.

Implements AIDA::ITree.

References cd(), and pwd().

std::string ITreeROOT::pwd ( ) const

virtual

Get the path of the current working directory.

Returns: The path of the current working directory.

Implements AIDA::ITree.

Referenced by ls(), and mkdir().

std::string ITreeROOT::storeName ( ) const

virtual

Get the name of the store.

Returns: The store's name.

Implements AIDA::ITree.

Referenced by cd(), and ITreeROOT().

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

ITreeROOT.h
ITreeROOT.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation