Book space in a file, create I/O buffers, to fill them, (un)compress them.

The TKey class includes functions to book space in a file, to create I/O buffers, to fill these buffers, to compress/uncompress data buffers. Before saving (making persistent) an object in a file, a key must be created. The key structure contains all the information to uniquely identify a persistent object in a file.

Data Member	Explanation
fNbytes	Number of bytes for the compressed object and key.
fObjlen	Length of uncompressed object.
fDatime	Date/Time when the object was written.
fKeylen	Number of bytes for the key structure.
fCycle	Cycle number of the object.
fSeekKey	Address of the object on file (points to fNbytes). This is a redundant information used to cross-check the data base integrity.
fSeekPdir	Pointer to the directory supporting this object.
fClassName	Object class name.
fName	Name of the object.
fTitle	Title of the object.

In the 16 highest bits of fSeekPdir is encoded a pid offset. This offset is to be added to the pid index stored in the TRef object and the referenced TObject.

The TKey class is used by ROOT to:

Write an object in the current directory
Write a new ntuple buffer

The structure of a file is shown in TFile::TFile. The structure of a directory is shown in TDirectoryFile::TDirectoryFile. The TKey class is used by the TBasket class. See also TTree.

Definition at line 28 of file TKey.h.

Public Member Functions
	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=nullptr)
	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'.

	~TKey () override
	TKey default destructor.

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

void	Delete (Option_t *option="") override
	Delete an object from the file.

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

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

virtual char *	GetBuffer () const

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.

const char *	GetIconName () const override
	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 Long64_t	GetSeekKey () const

virtual Long64_t	GetSeekPdir () const

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

Int_t	GetVersion () const

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

TClass *	IsA () const override

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

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

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

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

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

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

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

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

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

virtual TObject *	ReadObj ()
	To read a TObject* from the file.

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

virtual void *	ReadObjectAny (const TClass *expectedClass)
	To read an object (non deriving from TObject) from the file.

virtual TObject *	ReadObjWithBuffer (char *bufferRead)
	To read a TObject* from bufferRead.

virtual void	SetBuffer ()

void	SetMotherDir (TDirectory *dir)

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

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

void	Streamer (TBuffer &) override
	Stream a class object.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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.

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

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

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

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

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

const char *	GetTitle () const override
	Returns title of object.

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

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

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

void	Print (Option_t *option="") const override
	Print TNamed name and title.

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.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 with: `gROOT->SetSelectedPad(c1)`.

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=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	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 (the base implementation is no-op).

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, void vp)
	Only called by placement new when throwing an exception.

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

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

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

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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 Member Functions
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=nullptr)
	Create a TKey object of specified size.

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

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

virtual Int_t	WriteFileKeepBuffer (TFile *f=nullptr)
	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
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 Types
enum	EStatusBits { kIsDirectoryFile = (1ULL << ( 14 )) , kReproducible = (1ULL << ( 15 )) }

Private Member Functions
	TKey (const TKey &)=delete

TKey &	operator= (const TKey &)=delete

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

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

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

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

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TKey.h>

Inheritance diagram for TKey:

[legend]

Member Enumeration Documentation

◆ EStatusBits

enum TKey::EStatusBits

private

Enumerator
kIsDirectoryFile
kReproducible

Definition at line 31 of file TKey.h.

Constructor & Destructor Documentation

◆ TKey() [1/9]

TKey::TKey ( const TKey & )

privatedelete

◆ TKey() [2/9]

TKey::TKey ( )

TKey default constructor.

Definition at line 90 of file TKey.cxx.

◆ TKey() [3/9]

TKey::TKey ( TDirectory * motherDir )

TKey default constructor.

Definition at line 102 of file TKey.cxx.

◆ TKey() [4/9]

TKey::TKey	(	TDirectory *	motherDir,
		const TKey &	orig,
		UShort_t	pidOffset
	)

Copy a TKey from its original directory to the new 'motherDir'.

Definition at line 114 of file TKey.cxx.

◆ TKey() [5/9]

TKey::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.

WARNING: in name avoid special characters like '^','$','.' that are used by the regular expression parser (see TRegexp).

Definition at line 194 of file TKey.cxx.

◆ TKey() [6/9]

TKey::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.

WARNING: in name avoid special characters like '^','$','.' that are used by the regular expression parser (see TRegexp).

Definition at line 210 of file TKey.cxx.

◆ TKey() [7/9]

TKey::TKey	(	const TObject *	obj,
		const char *	name,
		Int_t	bufsize,
		TDirectory *	motherDir
	)

Create a TKey object for a TObject* and fill output buffer.

WARNING: in name avoid special characters like '^','$','.' that are used by the regular expression parser (see TRegexp).

Definition at line 226 of file TKey.cxx.

◆ TKey() [8/9]

TKey::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.

WARNING: in name avoid special characters like '^','$','.' that are used by the regular expression parser (see TRegexp).

Definition at line 299 of file TKey.cxx.

◆ TKey() [9/9]

TKey::TKey	(	Long64_t	pointer,
		Int_t	nbytes,
		TDirectory *	motherDir = `nullptr`
	)

Create a TKey object to read keys.

Constructor called by TDirectoryFile::ReadKeys and by TFile::TFile. A TKey object is created to read the keys structure itself.

Definition at line 178 of file TKey.cxx.

◆ ~TKey()

TKey::~TKey ( )

override

TKey default destructor.

Definition at line 525 of file TKey.cxx.

Member Function Documentation

◆ Browse()

void TKey::Browse ( TBrowser * b )

overridevirtual

Read object from disk and call its Browse() method.

If object with same name already exist in memory delete it (like TDirectoryFile::Get() is doing), except when the key references a folder in which case we don't want to re-read the folder object since it might contain new objects not yet saved.

Reimplemented from TObject.

Definition at line 427 of file TKey.cxx.

◆ Build()

void TKey::Build	(	TDirectory *	motherDir,
		const char *	classname,
		Long64_t	filepos
	)

protected

Method used in all TKey constructor to initialize basic data fields.

The member filepos is used to calculate correct version number of key if filepos==-1, end of file position is used.

Definition at line 389 of file TKey.cxx.

◆ Class()

static TClass * TKey::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TKey::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TKey::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 116 of file TKey.h.

◆ Create()

void TKey::Create	(	Int_t	nbytes,
		TFile *	externFile = `nullptr`
	)

protectedvirtual

Create a TKey object of specified size.

If externFile!=0, key will be allocated in specified file, otherwise file of mother directory will be used.

Definition at line 459 of file TKey.cxx.

◆ DeclFileName()

static const char * TKey::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 116 of file TKey.h.

◆ Delete()

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

overridevirtual

Delete an object from the file.

Note: the key is not deleted. You still have to call "delete key". This is different from the behaviour of TObject::Delete()!

Reimplemented from TObject.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 538 of file TKey.cxx.

◆ DeleteBuffer()

void TKey::DeleteBuffer ( )

virtual

Delete key buffer(s).

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 559 of file TKey.cxx.

◆ FillBuffer()

void TKey::FillBuffer ( char *& buffer )

overridevirtual

Encode key header into output buffer.

Reimplemented from TNamed.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 601 of file TKey.cxx.

◆ GetBuffer()

virtual char * TKey::GetBuffer ( ) const

inlinevirtual

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 78 of file TKey.h.

◆ GetBufferRef()

TBuffer * TKey::GetBufferRef ( ) const

inline

Definition at line 79 of file TKey.h.

◆ GetClassName()

virtual const char * TKey::GetClassName ( ) const

inlinevirtual

Definition at line 75 of file TKey.h.

◆ GetCycle()

Short_t TKey::GetCycle ( ) const

Return cycle number associated to this key.

Definition at line 577 of file TKey.cxx.

◆ GetDatime()

const TDatime & TKey::GetDatime ( ) const

inline

Definition at line 81 of file TKey.h.

◆ GetFile()

TFile * TKey::GetFile ( ) const

Returns file to which key belong.

Definition at line 585 of file TKey.cxx.

◆ GetIconName()

const char * TKey::GetIconName ( ) const

overridevirtual

Title can keep 32x32 xpm thumbnail/icon of the parent object.

Reimplemented from TObject.

Definition at line 1532 of file TKey.cxx.

◆ GetKeep()

Short_t TKey::GetKeep ( ) const

Returns the "KEEP" status.

Definition at line 593 of file TKey.cxx.

◆ GetKeylen()

Int_t TKey::GetKeylen ( ) const

inline

Definition at line 84 of file TKey.h.

◆ GetMotherDir()

TDirectory * TKey::GetMotherDir ( ) const

inline

Definition at line 85 of file TKey.h.

◆ GetNbytes()

Int_t TKey::GetNbytes ( ) const

inline

Definition at line 86 of file TKey.h.

◆ GetObjlen()

Int_t TKey::GetObjlen ( ) const

inline

Definition at line 87 of file TKey.h.

◆ GetSeekKey()

virtual Long64_t TKey::GetSeekKey ( ) const

inlinevirtual

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 89 of file TKey.h.

◆ GetSeekPdir()

virtual Long64_t TKey::GetSeekPdir ( ) const

inlinevirtual

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 90 of file TKey.h.

◆ GetTitle()

const char * TKey::GetTitle ( ) const

overridevirtual

Returns title (title can contain 32x32 xpm thumbnail/icon).

Reimplemented from TObject.

Definition at line 1540 of file TKey.cxx.

◆ GetVersion()

Int_t TKey::GetVersion ( ) const

inline

Definition at line 88 of file TKey.h.

◆ IncrementPidOffset()

void TKey::IncrementPidOffset ( UShort_t offset )

virtual

Increment fPidOffset by 'offset'.

This offset is used when a key (or basket) is transfered from one file to the other. In this case the TRef and TObject might have stored a pid index (to retrieve TProcessIDs) which refered to their order on the original file, the fPidOffset is to be added to those values to correctly find the TProcessID. This fPidOffset needs to be increment if the key/basket is copied and need to be zero for new key/basket.

Definition at line 650 of file TKey.cxx.

◆ IsA()

TClass * TKey::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 116 of file TKey.h.

◆ IsFolder()

Bool_t TKey::IsFolder ( ) const

overridevirtual

Check if object referenced by the key is a folder.

Reimplemented from TObject.

Definition at line 664 of file TKey.cxx.

◆ Keep()

void TKey::Keep ( )

virtual

Set the "KEEP" status.

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

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 685 of file TKey.cxx.

◆ ls() [1/2]

void TKey::ls ( Bool_t current ) const

virtual

List Key contents.

Add indicator of whether it is the current item or a backup copy.

Definition at line 694 of file TKey.cxx.

◆ ls() [2/2]

void TKey::ls ( Option_t * option = "" ) const

overridevirtual

List Key contents.

Reimplemented from TObject.

Definition at line 705 of file TKey.cxx.

◆ operator=()

TKey & TKey::operator= ( const TKey & )

privatedelete

◆ Print()

void TKey::Print ( Option_t * option = "" ) const

overridevirtual

Print key contents.

Reimplemented from TObject.

Definition at line 714 of file TKey.cxx.

◆ Read() [1/2]

Int_t TKey::Read ( const char * name )

inlineoverrideprotectedvirtual

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

Reimplemented in TKeyXML, and TKeySQL.

Definition at line 54 of file TKey.h.

◆ Read() [2/2]

Int_t TKey::Read ( TObject * obj )

virtual

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 in TKeySQL, TKeySQL, and TKeyXML.

Definition at line 1157 of file TKey.cxx.

◆ ReadBuffer()

void TKey::ReadBuffer ( char *& buffer )

virtual

Decode input buffer.

In some situation will add key to gDirectory.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1218 of file TKey.cxx.

◆ ReadFile()

Bool_t TKey::ReadFile ( )

virtual

Read the key structure from the file.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1273 of file TKey.cxx.

◆ ReadKeyBuffer()

void TKey::ReadKeyBuffer ( char *& buffer )

Decode input buffer.

Definition at line 1230 of file TKey.cxx.

◆ ReadObj()

TObject * TKey::ReadObj ( )

virtual

To read a TObject* from the file.

The object associated to this key is read from the file into memory Once the key structure is read (via Streamer) the class identifier of the object is known. Using the class identifier we find the TClass object for this class. A TClass object contains a full description (i.e. dictionary) of the associated class. In particular the TClass object can create a new object of the class type it describes. This new object now calls its Streamer function to rebuilt itself.

Use TKey::ReadObjectAny to read any object non-derived from TObject

Note

A C style cast can only be used in the case where the final class of this object derives from TObject as a first inheritance, otherwise one must use a dynamic_cast.

Example1: simplified case

class MyClass : public TObject, public AnotherClass

TObject

Mother of all ROOT objects.

Definition TObject.h:41

then on return, one get away with using:

MyClass *obj = (MyClass*)key->ReadObj();

Example2: Usual case (recommended unless performance is critical)

MyClass *obj = dynamic_cast<MyClass*>(key->ReadObj());

which support also the more complex inheritance like:

class MyClass : public AnotherClass, public TObject

Of course, dynamic_cast<> can also be used in the example 1.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 758 of file TKey.cxx.

◆ ReadObject()

template<typename T >

T * TKey::ReadObject ( )

inline

To read an object (non deriving from TObject) from the file.

This is more user friendly version of TKey::ReadObjectAny. See TKey::ReadObjectAny for more details.

Definition at line 103 of file TKey.h.

◆ ReadObjectAny()

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

virtual

To read an object (non deriving from TObject) from the file.

If expectedClass is not null, we checked that that actual class of the object stored is suitable to be stored in a pointer pointing to an object of class 'expectedClass'. We also adjust the value of the returned address so that it is suitable to be cast (C-Style) a pointer pointing to an object of class 'expectedClass'.

So for example if the class Bottom inherits from Top and the object stored is of type Bottom you can safely do:

auto TopClass = TClass::GetClass("Top");
auto ptr = (Top*) key->ReadObjectAny( TopClass );
if (ptr==0) printError("the object stored in the key is not of the expected type\n");

The object associated to this key is read from the file into memory. Once the key structure is read (via Streamer) the class identifier of the object is known. Using the class identifier we find the TClass object for this class. A TClass object contains a full description (i.e. dictionary) of the associated class. In particular the TClass object can create a new object of the class type it describes. This new object now calls its Streamer function to rebuilt itself.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1023 of file TKey.cxx.

◆ ReadObjWithBuffer()

TObject * TKey::ReadObjWithBuffer ( char * bufferRead )

virtual

To read a TObject* from bufferRead.

This function is identical to TKey::ReadObj, but it reads directly from bufferRead instead of reading from a file. The object associated to this key is read from the buffer into memory Using the class identifier we find the TClass object for this class. A TClass object contains a full description (i.e. dictionary) of the associated class. In particular the TClass object can create a new object of the class type it describes. This new object now calls its Streamer function to rebuilt itself.

Note

This function is called only internally by ROOT classes. Although being public it is not supposed to be used outside ROOT. If used, you must make sure that the bufferRead is large enough to accomodate the object being read.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 892 of file TKey.cxx.

◆ Reset()

void TKey::Reset ( )

protected

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

Definition at line 1310 of file TKey.cxx.

◆ SetBuffer()

virtual void TKey::SetBuffer ( )

inlinevirtual

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 110 of file TKey.h.

◆ SetMotherDir()

void TKey::SetMotherDir ( TDirectory * dir )

inline

Definition at line 112 of file TKey.h.

◆ SetParent()

void TKey::SetParent ( const TObject * parent )

virtual

Set parent in key buffer.

Definition at line 1302 of file TKey.cxx.

◆ Sizeof()

Int_t TKey::Sizeof ( ) const

overridevirtual

Return the size in bytes of the key header structure.

An explaination about the nbytes (Int_t nbytes) variable used in the function. The size of fSeekKey and fSeekPdir is 8 instead of 4 if version is greater than 1000.

Component	Sizeof
fNbytes	4
sizeof(Version_t)	2
fObjlen	4
fKeylen	2
fCycle	2
fSeekKey	4 or 8
fSeekPdir	4 or 8
TOTAL	22

Reimplemented from TNamed.

Definition at line 1344 of file TKey.cxx.

◆ Streamer()

void TKey::Streamer ( TBuffer & b )

overridevirtual

Stream a class object.

Reimplemented from TObject.

Reimplemented in TKeySQL, and TKeyXML.

Definition at line 1361 of file TKey.cxx.

◆ StreamerNVirtual()

void TKey::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 116 of file TKey.h.

◆ WriteFile()

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

virtual

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 in TKeySQL, and TKeyXML.

Definition at line 1458 of file TKey.cxx.

◆ WriteFileKeepBuffer()

Int_t TKey::WriteFileKeepBuffer ( TFile * f = nullptr )

protectedvirtual

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.

Definition at line 1499 of file TKey.cxx.

Member Data Documentation

◆ fBuffer

char* TKey::fBuffer

protected

Object buffer.

Definition at line 49 of file TKey.h.

◆ fBufferRef

TBuffer* TKey::fBufferRef

protected

Pointer to the TBuffer object.

Definition at line 50 of file TKey.h.

◆ fClassName

TString TKey::fClassName

protected

Object Class name.

Definition at line 47 of file TKey.h.

◆ fCycle

Short_t TKey::fCycle

protected

Cycle number.

Definition at line 44 of file TKey.h.

◆ fDatime

TDatime TKey::fDatime

protected

Date/Time of insertion in file.

Definition at line 42 of file TKey.h.

◆ fKeylen

Short_t TKey::fKeylen

protected

Number of bytes for the key itself.

Definition at line 43 of file TKey.h.

◆ fLeft

Int_t TKey::fLeft

protected

Number of bytes left in current segment.

Definition at line 48 of file TKey.h.

◆ fMotherDir

TDirectory* TKey::fMotherDir

protected

!pointer to mother directory

Definition at line 52 of file TKey.h.

◆ fNbytes

Int_t TKey::fNbytes

protected

Number of bytes for the object on file.

Definition at line 40 of file TKey.h.

◆ fObjlen

Int_t TKey::fObjlen

protected

Length of uncompressed object in bytes.

Definition at line 41 of file TKey.h.

◆ fPidOffset

UShort_t TKey::fPidOffset

protected

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

Definition at line 51 of file TKey.h.

◆ fSeekKey

Long64_t TKey::fSeekKey

protected

Location of object on file.

Definition at line 45 of file TKey.h.

◆ fSeekPdir

Long64_t TKey::fSeekPdir

protected

Location of parent directory on file.

Definition at line 46 of file TKey.h.

◆ fVersion

Int_t TKey::fVersion

protected

Key version identifier.

Definition at line 39 of file TKey.h.

Libraries for TKey:

[legend]

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

io/io/inc/TKey.h
io/io/src/TKey.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ EStatusBits

Constructor & Destructor Documentation

◆ TKey() [1/9]

◆ TKey() [2/9]

◆ TKey() [3/9]

◆ TKey() [4/9]

◆ TKey() [5/9]

◆ TKey() [6/9]

◆ TKey() [7/9]

◆ TKey() [8/9]

◆ TKey() [9/9]

◆ ~TKey()

Member Function Documentation

◆ Browse()

◆ Build()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Create()

◆ DeclFileName()

◆ Delete()

◆ DeleteBuffer()

◆ FillBuffer()

◆ GetBuffer()

◆ GetBufferRef()

◆ GetClassName()

◆ GetCycle()

◆ GetDatime()

◆ GetFile()

◆ GetIconName()

◆ GetKeep()

◆ GetKeylen()

◆ GetMotherDir()

◆ GetNbytes()

◆ GetObjlen()

◆ GetSeekKey()

◆ GetSeekPdir()

◆ GetTitle()

◆ GetVersion()

◆ IncrementPidOffset()

◆ IsA()

◆ IsFolder()

◆ Keep()

◆ ls() [1/2]

◆ ls() [2/2]

◆ operator=()

◆ Print()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadBuffer()

◆ ReadFile()

◆ ReadKeyBuffer()

◆ ReadObj()

Note

Example1: simplified case

Example2: Usual case (recommended unless performance is critical)

◆ ReadObject()

◆ ReadObjectAny()

◆ ReadObjWithBuffer()

Note

◆ Reset()

◆ SetBuffer()

◆ SetMotherDir()

◆ SetParent()

◆ Sizeof()

◆ Streamer()

◆ StreamerNVirtual()

◆ WriteFile()

◆ WriteFileKeepBuffer()

Member Data Documentation

◆ fBuffer

◆ fBufferRef