Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TClassDocInfo Class Reference

Definition at line 29 of file TDocInfo.h.

Public Member Functions

 TClassDocInfo (TClass *cl, const char *htmlfilename="", const char *fsdecl="", const char *fsimpl="", const char *decl=0, const char *impl=0)
 
 TClassDocInfo (TDictionary *cl, const char *htmlfilename="", const char *fsdecl="", const char *fsimpl="", const char *decl=0, const char *impl=0)
 
 ~TClassDocInfo () override
 
Int_t Compare (const TObject *obj) const override
 Compare abstract method.
 
TDictionaryGetClass () const
 
const char * GetDeclFileName () const
 
const char * GetDeclFileSysName () const
 
const char * GetHtmlFileName () const
 
const char * GetImplFileName () const
 
const char * GetImplFileSysName () const
 
TListGetListOfTypedefs ()
 
TModuleDocInfoGetModule () const
 
const char * GetName () const override
 Returns name of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t HaveSource () const
 
TClassIsA () const override
 
Bool_t IsSelected () const
 
Bool_t IsSortable () const override
 
void SetDeclFileName (const char *name)
 
void SetDeclFileSysName (const char *fsname)
 
void SetHtmlFileName (const char *name)
 
void SetImplFileName (const char *name)
 
void SetImplFileSysName (const char *fsname)
 
void SetModule (TModuleDocInfo *module)
 
void SetSelected (Bool_t sel=kTRUE)
 
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
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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 void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
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).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
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)
 
TObjectoperator= (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 Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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.
 

Private Member Functions

 TClassDocInfo ()
 

Private Attributes

TDictionaryfClass
 
TString fDeclFileName
 
TString fDeclFileSysName
 
TString fHtmlFileName
 
TString fImplFileName
 
TString fImplFileSysName
 
TModuleDocInfofModule
 
Bool_t fSelected
 
TList fTypedefs
 

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 TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

#include <TDocInfo.h>

Inheritance diagram for TClassDocInfo:
[legend]

Constructor & Destructor Documentation

◆ TClassDocInfo() [1/3]

TClassDocInfo::TClassDocInfo ( TClass cl,
const char *  htmlfilename = "",
const char *  fsdecl = "",
const char *  fsimpl = "",
const char *  decl = 0,
const char *  impl = 0 
)
inline

Definition at line 32 of file TDocInfo.h.

◆ TClassDocInfo() [2/3]

TClassDocInfo::TClassDocInfo ( TDictionary cl,
const char *  htmlfilename = "",
const char *  fsdecl = "",
const char *  fsimpl = "",
const char *  decl = 0,
const char *  impl = 0 
)
inline

Definition at line 42 of file TDocInfo.h.

◆ ~TClassDocInfo()

TClassDocInfo::~TClassDocInfo ( )
inlineoverride

Definition at line 52 of file TDocInfo.h.

◆ TClassDocInfo() [3/3]

TClassDocInfo::TClassDocInfo ( )
private

Member Function Documentation

◆ Class()

static TClass * TClassDocInfo::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TClassDocInfo::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TClassDocInfo::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 100 of file TDocInfo.h.

◆ Compare()

Int_t TClassDocInfo::Compare ( const TObject obj) const
overridevirtual

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented from TObject.

Definition at line 37 of file TDocInfo.cxx.

◆ DeclFileName()

static const char * TClassDocInfo::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 100 of file TDocInfo.h.

◆ GetClass()

TDictionary * TClassDocInfo::GetClass ( ) const
inline

Definition at line 58 of file TDocInfo.h.

◆ GetDeclFileName()

const char * TClassDocInfo::GetDeclFileName ( ) const
inline

Definition at line 61 of file TDocInfo.h.

◆ GetDeclFileSysName()

const char * TClassDocInfo::GetDeclFileSysName ( ) const
inline

Definition at line 63 of file TDocInfo.h.

◆ GetHtmlFileName()

const char * TClassDocInfo::GetHtmlFileName ( ) const
inline

Definition at line 60 of file TDocInfo.h.

◆ GetImplFileName()

const char * TClassDocInfo::GetImplFileName ( ) const
inline

Definition at line 62 of file TDocInfo.h.

◆ GetImplFileSysName()

const char * TClassDocInfo::GetImplFileSysName ( ) const
inline

Definition at line 64 of file TDocInfo.h.

◆ GetListOfTypedefs()

TList & TClassDocInfo::GetListOfTypedefs ( )
inline

Definition at line 82 of file TDocInfo.h.

◆ GetModule()

TModuleDocInfo * TClassDocInfo::GetModule ( ) const
inline

Definition at line 67 of file TDocInfo.h.

◆ GetName()

const char * TClassDocInfo::GetName ( ) const
overridevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 25 of file TDocInfo.cxx.

◆ Hash()

ULong_t TClassDocInfo::Hash ( ) const
overridevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:395

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
ULong_t Hash() const override
Return hash value for this object.
Definition TDocInfo.cxx:31
Mother of all ROOT objects.
Definition TObject.h:41
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:993
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2498

Reimplemented from TObject.

Definition at line 31 of file TDocInfo.cxx.

◆ HaveSource()

Bool_t TClassDocInfo::HaveSource ( ) const
inline

Definition at line 71 of file TDocInfo.h.

◆ IsA()

TClass * TClassDocInfo::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 100 of file TDocInfo.h.

◆ IsSelected()

Bool_t TClassDocInfo::IsSelected ( ) const
inline

Definition at line 70 of file TDocInfo.h.

◆ IsSortable()

Bool_t TClassDocInfo::IsSortable ( ) const
inlineoverridevirtual

Reimplemented from TObject.

Definition at line 84 of file TDocInfo.h.

◆ SetDeclFileName()

void TClassDocInfo::SetDeclFileName ( const char *  name)
inline

Definition at line 75 of file TDocInfo.h.

◆ SetDeclFileSysName()

void TClassDocInfo::SetDeclFileSysName ( const char *  fsname)
inline

Definition at line 77 of file TDocInfo.h.

◆ SetHtmlFileName()

void TClassDocInfo::SetHtmlFileName ( const char *  name)
inline

Definition at line 74 of file TDocInfo.h.

◆ SetImplFileName()

void TClassDocInfo::SetImplFileName ( const char *  name)
inline

Definition at line 76 of file TDocInfo.h.

◆ SetImplFileSysName()

void TClassDocInfo::SetImplFileSysName ( const char *  fsname)
inline

Definition at line 78 of file TDocInfo.h.

◆ SetModule()

void TClassDocInfo::SetModule ( TModuleDocInfo module)
inline

Definition at line 66 of file TDocInfo.h.

◆ SetSelected()

void TClassDocInfo::SetSelected ( Bool_t  sel = kTRUE)
inline

Definition at line 69 of file TDocInfo.h.

◆ Streamer()

void TClassDocInfo::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TClassDocInfo::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 100 of file TDocInfo.h.

Member Data Documentation

◆ fClass

TDictionary* TClassDocInfo::fClass
private

Definition at line 90 of file TDocInfo.h.

◆ fDeclFileName

TString TClassDocInfo::fDeclFileName
private

Definition at line 93 of file TDocInfo.h.

◆ fDeclFileSysName

TString TClassDocInfo::fDeclFileSysName
private

Definition at line 95 of file TDocInfo.h.

◆ fHtmlFileName

TString TClassDocInfo::fHtmlFileName
private

Definition at line 92 of file TDocInfo.h.

◆ fImplFileName

TString TClassDocInfo::fImplFileName
private

Definition at line 94 of file TDocInfo.h.

◆ fImplFileSysName

TString TClassDocInfo::fImplFileSysName
private

Definition at line 96 of file TDocInfo.h.

◆ fModule

TModuleDocInfo* TClassDocInfo::fModule
private

Definition at line 91 of file TDocInfo.h.

◆ fSelected

Bool_t TClassDocInfo::fSelected
private

Definition at line 98 of file TDocInfo.h.

◆ fTypedefs

TList TClassDocInfo::fTypedefs
private

Definition at line 97 of file TDocInfo.h.

  • html/inc/TDocInfo.h
  • html/src/TDocInfo.cxx