Logo ROOT   6.11/03
Reference Guide
List of all members | Public Member Functions | Protected Attributes | List of all members
TNamed Class Reference

The TNamed class is the base class for all named ROOT classes.

A TNamed contains the essential elements (name, title) to identify a derived object in containers, directories and files. Most member functions defined in this base class are in general overridden by the derived classes.

Definition at line 29 of file TNamed.h.

Public Member Functions

 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 ()
 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 void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. 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...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. 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 void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Checked and record whether for 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 void Delete (Option_t *option="")
 Delete this object. 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 const char * GetIconName () const
 Returns mime type name of 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). 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 Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. 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...
 
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 Attributes

TString fName
 
TString fTitle
 

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

#include <TNamed.h>

Inherits TObject.

Inherited by fileDesc, MonitoredTFileSummary, RooAbsArg, RooAbsBinning, RooAbsData, RooAbsDataStore, RooAbsGenContext, RooAbsMCStudyModule, RooAbsNumGenerator, RooAbsStudy, RooArgProxy, RooClassFactory, RooCmdArg, RooCustomizer, RooDouble, RooFactoryWSTool, RooFitResult, RooInt, RooMapCatEntry, RooMCStudy, RooNameReg, RooPlot, RooSimWSTool, RooSimWSTool::SplitRule, RooStats::BayesianCalculator, RooStats::ConfidenceBelt, RooStats::ConfInterval, RooStats::HistFactory::Measurement, RooStats::HLFactory, RooStats::HybridCalculatorOriginal, RooStats::HybridPlot, RooStats::HypoTestInverterOriginal, RooStats::HypoTestInverterPlot, RooStats::HypoTestResult, RooStats::LikelihoodIntervalPlot, RooStats::MarkovChain, RooStats::MCMCCalculator, RooStats::MCMCIntervalPlot, RooStats::ModelConfig, RooStats::SamplingDistPlot, RooStats::SamplingDistribution, RooStats::SPlot, RooStats::ToyMCPayload, RooStudyManager, RooStudyPackage, ROOT::Internal::TBranchDescriptor, ROOT::Internal::TBranchProxyClassDescriptor, ROOT::Internal::TBranchProxyDescriptor, ROOT::Internal::TFriendProxyDescriptor, ROOT::Internal::THnBaseBrowsable, ROOT::TSchemaRule::TSources, ROOT::v5::TFormula, ROOT::v5::TFormulaPrimitive, RooTable, RooTObjWrap, RooUnitTest, RooWorkspace, TAlienDirectory, TAlienDirectoryEntry, TApplicationRemote::TARFileStat, TAttParticle, TAutoBinVal, TAxis, TAxis3D, TBenchmark, TBranch, TBrowser, TBrowserObject, TBrowserPlugin, TChainElement, TClassTree, TColor, TColorWheel, TContextMenu, TControlBarButton, TCut, TDatabasePDG, TDataSet, TDictionary, TDirectory, TDocDirective, TDSet, TDSetElement, TEfficiency, TEntryList, TEveArrow, TEveCaloData, TEveCaloViz, TEveDigitSet, TEveElementList, TEveGeoShapeExtract, TEventIterTree::TFileTree, TEventList, TEveParamList, TEvePointSetArray, TEveProjectionAxes, TEveSceneInfo, TEveStraightLineSet, TEveText, TExec, TF1, TFileCollection, TFileDrawMap, TFileInfo, TFileInfoMeta, TFileOpenHandle, TFileStager, TFitResult, TFITSHDU, TFolder, TFormula, TFriendElement, TGenerator, TGeoElement, TGeoIsotope, TGeoManager, TGeoMaterial, TGeoMatrix, TGeoMedium, TGeometry, TGeoNode, TGeoOverlap, TGeoParallelWorld, TGeoPhysicalNode, TGeoPNEntry, TGeoRegion, TGeoRegionCut, TGeoShape, TGeoVolume, TGEventHandler, TGFont, TGL5DDataSet, TGLManager, TGLParametricEquation, TGLTH3Slice, TGraph, TGraph2D, TGraphDelaunay, TGraphDelaunay2D, TGraphNode, TGraphPolargram, TGraphSmooth, TGraphTime, TGridJobStatus, TGuiBldAction, TGuiFactory, TH1, THbookFile, THbookKey, THnBase, THStack, THttpEngine, THttpServer, THttpWSEngine, THttpWSHandler, TImage, TInterpreter, TKDE, TKey, TKeyMapFile, TLDAPAttribute, TLeaf, TLibraryDocInfo, TMacro, TMaterial, TMessageHandler, TMinuit, TMinuit2TraceObject, TModuleDocInfo, TMonaLisaText, TMonaLisaValue, TMultiDimFit, TMultiGraph, TMVA::ClassInfo, TMVA::Configurable, TMVA::DataSet, TMVA::MethodInfo, TMVA::VariableInfo, TNeuron, TNode, TPackMgr, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticleClassPDG, TParticlePDG, TPie, TPieSlice, TPrincipal, TProcessID, TProof, TProofDesc, TProofLockPath, TProofLog, TProofLogElem, TProofMgr, TProofMonSender, TProofMonSender::TDSetPlet, TProofOutputFile, TProofPerfAnalysis, TProofPerfAnalysis::TFileInfo, TProofPerfAnalysis::TPackInfo, TProofPerfAnalysis::TWrkInfo, TProofPerfAnalysis::TWrkInfoFile, TProofVectorContainer< T >, TProofVectorContainer< TProofDrawListOfGraphs::Point3D_t >, TProofVectorContainer< TProofDrawListOfPolyMarkers3D::Point4D_t >, TProtoClass, TQueryResult, TRandom, TRemoteObject, TRootSniffer, TRotMatrix, TShape, TSocket, TSpectrum, TSpectrum2, TSpectrum2Fit, TSpectrum2Painter, TSpectrum3, TSpectrumFit, TSpectrumTransform, TSpline, TSQLColumnInfo, TSQLTableInfo, TStatus, TStreamerElement, TStructNodeProperty, TStyle, TSystem, TSystemFile, TTableSorter, TTask, TText, TThread, TThreadFactory, TToggle, TToggleGroup, TTree, TUDPSocket, TUnfoldBinning, TVirtualBranchBrowsable, TVirtualFitter, TVirtualIndex, TVirtualMagField, TVirtualMC, TVirtualMCApplication, TVirtualMCGeometry, TVirtualMonitoringReader, TVirtualMonitoringWriter, TVirtualPS, TVirtualStreamerInfo, TVirtualX, TXMLEntity, and TXrdClientAdminWrapper.

Constructor & Destructor Documentation

TNamed::TNamed ( )
inline

Definition at line 36 of file TNamed.h.

TNamed::TNamed ( const char *  name,
const char *  title 
)
inline

Definition at line 37 of file TNamed.h.

TNamed::TNamed ( const TString name,
const TString title 
)
inline

Definition at line 38 of file TNamed.h.

TNamed::TNamed ( const TNamed named)

TNamed copy ctor.

Definition at line 35 of file TNamed.cxx.

TNamed::~TNamed ( )
virtual

TNamed destructor.

Definition at line 42 of file TNamed.cxx.

Member Function Documentation

void TNamed::Clear ( Option_t option = "")
virtual
TObject * TNamed::Clone ( const char *  newname = "") const
virtual

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TClass, TStreamerInfo, TMinuit, TH1, TImage, TDataSet, TASImage, TH2Poly, RooAbsArg, RooDataSet, TMVA::MinuitWrapper, RooDataHist, TMethod, RooStats::ModelConfig, RooCmdArg, TFunction, RooFitResult, RooAbsStudy, RooStudyPackage, TFunctionTemplate, RooCategoryProxy, RooAbsBinning, RooFormula, RooRealProxy, and RooMapCatEntry.

Definition at line 74 of file TNamed.cxx.

Int_t TNamed::Compare ( const TObject obj) const
virtual

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in RooAbsArg, TDSetElement, TFileInfo, TGeoOverlap, RooDouble, RooInt, and TStructNodeProperty.

Definition at line 85 of file TNamed.cxx.

void TNamed::Copy ( TObject named) const
virtual
void TNamed::FillBuffer ( char *&  buffer)
virtual

Encode TNamed into output buffer.

Reimplemented in TSQLFile, TFile, TDirectoryFile, TKey, TXMLFile, TKeySQL, and TKeyXML.

Definition at line 104 of file TNamed.cxx.

virtual const char* TNamed::GetName ( ) const
inlinevirtual

Returns name of object.

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

Reimplemented from TObject.

Reimplemented in TMVA::MethodBase, TGeoShape, TMVA::PDF, TMVA::Reader, TMVA::Factory, TMVA::FitterBase, TPackMgr, TPolyLineShape, and TDocDirective.

Definition at line 47 of file TNamed.h.

virtual const char* TNamed::GetTitle ( ) const
inlinevirtual

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Reimplemented in TAxis, TASImage, TKey, TPackMgr, TPolyLineShape, and TBaseClass.

Definition at line 48 of file TNamed.h.

virtual ULong_t TNamed::Hash ( ) const
inlinevirtual

Return hash value for this object.

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

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::TCheckHashRecurveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

Reimplemented from TObject.

Reimplemented in TVolume.

Definition at line 49 of file TNamed.h.

virtual Bool_t TNamed::IsSortable ( ) const
inlinevirtual

Reimplemented from TObject.

Reimplemented in RooAbsArg, TDSetElement, TFileInfo, TGeoOverlap, RooDouble, RooInt, and TStructNodeProperty.

Definition at line 50 of file TNamed.h.

void TNamed::ls ( Option_t option = "") const
virtual
TNamed & TNamed::operator= ( const TNamed rhs)

TNamed assignment operator.

Definition at line 51 of file TNamed.cxx.

void TNamed::Print ( Option_t option = "") const
virtual
void TNamed::SetName ( const char *  name)
virtual

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in TTree, RooAbsArg, TH1, TFormula, TDirectory, RooFitResult, TGraph2D, TEfficiency, RooDataSet, RooDataHist, RooPlot, TNode, TProofChain, TSystemDirectory, TEventList, TRotMatrix, TEveScene, TPackMgr, TShape, and TSystemFile.

Definition at line 140 of file TNamed.cxx.

void TNamed::SetNameTitle ( const char *  name,
const char *  title 
)
virtual

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, TH1, RooFitResult, TGraph2D, RooDataSet, RooDataHist, TContextMenu, RooPlot, and TNode.

Definition at line 154 of file TNamed.cxx.

void TNamed::SetTitle ( const char *  title = "")
virtual

Set the title of the TNamed.

Reimplemented in TF1, TH1, TGraph, THnBase, TGraph2D, TEfficiency, TParallelCoordVar, TASImage, RooPlot, TSystemDirectory, and TSystemFile.

Definition at line 164 of file TNamed.cxx.

Int_t TNamed::Sizeof ( ) const
virtual

Return size of the TNamed part of the TObject.

Reimplemented in TFile, TSQLFile, TDirectory, TDirectoryFile, TKey, TXMLFile, and TTableDescriptor.

Definition at line 173 of file TNamed.cxx.

Member Data Documentation

TString TNamed::fName
protected

Definition at line 32 of file TNamed.h.

TString TNamed::fTitle
protected

Definition at line 33 of file TNamed.h.

Libraries for TNamed:
[legend]

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