Definition at line 24 of file TKeyXML.h.

Public Member Functions
	TKeyXML (TDirectory mother, Long64_t keyid, const TObject obj, const char name=0, const char title=0)
	Creates TKeyXML and convert obj data to xml structures. More...

	TKeyXML (TDirectory mother, Long64_t keyid, const void obj, const TClass cl, const char name, const char *title=0)
	Creates TKeyXML and convert obj data to xml structures. More...

	TKeyXML (TDirectory *mother, Long64_t keyid, XMLNodePointer_t keynode)
	Creates TKeyXML and takes ownership over xml node, from which object can be restored. More...

virtual	~TKeyXML ()
	TKeyXML destructor. More...

virtual void	Delete (Option_t *option="")
	Delete key from current directory Note: TKeyXML object is not deleted. More...

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

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

virtual char *	GetBuffer () const

virtual Long64_t	GetSeekKey () const

virtual Long64_t	GetSeekPdir () const

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

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

virtual TObject *	ReadObj ()
	read object derived from TObject class, from key if it is not TObject or in case of error, return 0 More...

virtual TObject *	ReadObjWithBuffer (char *bufferRead)
	read object derived from TObject class, from key if it is not TObject or in case of error, return 0 More...

virtual void *	ReadObjectAny (const TClass *expectedClass)
	read object of any type More...

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

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

virtual void	SetBuffer ()

virtual Int_t	WriteFile (Int_t=1, TFile *=0)
	Write the encoded object supported by this key. More...

XMLNodePointer_t	KeyNode () const

Long64_t	GetKeyId () const

Bool_t	IsSubdir () const

void	SetSubir ()

void	UpdateObject (TObject *obj)
	updates object, stored in the node Used for TDirectory data update More...

void	UpdateAttributes ()
	update key attributes in key node More...

Public Member Functions inherited from TKey
	TKey ()

	TKey (TDirectory *motherDir)
	TKey default constructor. More...

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

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

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

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

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

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

virtual	~TKey ()
	TKey default destructor. More...

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

virtual const char *	GetClassName () const

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

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

TBuffer *	GetBufferRef () const

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

const TDatime &	GetDatime () const

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

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

Int_t	GetKeylen () const

TDirectory *	GetMotherDir () const

Int_t	GetNbytes () const

Int_t	GetObjlen () const

Int_t	GetVersion () const

virtual ULong_t	Hash () const
	This Hash function should redefine the default from TNamed. More...

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

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

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

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

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

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

void	SetMotherDir (TDirectory *dir)

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

	ClassDef (TKey, 4)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

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

	TNamed (const TNamed &named)

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

virtual	~TNamed ()

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

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

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

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

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

virtual Bool_t	IsSortable () const

virtual void	SetName (const char *name)
	Change (i.e. More...

virtual void	SetNameTitle (const char name, const char title)
	Change (i.e. set) all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual	~TObject ()
	TObject destructor. More...

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

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

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

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

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

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

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

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

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

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

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

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

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

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

virtual Option_t *	GetOption () const

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

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

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

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

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

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

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

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

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

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

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

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

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

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

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

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

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

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

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

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

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

void	operator delete (void *ptr)
	Operator delete. More...

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

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

void	SetBit (UInt_t f)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

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

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

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

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

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

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

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). More...

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

Protected Member Functions
	TKeyXML ()
	default constructor More...

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

void	StoreObject (const void obj, const TClass cl)
	convert object to xml structure and keep this structure in key More...

void	StoreKeyAttributes ()
	Stores keys attributes in key node. More...

TXMLEngine *	XMLEngine ()
	return pointer on TXMLEngine object, used for xml conversion More...

void *	XmlReadAny (void obj, const TClass expectedClass)
	read object from key and cast to expected class More...

Protected Member Functions inherited from TKey
virtual void	Create (Int_t nbytes, TFile *f=0)
	Create a TKey object of specified size. More...

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

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

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

Protected Member Functions inherited from TObject
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

Protected Attributes
XMLNodePointer_t	fKeyNode

Long64_t	fKeyId
	node with stored object More...

Bool_t	fSubdir
	unique identifier of key for search methods More...

Protected Attributes inherited from TKey
Int_t	fVersion
	Key version identifier. More...

Int_t	fNbytes
	Number of bytes for the object on file. More...

Int_t	fObjlen
	Length of uncompressed object in bytes. More...

TDatime	fDatime
	Date/Time of insertion in file. More...

Short_t	fKeylen
	Number of bytes for the key itself. More...

Short_t	fCycle
	Cycle number. More...

Long64_t	fSeekKey
	Location of object on file. More...

Long64_t	fSeekPdir
	Location of parent directory on file. More...

TString	fClassName
	Object Class name. More...

Int_t	fLeft
	Number of bytes left in current segment. More...

char *	fBuffer
	Object buffer. More...

TBuffer *	fBufferRef
	Pointer to the TBuffer object. More...

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

TDirectory *	fMotherDir
	!pointer to mother directory More...

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Private Member Functions
	TKeyXML (const TKeyXML &)

TKeyXML &	operator= (const TKeyXML &)

Additional Inherited Members
Public Types inherited from TObject
enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

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

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

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

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

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

#include <TKeyXML.h>

Inheritance diagram for TKeyXML:

Collaboration diagram for TKeyXML:

Constructor & Destructor Documentation

TKeyXML::TKeyXML ( const TKeyXML & )

private

TKeyXML::TKeyXML ( )

protected

default constructor

Definition at line 33 of file TKeyXML.cxx.

TKeyXML::TKeyXML	(	TDirectory *	mother,
		Long64_t	keyid,
		const TObject *	obj,
		const char *	name = `0`,
		const char *	title = `0`
	)

Creates TKeyXML and convert obj data to xml structures.

Definition at line 44 of file TKeyXML.cxx.

TKeyXML::TKeyXML	(	TDirectory *	mother,
		Long64_t	keyid,
		const void *	obj,
		const TClass *	cl,
		const char *	name,
		const char *	title = `0`
	)

Creates TKeyXML and convert obj data to xml structures.

Definition at line 75 of file TKeyXML.cxx.

TKeyXML::TKeyXML	(	TDirectory *	mother,
		Long64_t	keyid,
		XMLNodePointer_t	keynode
	)

Creates TKeyXML and takes ownership over xml node, from which object can be restored.

Definition at line 100 of file TKeyXML.cxx.

TKeyXML::~TKeyXML ( )

virtual

TKeyXML destructor.

Definition at line 129 of file TKeyXML.cxx.

Member Function Documentation

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

virtual

Delete key from current directory Note: TKeyXML object is not deleted.

You still have to call "delete key"

Reimplemented from TKey.

Definition at line 146 of file TKeyXML.cxx.

virtual void TKeyXML::DeleteBuffer ( )

inlinevirtual

Delete key buffer(s).

Reimplemented from TKey.

Definition at line 41 of file TKeyXML.h.

virtual void TKeyXML::FillBuffer ( char *& buffer )

inlinevirtual

Encode key header into output buffer.

Reimplemented from TKey.

Definition at line 42 of file TKeyXML.h.

virtual char* TKeyXML::GetBuffer ( ) const

inlinevirtual

Reimplemented from TKey.

Definition at line 43 of file TKeyXML.h.

Long64_t TKeyXML::GetKeyId ( ) const

inline

Definition at line 64 of file TKeyXML.h.

Referenced by TXMLFile::DirCreateEntry(), TXMLFile::FindDirKey(), ReadObj(), and ReadObjWithBuffer().

virtual Long64_t TKeyXML::GetSeekKey ( ) const

inlinevirtual

Reimplemented from TKey.

Definition at line 44 of file TKeyXML.h.

virtual Long64_t TKeyXML::GetSeekPdir ( ) const

inlinevirtual

Reimplemented from TKey.

Definition at line 45 of file TKeyXML.h.

Bool_t TKeyXML::IsSubdir ( ) const

inline

Definition at line 65 of file TKeyXML.h.

virtual void TKeyXML::Keep ( )

inlinevirtual

Set the "KEEP" status.

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

Reimplemented from TKey.

Definition at line 47 of file TKeyXML.h.

XMLNodePointer_t TKeyXML::KeyNode ( ) const

inline

Definition at line 63 of file TKeyXML.h.

Referenced by TXMLFile::DirReadKeys().

TKeyXML& TKeyXML::operator= ( const TKeyXML & )

private

Int_t TKeyXML::Read ( TObject * tobj )

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

Definition at line 244 of file TKeyXML.cxx.

virtual Int_t TKeyXML::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 71 of file TKeyXML.h.

virtual void TKeyXML::ReadBuffer ( char *& buffer )

inlinevirtual

Decode input buffer.

In some situation will add key to gDirectory.

Reimplemented from TKey.

Definition at line 56 of file TKeyXML.h.

virtual Bool_t TKeyXML::ReadFile ( )

inlinevirtual

Read the key structure from the file.

Reimplemented from TKey.

Definition at line 57 of file TKeyXML.h.

TObject * TKeyXML::ReadObj ( )

virtual

read object derived from TObject class, from key if it is not TObject or in case of error, return 0

Reimplemented from TKey.

Definition at line 257 of file TKeyXML.cxx.

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

virtual

read object of any type

Reimplemented from TKey.

Definition at line 308 of file TKeyXML.cxx.

TObject * TKeyXML::ReadObjWithBuffer ( char * bufferRead )

virtual

read object derived from TObject class, from key if it is not TObject or in case of error, return 0

Reimplemented from TKey.

Definition at line 283 of file TKeyXML.cxx.

virtual void TKeyXML::SetBuffer ( )

inlinevirtual

Reimplemented from TKey.

Definition at line 58 of file TKeyXML.h.

void TKeyXML::SetSubir ( )

inline

Definition at line 66 of file TKeyXML.h.

Referenced by TXMLFile::DirCreateEntry().

void TKeyXML::StoreKeyAttributes ( )

protected

Stores keys attributes in key node.

Definition at line 160 of file TKeyXML.cxx.

Referenced by StoreObject(), and UpdateAttributes().

void TKeyXML::StoreObject	(	const void *	obj,
		const TClass *	cl
	)

protected

convert object to xml structure and keep this structure in key

Definition at line 180 of file TKeyXML.cxx.

Referenced by TKeyXML(), and UpdateObject().

void TKeyXML::UpdateAttributes ( )

update key attributes in key node

Definition at line 205 of file TKeyXML.cxx.

Referenced by TXMLFile::DirWriteKeys().

void TKeyXML::UpdateObject ( TObject * obj )

updates object, stored in the node Used for TDirectory data update

Definition at line 219 of file TKeyXML.cxx.

Referenced by TXMLFile::DirWriteHeader().

virtual Int_t TKeyXML::WriteFile	(	Int_t	cycle = `1`,
		TFile *	f = `0`
	)

inlinevirtual

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 59 of file TKeyXML.h.

TXMLEngine * TKeyXML::XMLEngine ( )

protected

return pointer on TXMLEngine object, used for xml conversion

Definition at line 366 of file TKeyXML.cxx.

Referenced by Delete(), StoreKeyAttributes(), StoreObject(), TKeyXML(), UpdateAttributes(), UpdateObject(), XmlReadAny(), and ~TKeyXML().

void * TKeyXML::XmlReadAny	(	void *	obj,
		const TClass *	expectedClass
	)

protected

read object from key and cast to expected class

Definition at line 316 of file TKeyXML.cxx.

Referenced by Read(), ReadObj(), ReadObjectAny(), and ReadObjWithBuffer().

Member Data Documentation

Long64_t TKeyXML::fKeyId

protected

node with stored object

Definition at line 79 of file TKeyXML.h.

Referenced by GetKeyId().

XMLNodePointer_t TKeyXML::fKeyNode

protected

Definition at line 78 of file TKeyXML.h.

Referenced by Delete(), GetSeekKey(), GetSeekPdir(), KeyNode(), StoreKeyAttributes(), StoreObject(), TKeyXML(), UpdateAttributes(), UpdateObject(), XmlReadAny(), and ~TKeyXML().

Bool_t TKeyXML::fSubdir

protected

unique identifier of key for search methods

Definition at line 80 of file TKeyXML.h.

Referenced by IsSubdir(), ReadObj(), ReadObjWithBuffer(), and SetSubir().

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

io/xml/inc/TKeyXML.h
io/xml/src/TKeyXML.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation