Cross-reference in a KVDataBase.

A key holds a list of cross-references to KVDBRecord objects The name of the key is the name of the table, prefixed by "Key:" The title of the key is the name of the record

Definition at line 37 of file KVDBKey.h.

Public Member Functions
	KVDBKey ()

	KVDBKey (const Char_t name, const Char_t title="", KVDBRecord *parent=0)

virtual	~ KVDBKey ()

virtual KVDBRecord *	GetLink (const Char_t *link) const

virtual KVRList *	GetLinks () const
	return the list of cross-referenced objects More...

virtual KVDBRecord *	GetParent ()

virtual KVDBRecord *	GetRecord ()

virtual Bool_t	LinkTo (KVDBRecord *rec, Bool_t linkback=kTRUE)

virtual void	SetParent (KVDBRecord *parent)

virtual void	SetRecord (KVDBRecord *parent)

virtual void	SetSingleStatus (Bool_t single)

virtual void	SetUniqueStatus (Bool_t unique)

virtual void	Unlink (KVDBRecord *rec, Bool_t linkback=kTRUE)

virtual void	UnlinkAll ()

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
virtual void	AddLink (KVDBRecord *rec)
	Add a link to the list of links. More...

virtual void	RemoveLink (KVDBRecord *rec)
	Remove a link from the list of links. More...

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

void	MakeZombie ()

Protected Attributes
Bool_t	fIsUnique
	Can the list contains more than 1 object the same name. More...

KVRList *	fLinks
	list of cross-referenced records More...

TRef	fRecord
	direct pointer to parent record More...

Bool_t	fSingle
	Can the list contain more than 1 object in the list. More...

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

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

#include <KVDBKey.h>

Inheritance diagram for KVDBKey:

[legend]

Constructor & Destructor Documentation

◆ KVDBKey() [1/2]

KVDBKey::KVDBKey ( )

Definition at line 32 of file KVDBKey.cpp.

◆ KVDBKey() [2/2]

KVDBKey::KVDBKey	(	const Char_t *	name,
		const Char_t *	title = `""`,
		KVDBRecord *	parent = `0`
	)

Definition at line 43 of file KVDBKey.cpp.

◆ ~ KVDBKey()

virtual KVDBKey::~ KVDBKey ( )

virtual

Member Function Documentation

◆ AddLink()

void KVDBKey::AddLink ( KVDBRecord * rec )

protectedvirtual

Add a link to the list of links.

Definition at line 185 of file KVDBKey.cpp.

◆ GetLink()

KVDBRecord * KVDBKey::GetLink ( const Char_t * link ) const

virtual

Definition at line 208 of file KVDBKey.cpp.

◆ GetLinks()

virtual KVRList* KVDBKey::GetLinks ( ) const

inlinevirtual

return the list of cross-referenced objects

Definition at line 64 of file KVDBKey.h.

◆ GetParent()

KVDBRecord * KVDBKey::GetParent ( )

virtual

Definition at line 217 of file KVDBKey.cpp.

◆ GetRecord()

KVDBRecord * KVDBKey::GetRecord ( )

virtual

Definition at line 245 of file KVDBKey.cpp.

◆ LinkTo()

Bool_t KVDBKey::LinkTo	(	KVDBRecord *	rec,
		Bool_t	linkback = `kTRUE`
	)

virtual

This function adds a record to the list of cross-references if fIsUnique is kTRUE we check if there is already an object with the same name: if so we return kFALSE otherwise the record is added and kTRUE is returned. if fSingle is kTRUE the list can handle only one object: if the list is empty the record is added and kTRUE is returned, otherwise kFALSE. check if more than one object is allowed

Definition at line 81 of file KVDBKey.cpp.

◆ RemoveLink()

void KVDBKey::RemoveLink ( KVDBRecord * rec )

protectedvirtual

Remove a link from the list of links.

Definition at line 197 of file KVDBKey.cpp.

◆ SetParent()

void KVDBKey::SetParent ( KVDBRecord * parent )

virtual

Definition at line 226 of file KVDBKey.cpp.

◆ SetRecord()

void KVDBKey::SetRecord ( KVDBRecord * parent )

virtual

Definition at line 235 of file KVDBKey.cpp.

◆ SetSingleStatus()

virtual void KVDBKey::SetSingleStatus ( Bool_t single )

inlinevirtual

Definition at line 77 of file KVDBKey.h.

◆ SetUniqueStatus()

virtual void KVDBKey::SetUniqueStatus ( Bool_t unique )

inlinevirtual

Definition at line 72 of file KVDBKey.h.

◆ Unlink()

void KVDBKey::Unlink	(	KVDBRecord *	rec,
		Bool_t	linkback = `kTRUE`
	)

virtual

This function removes a record from the list of cross-references if linkback is kTRUE then the reference in record "rec" is also removed.

Definition at line 135 of file KVDBKey.cpp.

◆ UnlinkAll()

void KVDBKey::UnlinkAll ( )

virtual

This function recursively removes all cross-references The corresponding references to the owner of this key in all of the referecnced objects will also be removed.

Definition at line 165 of file KVDBKey.cpp.

Member Data Documentation

◆ fIsUnique

Bool_t KVDBKey::fIsUnique

protected

Can the list contains more than 1 object the same name.

Definition at line 41 of file KVDBKey.h.

◆ fLinks

KVRList* KVDBKey::fLinks

protected

list of cross-referenced records

Definition at line 44 of file KVDBKey.h.

◆ fRecord

TRef KVDBKey::fRecord

protected

direct pointer to parent record

Definition at line 43 of file KVDBKey.h.

◆ fSingle

Bool_t KVDBKey::fSingle

protected

Can the list contain more than 1 object in the list.

Definition at line 42 of file KVDBKey.h.

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

kaliveda.doxygen/KVMultiDet/db/KVDBKey.h
kaliveda.doxygen/KVMultiDet/db/KVDBKey.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDBKey() [1/2]

◆ KVDBKey() [2/2]

◆ ~ KVDBKey()

Member Function Documentation

◆ AddLink()

◆ GetLink()

◆ GetLinks()

◆ GetParent()

◆ GetRecord()

◆ LinkTo()

◆ RemoveLink()

◆ SetParent()

◆ SetRecord()

◆ SetSingleStatus()

◆ SetUniqueStatus()

◆ Unlink()

◆ UnlinkAll()

Member Data Documentation

◆ fIsUnique

◆ fLinks

◆ fRecord

◆ fSingle