Detailed Description

Abstract base class for interfaces to Data Management Systems (SRB, IRODS, etc.)

Created by KVClassFactory on Thu Oct 18 10:38:52 2012 Author: John Frankland

Definition at line 73 of file KVDMS.h.

#include <KVDMS.h>

Inheritance diagram for KVDMS:

[legend]

Public Member Functions
	KVDMS (const Char_t name="DMS", const Char_t title="Data Management System")
	Default ctor with name and title. More...

virtual Int_t	cd (const Char_t *directory="")=0

virtual Int_t	chmod (const Char_t *path, UInt_t mode)=0

Bool_t	DirectoryContains (const Char_t name, const Char_t directory="")

virtual Int_t	exit ()=0

virtual Int_t	forcedelete (const Char_t *path)=0

virtual Int_t	get (const Char_t source, const Char_t target=".")=0

KVUniqueNameList	GetFullListing (const Char_t *directory="")

KVUniqueNameList	GetListing (const Char_t *directory="")

Bool_t	GetPathInfo (const Char_t *path, DMSFile_t &fs)

virtual TString	info (const Char_t file, Option_t opt="")=0

virtual Int_t	init ()=0

Bool_t	IsContainer (TString &) const

virtual TString	list (const Char_t *directory="")=0

virtual TString	longlist (const Char_t *directory="")=0

virtual Int_t	mkdir (const Char_t path, Option_t opt="")=0

virtual Int_t	put (const Char_t source, const Char_t target=".")=0

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

void	Clear (Option_t *opt="") override
	Clear object properties : name, type/title, number, label. More...

void	Copy (TObject &) const override
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

Bool_t	IsCalled (const Char_t *name, bool case_insensitive=false) const

Bool_t	IsLabelled (const Char_t *l, bool case_insensitive=false) const

Bool_t	IsType (const Char_t *typ, bool case_insensitive=false) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

void	Print (Option_t *option="") const override

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

enum class	GetX_status { ok , above_maximum , below_minimum , at_maximum , at_minimum }

Static Public Member Functions inherited from KVBase
static std::optional< TString >	AbsoluteUnixPath (const TString &)

static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const KVString &class_name, KVString &imp_file, KVString &dec_file, const KVString &dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

template<typename ValType >
static ValType	GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &defval={})

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static int	GetKVMajorVersion ()

static int	GetKVMinorVersion ()

static int	GetKVPatchVersion ()

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsEnvInit ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Double_t	ProtectedGetX (const TF1 &func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Double_t	ProtectedGetX (const TF1 *func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Constructor & Destructor Documentation

◆ KVDMS()

KVDMS::KVDMS	(	const Char_t *	name = `"DMS"`,
		const Char_t *	title = `"Data Management System"`
	)

Default ctor with name and title.

Definition at line 22 of file KVDMS.cpp.

Member Function Documentation

◆ cd()

virtual Int_t KVDMS::cd ( const Char_t * directory = "" )

pure virtual

Implemented in SRB, and IRODS.

◆ chmod()

virtual Int_t KVDMS::chmod	(	const Char_t *	path,
		UInt_t	mode
	)

pure virtual

Implemented in IRODS, and SRB.

◆ DirectoryContains()

Bool_t KVDMS::DirectoryContains	(	const Char_t *	name,
		const Char_t *	directory = `""`
	)

Returns true if the current directory (default) or the given directory contains a file or a container with given name.

Definition at line 227 of file KVDMS.cpp.

◆ exit()

virtual Int_t KVDMS::exit ( )

pure virtual

Implemented in SRB, and IRODS.

◆ forcedelete()

virtual Int_t KVDMS::forcedelete ( const Char_t * path )

pure virtual

Implemented in SRB, and IRODS.

◆ get()

virtual Int_t KVDMS::get	(	const Char_t *	source,
		const Char_t *	target = `"."`
	)

pure virtual

Implemented in SRB, and IRODS.

◆ GetFullListing()

KVUniqueNameList KVDMS::GetFullListing ( const Char_t * directory = "" )

Returns: list with info (name, size, modification date) on all files & containers in current directory (default) or in given directory.

List is filled with DMSFile_t objects which belong to the list,

Definition at line 120 of file KVDMS.cpp.

◆ GetListing()

KVUniqueNameList KVDMS::GetListing ( const Char_t * directory = "" )

Create and fill TList with just the names of files & containers in current directory (default) or in given directory.

TList is filled with DMSFile_t objects which belong to the list

Definition at line 189 of file KVDMS.cpp.

◆ GetPathInfo()

Bool_t KVDMS::GetPathInfo	(	const Char_t *	path,
		DMSFile_t &	fs
	)

Returns kTRUE if 'path' exists (file or directory, absolute or relative pathname). If so, KVDMSFile_t object will be filled with information on file/container

Definition at line 159 of file KVDMS.cpp.

◆ info()

virtual TString KVDMS::info	(	const Char_t *	file,
		Option_t *	opt = `""`
	)

pure virtual

Implemented in SRB, and IRODS.

◆ init()

virtual Int_t KVDMS::init ( )

pure virtual

Implemented in SRB, and IRODS.

◆ IsContainer()

Bool_t KVDMS::IsContainer ( TString & line ) const

'line' is a line in a directory listing This method should return kTRUE if the line corresponds to a container

Definition at line 103 of file KVDMS.cpp.

◆ list()

virtual TString KVDMS::list ( const Char_t * directory = "" )

pure virtual

Implemented in SRB, and IRODS.

◆ longlist()

virtual TString KVDMS::longlist ( const Char_t * directory = "" )

pure virtual

Implemented in SRB, and IRODS.

◆ mkdir()

virtual Int_t KVDMS::mkdir	(	const Char_t *	path,
		Option_t *	opt = `""`
	)

pure virtual

Implemented in SRB, and IRODS.

◆ put()

virtual Int_t KVDMS::put	(	const Char_t *	source,
		const Char_t *	target = `"."`
	)

pure virtual

Implemented in SRB, and IRODS.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDMS()

Member Function Documentation

◆ cd()

◆ chmod()

◆ DirectoryContains()

◆ exit()

◆ forcedelete()

◆ get()

◆ GetFullListing()

◆ GetListing()

◆ GetPathInfo()

◆ info()

◆ init()

◆ IsContainer()

◆ list()

◆ longlist()

◆ mkdir()

◆ put()