The RKeyBlob writes an invisible key into a TFile.

That is, a key that is not indexed in the list of keys, like a TBasket. NOTE: out of anonymous namespace because otherwise ClassDefInline fails to compile on some platforms.

Definition at line 611 of file RMiniFile.cxx.

Public Member Functions
	RKeyBlob ()=default

	RKeyBlob (TFile *file)

TClass *	IsA () const override

void	Reserve (size_t nbytes, std::uint64_t *seekKey)
	Register a new key for a data record of size nbytes.

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

bool	WasAllocatedInAFreeSlot () const

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=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
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

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

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 )) }

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=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 TNamed
void	SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
	Save object name and title into the output stream "out".

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 ()

Static Protected Member Functions inherited from TObject
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".

static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Bool_t empty_line=kFALSE)
	Save array in the output stream "out" as vector.

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

Inheritance diagram for ROOT::Internal::RKeyBlob:

[legend]

Constructor & Destructor Documentation

◆ RKeyBlob() [1/2]

ROOT::Internal::RKeyBlob::RKeyBlob ( )

default

◆ RKeyBlob() [2/2]

ROOT::Internal::RKeyBlob::RKeyBlob ( TFile * file )

inlineexplicit

Definition at line 615 of file RMiniFile.cxx.

Member Function Documentation

◆ Class()

static TClass * ROOT::Internal::RKeyBlob::Class ( )

inlinestatic

Returns: TClass describing this class

Definition at line 631 of file RMiniFile.cxx.

◆ Class_Name()

static const char * ROOT::Internal::RKeyBlob::Class_Name ( )

inlinestatic

Returns: Name of this class

Definition at line 631 of file RMiniFile.cxx.

◆ Class_Version()

static constexpr Version_t ROOT::Internal::RKeyBlob::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 631 of file RMiniFile.cxx.

◆ DeclFileName()

static const char * ROOT::Internal::RKeyBlob::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 631 of file RMiniFile.cxx.

◆ IsA()

TClass * ROOT::Internal::RKeyBlob::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 631 of file RMiniFile.cxx.

◆ Reserve()

void ROOT::Internal::RKeyBlob::Reserve	(	size_t	nbytes,
		std::uint64_t *	seekKey )

inline

Register a new key for a data record of size nbytes.

Definition at line 623 of file RMiniFile.cxx.

◆ Streamer()

void ROOT::Internal::RKeyBlob::Streamer ( TBuffer & R__b )

inlineoverridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Definition at line 631 of file RMiniFile.cxx.

◆ StreamerNVirtual()

void ROOT::Internal::RKeyBlob::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 631 of file RMiniFile.cxx.

◆ WasAllocatedInAFreeSlot()

bool ROOT::Internal::RKeyBlob::WasAllocatedInAFreeSlot ( ) const

inline

Definition at line 629 of file RMiniFile.cxx.

tree/ntuple/src/RMiniFile.cxx

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ RKeyBlob() [1/2]

◆ RKeyBlob() [2/2]

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ IsA()

◆ Reserve()

◆ Streamer()

◆ StreamerNVirtual()

◆ WasAllocatedInAFreeSlot()