Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

class TKeyXML: public TKey


 TKeyXML is represents one block of data in TXMLFile
 Normally this block corresponds to data of single object like histogram,
 TObjArray and so on.

Function Members (Methods)

public:

	TKeyXML(TDirectory* mother, Long64_t keyid, XMLNodePointer_t keynode)
	TKeyXML(TDirectory* mother, Long64_t keyid, const TObject* obj, const char* name = 0, const char* title = 0)
	TKeyXML(TDirectory* mother, Long64_t keyid, const void* obj, const TClass* cl, const char* name, const char* title = 0)
virtual	~TKeyXML()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TKey::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
virtual void	TNamed::Copy(TObject& named) const
virtual void	Delete(Option_t* option = "")
virtual void	DeleteBuffer()
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual void	FillBuffer(char*&)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual char*	GetBuffer() const
TBuffer*	TKey::GetBufferRef() const
virtual const char*	TKey::GetClassName() const
Short_t	TKey::GetCycle() const
const TDatime&	TKey::GetDatime() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
TFile*	TKey::GetFile() const
virtual const char*	TKey::GetIconName() const
Short_t	TKey::GetKeep() const
Long64_t	GetKeyId() const
Int_t	TKey::GetKeylen() const
TDirectory*	TKey::GetMotherDir() const
virtual const char*	TNamed::GetName() const
Int_t	TKey::GetNbytes() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
Int_t	TKey::GetObjlen() const
virtual Option_t*	TObject::GetOption() const
virtual Long64_t	GetSeekKey() const
virtual Long64_t	GetSeekPdir() const
virtual const char*	TKey::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
Int_t	TKey::GetVersion() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TKey::Hash() const
virtual void	TKey::IncrementPidOffset(UShort_t offset)
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TKey::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	IsSubdir() const
Bool_t	TObject::IsZombie() const
virtual void	Keep()
XMLNodePointer_t	KeyNode() const
virtual void	TKey::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TKey::Print(Option_t* option = "") const
virtual Int_t	Read(TObject* tobj)
virtual void	ReadBuffer(char*&)
virtual Bool_t	ReadFile()
void	TKey::ReadKeyBuffer(char*& buffer)
virtual TObject*	ReadObj()
virtual void*	ReadObjectAny(const TClass* expectedClass)
virtual TObject*	ReadObjWithBuffer(char* bufferRead)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	SetBuffer()
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	TKey::SetMotherDir(TDirectory* dir)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
virtual void	TKey::SetParent(const TObject* parent)
void	SetSubir()
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector&)
virtual Int_t	TKey::Sizeof() const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
void	UpdateAttributes()
void	UpdateObject(TObject* obj)
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual Int_t	WriteFile(Int_t = 1, TFile* = 0)

protected:

	TKeyXML()
void	TKey::Build(TDirectory* motherDir, const char* classname, Long64_t filepos)
virtual void	TKey::Create(Int_t nbytes, TFile* f = 0)
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()
virtual Int_t	Read(const char* name)
virtual void	TKey::Reset()
void	StoreKeyAttributes()
void	StoreObject(const void* obj, const TClass* cl)
virtual Int_t	TKey::WriteFileKeepBuffer(TFile* f = 0)
TXMLEngine*	XMLEngine()
void*	XmlReadAny(void* obj, const TClass* expectedClass)

private:

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

Data Members

public:

enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

protected:

char*	TKey::fBuffer	Object buffer
TBuffer*	TKey::fBufferRef	Pointer to the TBuffer object
TString	TKey::fClassName	Object Class name
Short_t	TKey::fCycle	Cycle number
TDatime	TKey::fDatime	Date/Time of insertion in file
Long64_t	fKeyId	! unique identifier of key for search methods
XMLNodePointer_t	fKeyNode	! node with stored object
Short_t	TKey::fKeylen	Number of bytes for the key itself
Int_t	TKey::fLeft	Number of bytes left in current segment
TDirectory*	TKey::fMotherDir	! pointer to mother directory
TString	TNamed::fName	object identifier
Int_t	TKey::fNbytes	Number of bytes for the object on file
Int_t	TKey::fObjlen	Length of uncompressed object in bytes
UShort_t	TKey::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	TKey::fSeekKey	Location of object on file
Long64_t	TKey::fSeekPdir	Location of parent directory on file
Bool_t	fSubdir	! indicates that key contains subdirectory
TString	TNamed::fTitle	object title
Int_t	TKey::fVersion	Key version identifier

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TKeyXML()

 default constructor

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

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

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

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

~TKeyXML()

 TKeyXML destructor

void Delete(Option_t* option = "")

 Delete key from current directory
 Note: TKeyXML object is not deleted. You still have to call "delete key"

void StoreKeyAttributes()

 Stores keys attributes in key node

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

  convert object to xml structure and keep this structure in key

void UpdateAttributes()

 update key attributes in key node

void UpdateObject(TObject* obj)

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

Int_t Read(TObject* tobj)

 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.

TObject* ReadObj()

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

TObject* ReadObjWithBuffer(char* bufferRead)

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

void* ReadObjectAny(const TClass* expectedClass)

 read object of any type

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

 read object from key and cast to expected class

TXMLEngine* XMLEngine()

 return pointer on TXMLEngine object, used for xml conversion

TKeyXML(const TKeyXML& )

TKeyXML& operator=(const TKeyXML& )

void DeleteBuffer()

{}

void FillBuffer(char*& )

{}

char * GetBuffer() const

{ return 0; }

Long64_t GetSeekKey() const

{ return fKeyNode ? 1024 : 0;}

Long64_t GetSeekPdir() const

virtual ULong_t   Hash() const { return 0; }

{ return fKeyNode ? 1024 : 0;}

void Keep()

virtual void      ls(Option_t* ="") const;
virtual void      Print(Option_t* ="") const {}

{}

Int_t Read(TObject* tobj)

void ReadBuffer(char*& )

{}

Bool_t ReadFile()

{ return kTRUE; }

void SetBuffer()

{ fBuffer = 0; }

Int_t WriteFile(Int_t = 1, TFile* = 0)

{ return 0; }

XMLNodePointer_t KeyNode() const

 TKeyXML specific methods

{ return fKeyNode; }

Long64_t GetKeyId() const

{ return fKeyId; }

Bool_t IsSubdir() const

{ return fSubdir; }

void SetSubir()

{ fSubdir = kTRUE; }