ROOT 6.08/07 Reference Guide |
TKeySQL represents metainforamtion about object, which was written to SQL database.
It keeps object id, which used to locate object data from database tables.
Public Member Functions | |
TKeySQL (TDirectory *mother, const TObject *obj, const char *name, const char *title=0) | |
Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2. More... | |
TKeySQL (TDirectory *mother, const void *obj, const TClass *cl, const char *name, const char *title=0) | |
Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2. More... | |
TKeySQL (TDirectory *mother, Long64_t keyid, Long64_t objid, const char *name, const char *title, const char *keydatetime, Int_t cycle, const char *classname) | |
Create TKeySQL object, which correponds to single entry in keys table. More... | |
virtual | ~TKeySQL () |
TKeySQL destructor. More... | |
virtual void | Delete (Option_t *option="") |
Removes key from current directory Note: TKeySQL 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 |
Long64_t | GetDBDirId () const |
return sql id of parent directory More... | |
Long64_t | GetDBKeyId () const |
Long64_t | GetDBObjId () const |
virtual Long64_t | GetSeekKey () const |
virtual Long64_t | GetSeekPdir () const |
Bool_t | IsKeyModified (const char *keyname, const char *keytitle, const char *keydatime, Int_t cycle, const char *classname) |
Compares keydata with provided and return kTRUE if key was modified Used in TFile::StreamKeysForDirectory() method to verify data for that keys should be updated. More... | |
virtual void | Keep () |
Set the "KEEP" status. More... | |
virtual Int_t | Read (TObject *obj) |
To read an object from the file. More... | |
virtual void | ReadBuffer (char *&) |
Decode input buffer. More... | |
virtual Bool_t | ReadFile () |
Read the key structure from the file. More... | |
virtual TObject * | ReadObj () |
Read object derived from TObject class If it is not TObject or in case of error, return 0. More... | |
virtual void * | ReadObjectAny (const TClass *expectedClass) |
Read object of any type from SQL database. More... | |
virtual TObject * | ReadObjWithBuffer (char *bufferRead) |
Read object derived from TObject class If it is not TObject or in case of error, return 0. More... | |
virtual void | SetBuffer () |
virtual Int_t | WriteFile (Int_t=1, TFile *=0) |
Write the encoded object supported by this key. More... | |
Public Member Functions inherited from TKey | |
TKey () | |
TKey default constructor. 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... | |
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... | |
TBuffer * | GetBufferRef () const |
virtual const char * | GetClassName () 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... | |
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 |
TDirectory * | GetMotherDir () 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 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... | |
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 TString &name, const TString &title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. 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 |
TNamed & | operator= (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... | |
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 | 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 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 char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () 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... | |
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... | |
Bool_t | IsOnHeap () const |
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... | |
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. 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, Bool_t set) |
Set or unset the user status bits as specified in f. More... | |
void | SetBit (UInt_t f) |
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... | |
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 | |
TKeySQL () | |
default constructor More... | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. More... | |
void * | ReadKeyObject (void *obj, const TClass *expectedClass) |
Read object, associated with key, from database. More... | |
void | StoreKeyObject (const void *obj, const TClass *cl) |
Stores object, associated with key, into data tables. 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... | |
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 | |
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 |
! key identifier in KeysTables More... | |
Long64_t | fObjId |
! stored object identifer More... | |
Protected Attributes inherited from TKey | |
char * | fBuffer |
Object buffer. More... | |
TBuffer * | fBufferRef |
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... | |
TDirectory * | fMotherDir |
!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 | |
TKeySQL (const TKeySQL &) | |
TKeySQL & | operator= (const TKeySQL &) |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
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) } |
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 <TKeySQL.h>
|
private |
|
protected |
default constructor
Definition at line 40 of file TKeySQL.cxx.
TKeySQL::TKeySQL | ( | TDirectory * | mother, |
const TObject * | obj, | ||
const char * | name, | ||
const char * | title = 0 |
||
) |
Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2.
Definition at line 50 of file TKeySQL.cxx.
TKeySQL::TKeySQL | ( | TDirectory * | mother, |
const void * | obj, | ||
const TClass * | cl, | ||
const char * | name, | ||
const char * | title = 0 |
||
) |
Creates TKeySQL and convert obj data to TSQLStructure via TBufferSQL2.
Definition at line 67 of file TKeySQL.cxx.
TKeySQL::TKeySQL | ( | TDirectory * | mother, |
Long64_t | keyid, | ||
Long64_t | objid, | ||
const char * | name, | ||
const char * | title, | ||
const char * | keydatetime, | ||
Int_t | cycle, | ||
const char * | classname | ||
) |
Create TKeySQL object, which correponds to single entry in keys table.
Definition at line 83 of file TKeySQL.cxx.
|
virtual |
TKeySQL destructor.
Definition at line 101 of file TKeySQL.cxx.
Removes key from current directory Note: TKeySQL object is not deleted.
You still have to call "delete key"
Reimplemented from TKey.
Definition at line 142 of file TKeySQL.cxx.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Long64_t TKeySQL::GetDBDirId | ( | ) | const |
return sql id of parent directory
Definition at line 155 of file TKeySQL.cxx.
|
inlinevirtual |
|
inlinevirtual |
Bool_t TKeySQL::IsKeyModified | ( | const char * | keyname, |
const char * | keytitle, | ||
const char * | keydatime, | ||
Int_t | cycle, | ||
const char * | classname | ||
) |
Compares keydata with provided and return kTRUE if key was modified Used in TFile::StreamKeysForDirectory() method to verify data for that keys should be updated.
Definition at line 110 of file TKeySQL.cxx.
|
inlinevirtual |
|
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.
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 198 of file TKeySQL.cxx.
|
inlinevirtual |
|
inlinevirtual |
Read object, associated with key, from database.
Definition at line 266 of file TKeySQL.cxx.
|
virtual |
Read object derived from TObject class If it is not TObject or in case of error, return 0.
Reimplemented from TKey.
Definition at line 211 of file TKeySQL.cxx.
Read object of any type from SQL database.
Reimplemented from TKey.
Definition at line 258 of file TKeySQL.cxx.
|
virtual |
Read object derived from TObject class If it is not TObject or in case of error, return 0.
Reimplemented from TKey.
Definition at line 235 of file TKeySQL.cxx.
|
inlinevirtual |
Stores object, associated with key, into data tables.
Definition at line 163 of file TKeySQL.cxx.
|
protected |
|
protected |