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

The purpose of this class is to provide a standard interface to static config files.

It interprets Proof config files (proof.conf) and sorts the contents into TProofNodeInfo objects. Master info will be placed in fMaster (of type TProofNodeInfo). Submaster info will be put in fSubmasterList (a TList of TProofNodeInfo objects), while workers (and condorworkers) will be placed in fWorkerList (a TList of TProofNodeInfo objects).

Definition at line 37 of file TProofResourcesStatic.h.

Public Types

enum  EInfoType { kNodeType , kOption , kHost }
 
- 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 ))
}
 

Public Member Functions

 TProofResourcesStatic ()
 This ctor is used in TProofServ::Setup() in combination with GetWorkDir() for a quick scan of the config file to retrieve the work directory.
 
 TProofResourcesStatic (const char *confDir, const char *fileName)
 Using this ctor will retrieve all information in the config file and store it in fMaster, fSubmasterList and fWorkerList, condorworkers will be stored in the fWorkerList.
 
 ~TProofResourcesStatic () override
 Destructor.
 
TString GetFileName () const
 
TProofNodeInfoGetMaster () override
 Get the master node.
 
TListGetSubmasters () override
 Get the list of submaster nodes.
 
TListGetWorkers () override
 Get the list of worker nodes.
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TProofResources
 TProofResources ()
 
 ~TProofResources () override
 
virtual Bool_t IsValid () const
 
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 Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
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 const char * GetName () const
 Returns 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.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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
 
virtual Bool_t IsSortable () 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 TProofResources
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

void InitResources ()
 Create master node info and submaster/worker lists, and set default values.
 
Bool_t ReadConfigFile (const char *confDir, const char *fileName)
 Read the PROOF config file and fill the master and worker list.
 

Static Private Member Functions

static TProofNodeInfoCreateNodeInfo (const TString &name)
 Fill out the preliminary TProofNodeInfo structure.
 
static EInfoType GetInfoType (const TString &word)
 Static method to determine the info type.
 
static void SetOption (TProofNodeInfo *nodeinfo, const TString &option, const TString &value)
 Static method to set the node info options.
 

Private Attributes

TString fFileName
 
Bool_t fFoundMaster
 
TProofNodeInfofMaster
 
TListfSubmasterList
 
TListfWorkerList
 

Additional Inherited Members

- 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 ()
 
- Protected Attributes inherited from TProofResources
Bool_t fValid
 

#include <TProofResourcesStatic.h>

Inheritance diagram for TProofResourcesStatic:
[legend]

Member Enumeration Documentation

◆ EInfoType

Enumerator
kNodeType 
kOption 
kHost 

Definition at line 40 of file TProofResourcesStatic.h.

Constructor & Destructor Documentation

◆ TProofResourcesStatic() [1/2]

TProofResourcesStatic::TProofResourcesStatic ( )

This ctor is used in TProofServ::Setup() in combination with GetWorkDir() for a quick scan of the config file to retrieve the work directory.

Definition at line 44 of file TProofResourcesStatic.cxx.

◆ TProofResourcesStatic() [2/2]

TProofResourcesStatic::TProofResourcesStatic ( const char *  confDir,
const char *  fileName 
)

Using this ctor will retrieve all information in the config file and store it in fMaster, fSubmasterList and fWorkerList, condorworkers will be stored in the fWorkerList.

Definition at line 55 of file TProofResourcesStatic.cxx.

◆ ~TProofResourcesStatic()

TProofResourcesStatic::~TProofResourcesStatic ( )
override

Destructor.

Definition at line 72 of file TProofResourcesStatic.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 67 of file TProofResourcesStatic.h.

◆ CreateNodeInfo()

TProofNodeInfo * TProofResourcesStatic::CreateNodeInfo ( const TString name)
staticprivate

Fill out the preliminary TProofNodeInfo structure.

Definition at line 377 of file TProofResourcesStatic.cxx.

◆ DeclFileName()

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

Definition at line 67 of file TProofResourcesStatic.h.

◆ GetFileName()

TString TProofResourcesStatic::GetFileName ( ) const
inline

Definition at line 65 of file TProofResourcesStatic.h.

◆ GetInfoType()

TProofResourcesStatic::EInfoType TProofResourcesStatic::GetInfoType ( const TString word)
staticprivate

Static method to determine the info type.

Definition at line 356 of file TProofResourcesStatic.cxx.

◆ GetMaster()

TProofNodeInfo * TProofResourcesStatic::GetMaster ( )
overridevirtual

Get the master node.

Only return the master info if it was set in the config file.

Implements TProofResources.

Definition at line 106 of file TProofResourcesStatic.cxx.

◆ GetSubmasters()

TList * TProofResourcesStatic::GetSubmasters ( )
overridevirtual

Get the list of submaster nodes.

Implements TProofResources.

Definition at line 117 of file TProofResourcesStatic.cxx.

◆ GetWorkers()

TList * TProofResourcesStatic::GetWorkers ( void  )
overridevirtual

Get the list of worker nodes.

Implements TProofResources.

Definition at line 125 of file TProofResourcesStatic.cxx.

◆ InitResources()

void TProofResourcesStatic::InitResources ( )
private

Create master node info and submaster/worker lists, and set default values.

Definition at line 83 of file TProofResourcesStatic.cxx.

◆ IsA()

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

Reimplemented from TProofResources.

Definition at line 67 of file TProofResourcesStatic.h.

◆ ReadConfigFile()

Bool_t TProofResourcesStatic::ReadConfigFile ( const char *  confDir,
const char *  fileName 
)
private

Read the PROOF config file and fill the master and worker list.

Definition at line 133 of file TProofResourcesStatic.cxx.

◆ SetOption()

void TProofResourcesStatic::SetOption ( TProofNodeInfo nodeinfo,
const TString option,
const TString value 
)
staticprivate

Static method to set the node info options.

Definition at line 330 of file TProofResourcesStatic.cxx.

◆ Streamer()

void TProofResourcesStatic::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TProofResources.

◆ StreamerNVirtual()

void TProofResourcesStatic::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 67 of file TProofResourcesStatic.h.

Member Data Documentation

◆ fFileName

TString TProofResourcesStatic::fFileName
private

Definition at line 47 of file TProofResourcesStatic.h.

◆ fFoundMaster

Bool_t TProofResourcesStatic::fFoundMaster
private

Definition at line 46 of file TProofResourcesStatic.h.

◆ fMaster

TProofNodeInfo* TProofResourcesStatic::fMaster
private

Definition at line 43 of file TProofResourcesStatic.h.

◆ fSubmasterList

TList* TProofResourcesStatic::fSubmasterList
private

Definition at line 44 of file TProofResourcesStatic.h.

◆ fWorkerList

TList* TProofResourcesStatic::fWorkerList
private

Definition at line 45 of file TProofResourcesStatic.h.

  • proof/proof/inc/TProofResourcesStatic.h
  • proof/proof/src/TProofResourcesStatic.cxx