TKeySQL represents meta-information about object, which was written to SQL database.

It keeps object id, which used to locate object data from database tables.

Definition at line 19 of file TKeySQL.h.

Public Member Functions
	TKeySQL (TDirectory mother, const TObject obj, const char name, const char title=nullptr)
	Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2.

	TKeySQL (TDirectory mother, const void obj, const TClass cl, const char name, const char *title=nullptr)
	Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2.

	TKeySQL (TDirectory mother, Long64_t keyid, Long64_t objid, const char name, const char title, const char keydatetime, Int_t cycle, const char *classname)
	Create TKeySQL object, which corresponds to single entry in keys table.

virtual	~TKeySQL ()=default

void	Delete (Option_t *option="") final
	Removes key from current directory Note: TKeySQL object is not deleted.

void	DeleteBuffer () final
	Delete key buffer(s).

void	FillBuffer (char *&) final
	Encode key header into output buffer.

char *	GetBuffer () const final

Long64_t	GetDBDirId () const
	return sql id of parent directory

Long64_t	GetDBKeyId () const

Long64_t	GetDBObjId () const

Long64_t	GetSeekKey () const final

Long64_t	GetSeekPdir () const final

Bool_t	IsKeyModified (const char keyname, const char keytitle, const char keydatime, Int_t cycle, const char classname)
	Compares keydata with provided and return kTRUE if key was modified Used in TFile::StreamKeysForDirectory() method to verify data for that keys should be updated.

void	Keep () final
	Set the "KEEP" status.

Int_t	Read (TObject *obj) final
	To read an object from the file.

void	ReadBuffer (char *&) final
	Decode input buffer.

Bool_t	ReadFile () final
	Read the key structure from the file.

TObject *	ReadObj () final
	Read object derived from TObject class If it is not TObject or in case of error, return 0.

void *	ReadObjectAny (const TClass *expectedClass) final
	Read object of any type from SQL database.

TObject *	ReadObjWithBuffer (char *bufferRead) final
	Read object derived from TObject class If it is not TObject or in case of error, return 0.

void	SetBuffer () final

Int_t	WriteFile (Int_t=1, TFile *=nullptr) final
	Write the encoded object supported by this key.

Public Member Functions inherited from TKey
	TKey ()
	TKey default constructor.

	TKey (const char name, const char title, const TClass cl, Int_t nbytes, TDirectory motherDir)
	Create a TKey object with the specified name, title for the given class.

	TKey (const TObject obj, const char name, Int_t bufsize, TDirectory *motherDir)
	Create a TKey object for a TObject* and fill output buffer.

	TKey (const TString &name, const TString &title, const TClass cl, Int_t nbytes, TDirectory motherDir)
	Create a TKey object with the specified name, title for the given class.

	TKey (const void obj, const TClass cl, const char name, Int_t bufsize, TDirectory motherDir)
	Create a TKey object for any object obj of class cl d and fill output buffer.

	TKey (Long64_t pointer, Int_t nbytes, TDirectory *motherDir=0)
	Create a TKey object to read keys.

	TKey (TDirectory *motherDir)
	TKey default constructor.

	TKey (TDirectory *motherDir, const TKey &orig, UShort_t pidOffset)
	Copy a TKey from its original directory to the new 'motherDir'.

virtual	~TKey ()
	TKey default destructor.

virtual void	Browse (TBrowser *b)
	Read object from disk and call its Browse() method.

TBuffer *	GetBufferRef () const

virtual const char *	GetClassName () const

Short_t	GetCycle () const
	Return cycle number associated to this key.

const TDatime &	GetDatime () const

TFile *	GetFile () const
	Returns file to which key belong.

virtual const char *	GetIconName () const
	Title can keep 32x32 xpm thumbnail/icon of the parent object.

Short_t	GetKeep () const
	Returns the "KEEP" status.

Int_t	GetKeylen () const

TDirectory *	GetMotherDir () const

Int_t	GetNbytes () const

Int_t	GetObjlen () const

virtual const char *	GetTitle () const
	Returns title (title can contain 32x32 xpm thumbnail/icon).

Int_t	GetVersion () const

virtual void	IncrementPidOffset (UShort_t offset)
	Increment fPidOffset by 'offset'.

Bool_t	IsFolder () const
	Check if object referenced by the key is a folder.

virtual void	ls (Bool_t current) const
	List Key contents.

virtual void	ls (Option_t *option="") const
	List Key contents.

virtual void	Print (Option_t *option="") const
	Print key contents.

void	ReadKeyBuffer (char *&buffer)
	Decode input buffer.

template<typename T >
T *	ReadObject ()
	To read an object (non deriving from TObject) from the file.

void	SetMotherDir (TDirectory *dir)

virtual void	SetParent (const TObject *parent)
	Set parent in key buffer.

virtual Int_t	Sizeof () const
	Return the size in bytes of the key header structure.

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

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

virtual	~TNamed ()
	TNamed destructor.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.

virtual void	Copy (TObject &named) const
	Copy this to obj.

virtual const char *	GetName () const
	Returns name of object.

virtual ULong_t	Hash () const
	Return hash value for this object.

virtual Bool_t	IsSortable () const

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

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)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Member Functions
	TKeySQL ()

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual Int_t	Read (TObject *obj)
	To read an object from the file.

void *	ReadKeyObject (void obj, const TClass expectedClass)
	Read object, associated with key, from database.

void	StoreKeyObject (const void obj, const TClass cl)
	Stores object, associated with key, into data tables.

Protected Member Functions inherited from TKey
void	Build (TDirectory motherDir, const char classname, Long64_t filepos)
	Method used in all TKey constructor to initialize basic data fields.

virtual void	Create (Int_t nbytes, TFile *f=0)
	Create a TKey object of specified size.

void	Reset ()
	Reset the key as it had not been 'filled' yet.

virtual Int_t	WriteFileKeepBuffer (TFile *f=0)
	Write the encoded object supported by this key.

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

void	MakeZombie ()

Protected Attributes
Long64_t	fKeyId {-1}
	! key identifier in KeysTables

Long64_t	fObjId {-1}
	! stored object identifier

Protected Attributes inherited from TKey
char *	fBuffer
	Object buffer.

TBuffer *	fBufferRef
	Pointer to the TBuffer object.

TString	fClassName
	Object Class name.

Short_t	fCycle
	Cycle number.

TDatime	fDatime
	Date/Time of insertion in file.

Short_t	fKeylen
	Number of bytes for the key itself.

Int_t	fLeft
	Number of bytes left in current segment.

TDirectory *	fMotherDir
	!pointer to mother directory

Int_t	fNbytes
	Number of bytes for the object on file.

Int_t	fObjlen
	Length of uncompressed object in bytes.

UShort_t	fPidOffset
	!Offset to be added to the pid index in this key/buffer. This is actually saved in the high bits of fSeekPdir

Long64_t	fSeekKey
	Location of object on file.

Long64_t	fSeekPdir
	Location of parent directory on file.

Int_t	fVersion
	Key version identifier.

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
	TKeySQL (const TKeySQL &)=delete

TKeySQL &	operator= (const TKeySQL &)=delete

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <TKeySQL.h>

Inheritance diagram for TKeySQL:

[legend]

Constructor & Destructor Documentation

◆ TKeySQL() [1/5]

TKeySQL::TKeySQL ( const TKeySQL & )

privatedelete

◆ TKeySQL() [2/5]

TKeySQL::TKeySQL ( )

inlineprotected

Definition at line 26 of file TKeySQL.h.

◆ TKeySQL() [3/5]

TKeySQL::TKeySQL	(	TDirectory *	mother,
		const TObject *	obj,
		const char *	name,
		const char *	title = `nullptr`
	)

Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2.

Definition at line 37 of file TKeySQL.cxx.

◆ TKeySQL() [4/5]

TKeySQL::TKeySQL	(	TDirectory *	mother,
		const void *	obj,
		const TClass *	cl,
		const char *	name,
		const char *	title = `nullptr`
	)

Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2.

Definition at line 57 of file TKeySQL.cxx.

◆ TKeySQL() [5/5]

TKeySQL::TKeySQL	(	TDirectory *	mother,
		Long64_t	keyid,
		Long64_t	objid,
		const char *	name,
		const char *	title,
		const char *	keydatetime,
		Int_t	cycle,
		const char *	classname
	)

Create TKeySQL object, which corresponds to single entry in keys table.

Definition at line 74 of file TKeySQL.cxx.

◆ ~TKeySQL()

virtual TKeySQL::~TKeySQL ( )

virtualdefault

Member Function Documentation

◆ Delete()

void TKeySQL::Delete ( Option_t * option = "" )

finalvirtual

Removes key from current directory Note: TKeySQL object is not deleted.

You still have to call "delete key"

Reimplemented from TKey.

Definition at line 134 of file TKeySQL.cxx.

◆ DeleteBuffer()

void TKeySQL::DeleteBuffer ( )

inlinefinalvirtual

Delete key buffer(s).

Reimplemented from TKey.

Definition at line 51 of file TKeySQL.h.

◆ FillBuffer()

void TKeySQL::FillBuffer ( char *& buffer )

inlinefinalvirtual

Encode key header into output buffer.

Reimplemented from TKey.

Definition at line 52 of file TKeySQL.h.

◆ GetBuffer()

char * TKeySQL::GetBuffer ( ) const

inlinefinalvirtual

Reimplemented from TKey.

Definition at line 53 of file TKeySQL.h.

◆ GetDBDirId()

Long64_t TKeySQL::GetDBDirId ( ) const

return sql id of parent directory

Definition at line 147 of file TKeySQL.cxx.

◆ GetDBKeyId()

Long64_t TKeySQL::GetDBKeyId ( ) const

inline

Definition at line 45 of file TKeySQL.h.

◆ GetDBObjId()

Long64_t TKeySQL::GetDBObjId ( ) const

inline

Definition at line 46 of file TKeySQL.h.

◆ GetSeekKey()

Long64_t TKeySQL::GetSeekKey ( ) const

inlinefinalvirtual

Reimplemented from TKey.

Definition at line 54 of file TKeySQL.h.

◆ GetSeekPdir()

Long64_t TKeySQL::GetSeekPdir ( ) const

inlinefinalvirtual

Reimplemented from TKey.

Definition at line 55 of file TKeySQL.h.

◆ IsKeyModified()

Bool_t TKeySQL::IsKeyModified	(	const char *	keyname,
		const char *	keytitle,
		const char *	keydatime,
		Int_t	cycle,
		const char *	classname
	)

Compares keydata with provided and return kTRUE if key was modified Used in TFile::StreamKeysForDirectory() method to verify data for that keys should be updated.

Definition at line 92 of file TKeySQL.cxx.

◆ Keep()

void TKeySQL::Keep ( )

inlinefinalvirtual

Set the "KEEP" status.

When the KEEP flag is set to 1 the object cannot be purged.

Reimplemented from TKey.

Definition at line 56 of file TKeySQL.h.

◆ operator=()

TKeySQL & TKeySQL::operator= ( const TKeySQL & )

privatedelete

◆ Read() [1/3]

virtual Int_t TKey::Read ( const char * name )

inlineprotectedvirtual

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented from TKey.

Definition at line 54 of file TKey.h.

◆ Read() [2/3]

Int_t TKey::Read ( TObject * obj )

protectedvirtual

To read an object from the file.

The object associated to this key is read from the file into memory. Before invoking this function, obj has been created via the default constructor.

Reimplemented from TKey.

Definition at line 98 of file TKey.cxx.

◆ Read() [3/3]

Int_t TKeySQL::Read ( TObject * tobj )

finalvirtual

To read an object from the file.

The object associated to this key is read from the file into memory. Before invoking this function, obj has been created via the default constructor.

Reimplemented from TKey.

Definition at line 189 of file TKeySQL.cxx.

◆ ReadBuffer()

void TKeySQL::ReadBuffer ( char *& buffer )

inlinefinalvirtual

Decode input buffer.

In some situation will add key to gDirectory.

Reimplemented from TKey.

Definition at line 63 of file TKeySQL.h.

◆ ReadFile()

Bool_t TKeySQL::ReadFile ( )

inlinefinalvirtual

Read the key structure from the file.

Reimplemented from TKey.

Definition at line 64 of file TKeySQL.h.

◆ ReadKeyObject()

void * TKeySQL::ReadKeyObject	(	void *	obj,
		const TClass *	expectedClass
	)

protected

Read object, associated with key, from database.

Definition at line 272 of file TKeySQL.cxx.

◆ ReadObj()

TObject * TKeySQL::ReadObj ( )

finalvirtual

Read object derived from TObject class If it is not TObject or in case of error, return 0.

Reimplemented from TKey.

Definition at line 203 of file TKeySQL.cxx.

◆ ReadObjectAny()

void * TKeySQL::ReadObjectAny ( const TClass * expectedClass )

finalvirtual

Read object of any type from SQL database.

Reimplemented from TKey.

Definition at line 252 of file TKeySQL.cxx.

◆ ReadObjWithBuffer()

TObject * TKeySQL::ReadObjWithBuffer ( char * bufferRead )

finalvirtual

Read object derived from TObject class If it is not TObject or in case of error, return 0.

Reimplemented from TKey.

Definition at line 228 of file TKeySQL.cxx.

◆ SetBuffer()

void TKeySQL::SetBuffer ( )

inlinefinalvirtual

Reimplemented from TKey.

Definition at line 65 of file TKeySQL.h.

◆ StoreKeyObject()

void TKeySQL::StoreKeyObject	(	const void *	obj,
		const TClass *	cl
	)

protected

Stores object, associated with key, into data tables.

Definition at line 155 of file TKeySQL.cxx.

◆ WriteFile()

Int_t TKeySQL::WriteFile	(	Int_t	cycle = `1`,
		TFile *	f = `nullptr`
	)

inlinefinalvirtual

Write the encoded object supported by this key.

The function returns the number of bytes committed to the file. If a write error occurs, the number of bytes returned is -1.

Reimplemented from TKey.

Definition at line 66 of file TKeySQL.h.

Member Data Documentation

◆ fKeyId

Long64_t TKeySQL::fKeyId {-1}

protected

! key identifier in KeysTables

Definition at line 33 of file TKeySQL.h.

◆ fObjId

Long64_t TKeySQL::fObjId {-1}

protected

! stored object identifier

Definition at line 34 of file TKeySQL.h.

Libraries for TKeySQL:

[legend]

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

io/sql/inc/TKeySQL.h
io/sql/src/TKeySQL.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ TKeySQL() [1/5]

◆ TKeySQL() [2/5]

◆ TKeySQL() [3/5]

◆ TKeySQL() [4/5]

◆ TKeySQL() [5/5]

◆ ~TKeySQL()

Member Function Documentation

◆ Delete()

◆ DeleteBuffer()

◆ FillBuffer()

◆ GetBuffer()

◆ GetDBDirId()

◆ GetDBKeyId()

◆ GetDBObjId()

◆ GetSeekKey()

◆ GetSeekPdir()

◆ IsKeyModified()

◆ Keep()

◆ operator=()

◆ Read() [1/3]

◆ Read() [2/3]

◆ Read() [3/3]

◆ ReadBuffer()

◆ ReadFile()

◆ ReadKeyObject()

◆ ReadObj()

◆ ReadObjectAny()

◆ ReadObjWithBuffer()

◆ SetBuffer()

◆ StoreKeyObject()

◆ WriteFile()

Member Data Documentation

◆ fKeyId

◆ fObjId