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

Describes an Operating System directory for the browser.

Definition at line 32 of file TSystemDirectory.h.

Public Member Functions

 TSystemDirectory ()
 Create a system directory object.
 
 TSystemDirectory (const char *dirname, const char *path)
 Create a system directory object.
 
virtual ~TSystemDirectory ()
 Delete system directory object.
 
void Browse (TBrowser *b) override
 Browse OS system directories.
 
void Copy (const char *) override
 copy this file
 
void Copy (TObject &) const override
 Copy this to obj.
 
void Delete () override
 delete this file
 
void Delete (Option_t *) override
 Delete this object.
 
void DrawClass () const override
 Draw class inheritance tree of the class to which this object belongs.
 
TObjectDrawClone (Option_t *) const override
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
void Edit () override
 Invoke text editor on this file.
 
virtual TListGetListOfFiles () const
 Returns a TList of TSystemFile objects representing the contents of the directory.
 
TClassIsA () const override
 
Bool_t IsDirectory (const char *=nullptr) const override
 Check if object is a directory.
 
Bool_t IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
void Move (const char *) override
 move this file
 
virtual void SetDirectory (const char *name)
 Create a system directory object.
 
void SetDrawOption (Option_t *) override
 Set drawing option for object.
 
void SetName (const char *name) override
 Set the name of the TNamed.
 
void SetTitle (const char *title) override
 Set the title of the TNamed.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TSystemFile
 TSystemFile ()
 TSystemFile default constructor.
 
 TSystemFile (const char *filename, const char *dirname)
 TSystemFile normal constructor.
 
virtual ~TSystemFile ()
 Delete TSystemFile object.
 
void Browse (TBrowser *b) override
 Execute default action for this system file (action is specified in the $HOME/.root.mimes or $ROOTSYS/etc/root.mimes file.
 
void Copy (TObject &) const override
 Copy this to obj.
 
void Delete (Option_t *) override
 Delete this object.
 
void DrawClass () const override
 Draw class inheritance tree of the class to which this object belongs.
 
TObjectDrawClone (Option_t *) const override
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
void Dump () const override
 dump this file
 
const char * GetIconName () const override
 Returns mime type name of object.
 
void Inspect () const override
 inspect this file
 
TClassIsA () const override
 
virtual void Rename (const char *name)
 rename this file
 
void SetDrawOption (Option_t *) override
 Set drawing option for object.
 
virtual void SetIconName (const char *name)
 
void SetName (const char *name) override
 Set the name of the TNamed.
 
void SetTitle (const char *title) override
 Set the title of the TNamed.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the 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.
 
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 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 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 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 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.
 
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).
 
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).
 
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 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 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 TSystemFile
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
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.
 

Protected Member Functions

 TSystemDirectory (const TSystemDirectory &)=delete
 
TSystemDirectoryFindDirObj (const char *name)
 Method that returns system directory object if it exists in list, 0 otherwise.
 
TSystemFileFindFileObj (const char *name, const char *dir)
 Method that returns system file object if it exists in list, 0 otherwise.
 
Bool_t IsItDirectory (const char *name) const
 Check if name is a directory.
 
TSystemDirectoryoperator= (const TSystemDirectory &)=delete
 
- 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 ()
 

Protected Attributes

TOrdCollectionfDirsInBrowser {nullptr}
 
TOrdCollectionfFilesInBrowser {nullptr}
 
- Protected Attributes inherited from TNamed
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 = (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 )) }
 

#include <TSystemDirectory.h>

Inheritance diagram for TSystemDirectory:
[legend]

Constructor & Destructor Documentation

◆ TSystemDirectory() [1/3]

TSystemDirectory::TSystemDirectory ( const TSystemDirectory )
protecteddelete

◆ TSystemDirectory() [2/3]

TSystemDirectory::TSystemDirectory ( )

Create a system directory object.

Definition at line 30 of file TSystemDirectory.cxx.

◆ TSystemDirectory() [3/3]

TSystemDirectory::TSystemDirectory ( const char *  dirname,
const char *  path 
)

Create a system directory object.

Definition at line 37 of file TSystemDirectory.cxx.

◆ ~TSystemDirectory()

TSystemDirectory::~TSystemDirectory ( )
virtual

Delete system directory object.

Definition at line 45 of file TSystemDirectory.cxx.

Member Function Documentation

◆ Browse()

void TSystemDirectory::Browse ( TBrowser b)
overridevirtual

Browse OS system directories.

Reimplemented from TObject.

Definition at line 117 of file TSystemDirectory.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 71 of file TSystemDirectory.h.

◆ Copy() [1/2]

void TSystemDirectory::Copy ( const char *  to)
inlineoverridevirtual

copy this file

Reimplemented from TSystemFile.

Definition at line 59 of file TSystemDirectory.h.

◆ Copy() [2/2]

void TSystemDirectory::Copy ( TObject named) const
inlineoverridevirtual

Copy this to obj.

Reimplemented from TNamed.

Definition at line 69 of file TSystemDirectory.h.

◆ DeclFileName()

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

Definition at line 71 of file TSystemDirectory.h.

◆ Delete() [1/2]

void TSystemDirectory::Delete ( )
inlineoverridevirtual

delete this file

Reimplemented from TSystemFile.

Definition at line 58 of file TSystemDirectory.h.

◆ Delete() [2/2]

void TSystemDirectory::Delete ( Option_t option)
inlineoverridevirtual

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented from TObject.

Definition at line 68 of file TSystemDirectory.h.

◆ DrawClass()

void TSystemDirectory::DrawClass ( ) const
inlineoverridevirtual

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented from TObject.

Definition at line 63 of file TSystemDirectory.h.

◆ DrawClone()

TObject * TSystemDirectory::DrawClone ( Option_t option) const
inlineoverridevirtual

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Reimplemented from TObject.

Definition at line 64 of file TSystemDirectory.h.

◆ Edit()

void TSystemDirectory::Edit ( )
inlineoverridevirtual

Invoke text editor on this file.

Reimplemented from TSystemFile.

Definition at line 55 of file TSystemDirectory.h.

◆ FindDirObj()

TSystemDirectory * TSystemDirectory::FindDirObj ( const char *  name)
protected

Method that returns system directory object if it exists in list, 0 otherwise.

Definition at line 175 of file TSystemDirectory.cxx.

◆ FindFileObj()

TSystemFile * TSystemDirectory::FindFileObj ( const char *  name,
const char *  dir 
)
protected

Method that returns system file object if it exists in list, 0 otherwise.

Definition at line 190 of file TSystemDirectory.cxx.

◆ GetListOfFiles()

TList * TSystemDirectory::GetListOfFiles ( ) const
virtual

Returns a TList of TSystemFile objects representing the contents of the directory.

It's the responsibility of the user to delete the list (the list owns the contained objects). Returns 0 in case of errors.

Definition at line 57 of file TSystemDirectory.cxx.

◆ IsA()

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

Reimplemented from TNamed.

Definition at line 71 of file TSystemDirectory.h.

◆ IsDirectory()

Bool_t TSystemDirectory::IsDirectory ( const char *  dir = nullptr) const
inlineoverridevirtual

Check if object is a directory.

Reimplemented from TSystemFile.

Definition at line 52 of file TSystemDirectory.h.

◆ IsFolder()

Bool_t TSystemDirectory::IsFolder ( ) const
inlineoverridevirtual

Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Reimplemented from TObject.

Definition at line 51 of file TSystemDirectory.h.

◆ IsItDirectory()

Bool_t TSystemDirectory::IsItDirectory ( const char *  name) const
protected

Check if name is a directory.

Definition at line 98 of file TSystemDirectory.cxx.

◆ Move()

void TSystemDirectory::Move ( const char *  to)
inlineoverridevirtual

move this file

Reimplemented from TSystemFile.

Definition at line 60 of file TSystemDirectory.h.

◆ operator=()

TSystemDirectory & TSystemDirectory::operator= ( const TSystemDirectory )
protecteddelete

◆ SetDirectory()

void TSystemDirectory::SetDirectory ( const char *  name)
virtual

Create a system directory object.

Definition at line 89 of file TSystemDirectory.cxx.

◆ SetDrawOption()

void TSystemDirectory::SetDrawOption ( Option_t option)
inlineoverridevirtual

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented from TObject.

Definition at line 65 of file TSystemDirectory.h.

◆ SetName()

void TSystemDirectory::SetName ( const char *  name)
inlineoverridevirtual

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 from TNamed.

Definition at line 66 of file TSystemDirectory.h.

◆ SetTitle()

void TSystemDirectory::SetTitle ( const char *  title)
inlineoverridevirtual

Set the title of the TNamed.

Reimplemented from TNamed.

Definition at line 67 of file TSystemDirectory.h.

◆ Streamer()

void TSystemDirectory::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

◆ StreamerNVirtual()

void TSystemDirectory::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 71 of file TSystemDirectory.h.

Member Data Documentation

◆ fDirsInBrowser

TOrdCollection* TSystemDirectory::fDirsInBrowser {nullptr}
protected

Definition at line 35 of file TSystemDirectory.h.

◆ fFilesInBrowser

TOrdCollection* TSystemDirectory::fFilesInBrowser {nullptr}
protected

Definition at line 36 of file TSystemDirectory.h.

  • core/base/inc/TSystemDirectory.h
  • core/base/src/TSystemDirectory.cxx