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

Definition at line 59 of file KVDMS.h.

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

virtual	~KVDMS ()

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

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

virtual 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

virtual KVUniqueNameList *	GetFullListing (const Char_t *directory="")

virtual TList *	GetListing (const Char_t *directory="")

virtual 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

virtual 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...

virtual	~ KVBase ()

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

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

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

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

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

virtual TObject *	Clone (const char *newname="") const

virtual Int_t	Compare (const TObject *obj) const

virtual void	FillBuffer (char *&buffer)

virtual const char *	GetName () const

virtual const char *	GetTitle () const

virtual ULong_t	Hash () const

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const

TNamed &	operator= (const TNamed &rhs)

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=0)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete[] (void *ptr)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const

Protected Member Functions
Bool_t	buildCommand (const Char_t scmd, const Char_t args="", Option_t *opts="")

Int_t	execCommand ()

virtual void	ExtractFileInfos (TString &, DMSFile_t *) const =0

TString	pipeCommand ()

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Private Attributes
TString	fcmd
	string holding full path to command line with arguments More...

TString	fexec
	string holding full path to executable More...

TString	fout
	string holding results of command More...

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

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Static Public Member Functions inherited from KVBase
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 Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t 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="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t 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 date. 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 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	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 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 ()

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Protected Attributes inherited from KVBase
TString	fLabel
	label for the object More...

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

#include <KVDMS.h>

Inheritance diagram for KVDMS:

[legend]

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.

◆ ~KVDMS()

KVDMS::~KVDMS ( )

virtual

Definition at line 32 of file KVDMS.cpp.

Member Function Documentation

◆ buildCommand()

Bool_t KVDMS::buildCommand	(	const Char_t *	scmd,
		const Char_t *	args = `""`,
		Option_t *	opts = `""`
	)

protected

scmd = one of the DMS commands (init, ls, get, etc.) args = (optional) list of arguments for command (filename, etc.) opts = (optional) list of options for command If the command give in 'scmd' is found in the path specified by the user's PATH environment variables, this method returns kTRUE and private member variables fexec and fcmd will hold the full path to the executable and the full command line to pass to gSystem->Exec. If executable is not found, returns kFALSE.

Definition at line 48 of file KVDMS.cpp.

◆ 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 = `""`
	)

virtual

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

Definition at line 233 of file KVDMS.cpp.

◆ execCommand()

Int_t KVDMS::execCommand ( )

protected

Execute last command initialised with buildCommand() and return the value given by the operating system. Returns -1 if no command has been defined.

Definition at line 79 of file KVDMS.cpp.

◆ exit()

virtual Int_t KVDMS::exit ( )

pure virtual

Implemented in SRB, and IRODS.

◆ ExtractFileInfos()

virtual void KVDMS::ExtractFileInfos	(	TString &	,
		DMSFile_t *
	)		const

protectedpure 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 = "" )

virtual

Create and fill TList with info (name, size, modification date) on all files & containers in current directory (default) or in given directory. TList is filled with DMSFile_t objects which belong to the list, list must be deleted after use.

Definition at line 127 of file KVDMS.cpp.

◆ GetListing()

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

virtual

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, list must be deleted after use.

Definition at line 195 of file KVDMS.cpp.

◆ GetPathInfo()

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

virtual

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 166 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

virtual

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

Definition at line 111 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.

◆ pipeCommand()

TString KVDMS::pipeCommand ( )

protected

Execute last command initialised with buildCommand() and return the value given by the operating system in a string.

Definition at line 95 of file KVDMS.cpp.

◆ put()

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

pure virtual

Implemented in SRB, and IRODS.

Member Data Documentation

◆ fcmd

TString KVDMS::fcmd

private

string holding full path to command line with arguments

Definition at line 61 of file KVDMS.h.

◆ fexec

TString KVDMS::fexec

private

string holding full path to executable

Definition at line 60 of file KVDMS.h.

◆ fout

TString KVDMS::fout

private

string holding results of command

Definition at line 62 of file KVDMS.h.

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

kaliveda.doxygen/KVMultiDet/data_management/KVDMS.h
kaliveda.doxygen/KVMultiDet/data_management/KVDMS.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDMS()

◆ ~KVDMS()

Member Function Documentation

◆ buildCommand()

◆ cd()

◆ chmod()

◆ DirectoryContains()

◆ execCommand()

◆ exit()

◆ ExtractFileInfos()

◆ forcedelete()

◆ get()

◆ GetFullListing()

◆ GetListing()

◆ GetPathInfo()

◆ info()

◆ init()

◆ IsContainer()

◆ list()

◆ longlist()

◆ mkdir()

◆ pipeCommand()

◆ put()

Member Data Documentation

◆ fcmd

◆ fexec

◆ fout