Logo ROOT  
Reference Guide
TKeyXML Class Referencefinal

Definition at line 20 of file TKeyXML.h.

Public Member Functions

 TKeyXML (TDirectory *mother, Long64_t keyid, const TObject *obj, const char *name=nullptr, const char *title=nullptr)
 Creates TKeyXML and convert object data to xml structures. More...
 
 TKeyXML (TDirectory *mother, Long64_t keyid, const void *obj, const TClass *cl, const char *name, const char *title=nullptr)
 Creates TKeyXML and convert object 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...
 
void Delete (Option_t *option="") final
 Delete key from current directory Note: TKeyXML object is not deleted. More...
 
void DeleteBuffer () final
 Delete key buffer(s). More...
 
void FillBuffer (char *&) final
 Encode key header into output buffer. More...
 
char * GetBuffer () const final
 
Long64_t GetKeyId () const
 
Long64_t GetSeekKey () const final
 
Long64_t GetSeekPdir () const final
 
Bool_t IsSubdir () const
 
void Keep () final
 Set the "KEEP" status. More...
 
XMLNodePointer_t KeyNode () const
 
Int_t Read (TObject *tobj) final
 To read an object from the file. More...
 
void ReadBuffer (char *&) final
 Decode input buffer. More...
 
Bool_t ReadFile () final
 Read the key structure from the file. More...
 
TObjectReadObj () final
 read object derived from TObject class, from key if it is not TObject or in case of error, return nullptr More...
 
voidReadObjectAny (const TClass *expectedClass) final
 read object of any type More...
 
TObjectReadObjWithBuffer (char *bufferRead) final
 read object derived from TObject class, from key if it is not TObject or in case of error, return nullptr More...
 
void SetBuffer () final
 
void SetSubir ()
 
void UpdateAttributes ()
 update key attributes in key node More...
 
void UpdateObject (TObject *obj)
 updates object, stored in the node Used for TDirectory data update More...
 
Int_t WriteFile (Int_t=1, TFile *=nullptr) final
 Write the encoded object supported by this key. More...
 
- Public Member Functions inherited from TKey
 TKey ()
 TKey default constructor. 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 TObject *obj, const char *name, Int_t bufsize, TDirectory *motherDir)
 Create a TKey object for a TObject* and fill output buffer. 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 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...
 
 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...
 
virtual ~TKey ()
 TKey default destructor. More...
 
virtual void Browse (TBrowser *b)
 Read object from disk and call its Browse() method. More...
 
TBufferGetBufferRef () const
 
virtual const char * GetClassName () const
 
Short_t GetCycle () const
 Return cycle number associated to this key. More...
 
const TDatimeGetDatime () const
 
TFileGetFile () const
 Returns file to which key belong. More...
 
virtual const char * GetIconName () const
 Title can keep 32x32 xpm thumbnail/icon of the parent object. More...
 
Short_t GetKeep () const
 Returns the "KEEP" status. More...
 
Int_t GetKeylen () const
 
TDirectoryGetMotherDir () const
 
Int_t GetNbytes () const
 
Int_t GetObjlen () const
 
virtual const char * GetTitle () const
 Returns title (title can contain 32x32 xpm thumbnail/icon). More...
 
Int_t GetVersion () const
 
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 (Bool_t current) const
 List Key contents. 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...
 
template<typename T >
T * ReadObject ()
 To read an object (non deriving from TObject) from the file. More...
 
void SetMotherDir (TDirectory *dir)
 
virtual void SetParent (const TObject *parent)
 Set parent in key buffer. More...
 
virtual Int_t Sizeof () const
 Return the size in bytes of the key header structure. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (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 ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
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. 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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
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...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Member Functions

 TKeyXML ()
 
Int_t Read (const char *name) final
 Read contents of object with specified name from the current directory. More...
 
void StoreKeyAttributes ()
 Stores keys attributes in key node. More...
 
void StoreObject (const void *obj, const TClass *cl, Bool_t check_tobj=kFALSE)
 convert object to xml structure and keep this structure in key More...
 
TXMLEngineXMLEngine ()
 return pointer on TXMLEngine object, used for xml conversion More...
 
voidXmlReadAny (void *obj, const TClass *expectedClass)
 read object from key and cast to expected class More...
 
- 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. More...
 
virtual void Create (Int_t nbytes, TFile *f=0)
 Create a TKey object of specified size. More...
 
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
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

Long64_t fKeyId {0}
 node with stored object More...
 
XMLNodePointer_t fKeyNode {nullptr}
 
Bool_t fSubdir {kFALSE}
 unique identifier of key for search methods More...
 
- Protected Attributes inherited from TKey
char * fBuffer
 Object buffer. More...
 
TBufferfBufferRef
 Pointer to the TBuffer object. More...
 
TString fClassName
 Object Class name. More...
 
Short_t fCycle
 Cycle number. More...
 
TDatime fDatime
 Date/Time of insertion in file. More...
 
Short_t fKeylen
 Number of bytes for the key itself. More...
 
Int_t fLeft
 Number of bytes left in current segment. More...
 
TDirectoryfMotherDir
 !pointer to mother directory More...
 
Int_t fNbytes
 Number of bytes for the object on file. More...
 
Int_t fObjlen
 Length of uncompressed object in bytes. 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...
 
Long64_t fSeekKey
 Location of object on file. More...
 
Long64_t fSeekPdir
 Location of parent directory on file. More...
 
Int_t fVersion
 Key version identifier. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Member Functions

 TKeyXML (const TKeyXML &)=delete
 
TKeyXMLoperator= (const TKeyXML &)=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 Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only 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:
[legend]

Constructor & Destructor Documentation

◆ TKeyXML() [1/5]

TKeyXML::TKeyXML ( const TKeyXML )
privatedelete

◆ TKeyXML() [2/5]

TKeyXML::TKeyXML ( )
inlineprotected

Definition at line 27 of file TKeyXML.h.

◆ TKeyXML() [3/5]

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

Creates TKeyXML and convert object data to xml structures.

Definition at line 31 of file TKeyXML.cxx.

◆ TKeyXML() [4/5]

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

Creates TKeyXML and convert object data to xml structures.

Definition at line 59 of file TKeyXML.cxx.

◆ TKeyXML() [5/5]

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 85 of file TKeyXML.cxx.

◆ ~TKeyXML()

TKeyXML::~TKeyXML ( )
virtual

TKeyXML destructor.

Definition at line 111 of file TKeyXML.cxx.

Member Function Documentation

◆ Delete()

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

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

You still have to call "delete key"

Reimplemented from TKey.

Definition at line 128 of file TKeyXML.cxx.

◆ DeleteBuffer()

void TKeyXML::DeleteBuffer ( )
inlinefinalvirtual

Delete key buffer(s).

Reimplemented from TKey.

Definition at line 39 of file TKeyXML.h.

◆ FillBuffer()

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

Encode key header into output buffer.

Reimplemented from TKey.

Definition at line 40 of file TKeyXML.h.

◆ GetBuffer()

char* TKeyXML::GetBuffer ( ) const
inlinefinalvirtual

Reimplemented from TKey.

Definition at line 41 of file TKeyXML.h.

◆ GetKeyId()

Long64_t TKeyXML::GetKeyId ( ) const
inline

Definition at line 62 of file TKeyXML.h.

◆ GetSeekKey()

Long64_t TKeyXML::GetSeekKey ( ) const
inlinefinalvirtual

Reimplemented from TKey.

Definition at line 42 of file TKeyXML.h.

◆ GetSeekPdir()

Long64_t TKeyXML::GetSeekPdir ( ) const
inlinefinalvirtual

Reimplemented from TKey.

Definition at line 43 of file TKeyXML.h.

◆ IsSubdir()

Bool_t TKeyXML::IsSubdir ( ) const
inline

Definition at line 63 of file TKeyXML.h.

◆ Keep()

void TKeyXML::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 45 of file TKeyXML.h.

◆ KeyNode()

XMLNodePointer_t TKeyXML::KeyNode ( ) const
inline

Definition at line 61 of file TKeyXML.h.

◆ operator=()

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

◆ Read() [1/2]

Int_t TKeyXML::Read ( const char *  name)
inlinefinalprotectedvirtual

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

◆ Read() [2/2]

Int_t TKeyXML::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 245 of file TKeyXML.cxx.

◆ ReadBuffer()

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

Decode input buffer.

In some situation will add key to gDirectory.

Reimplemented from TKey.

Definition at line 54 of file TKeyXML.h.

◆ ReadFile()

Bool_t TKeyXML::ReadFile ( )
inlinefinalvirtual

Read the key structure from the file.

Reimplemented from TKey.

Definition at line 55 of file TKeyXML.h.

◆ ReadObj()

TObject * TKeyXML::ReadObj ( )
finalvirtual

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

Reimplemented from TKey.

Definition at line 259 of file TKeyXML.cxx.

◆ ReadObjectAny()

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

read object of any type

Reimplemented from TKey.

Definition at line 312 of file TKeyXML.cxx.

◆ ReadObjWithBuffer()

TObject * TKeyXML::ReadObjWithBuffer ( char *  bufferRead)
finalvirtual

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

Reimplemented from TKey.

Definition at line 286 of file TKeyXML.cxx.

◆ SetBuffer()

void TKeyXML::SetBuffer ( )
inlinefinalvirtual

Reimplemented from TKey.

Definition at line 56 of file TKeyXML.h.

◆ SetSubir()

void TKeyXML::SetSubir ( )
inline

Definition at line 64 of file TKeyXML.h.

◆ StoreKeyAttributes()

void TKeyXML::StoreKeyAttributes ( )
protected

Stores keys attributes in key node.

Definition at line 142 of file TKeyXML.cxx.

◆ StoreObject()

void TKeyXML::StoreObject ( const void obj,
const TClass cl,
Bool_t  check_tobj = kFALSE 
)
protected

convert object to xml structure and keep this structure in key

Definition at line 166 of file TKeyXML.cxx.

◆ UpdateAttributes()

void TKeyXML::UpdateAttributes ( )

update key attributes in key node

Definition at line 203 of file TKeyXML.cxx.

◆ UpdateObject()

void TKeyXML::UpdateObject ( TObject obj)

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

Definition at line 218 of file TKeyXML.cxx.

◆ WriteFile()

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

◆ XMLEngine()

TXMLEngine * TKeyXML::XMLEngine ( )
protected

return pointer on TXMLEngine object, used for xml conversion

Definition at line 389 of file TKeyXML.cxx.

◆ XmlReadAny()

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

read object from key and cast to expected class

Definition at line 334 of file TKeyXML.cxx.

Member Data Documentation

◆ fKeyId

Long64_t TKeyXML::fKeyId {0}
protected

node with stored object

Definition at line 77 of file TKeyXML.h.

◆ fKeyNode

XMLNodePointer_t TKeyXML::fKeyNode {nullptr}
protected

Definition at line 76 of file TKeyXML.h.

◆ fSubdir

Bool_t TKeyXML::fSubdir {kFALSE}
protected

unique identifier of key for search methods

Definition at line 78 of file TKeyXML.h.

Libraries for TKeyXML:
[legend]

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