Logo ROOT  
Reference Guide
TTreeDrawArgsParser Class Reference

A class that parses all parameters for TTree::Draw(). See TTree::Draw() for the format description.

Definition at line 29 of file TTreeDrawArgsParser.h.

Public Types

enum  EOutputType {
  kUNKNOWN, kEVENTLIST, kENTRYLIST, kPROFILE,
  kPROFILE2D, kGRAPH, kPOLYMARKER3D, kHISTOGRAM1D,
  kHISTOGRAM2D, kLISTOFGRAPHS, kLISTOFPOLYMARKERS3D, kHISTOGRAM3D
}
 
- 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)
}
 

Public Member Functions

 TTreeDrawArgsParser ()
 Constructor - cleans all the class variables. More...
 
 ~TTreeDrawArgsParser ()
 Destructor. More...
 
Bool_t GetAdd () const
 
Int_t GetDimension () const
 
TString GetExp () const
 
Double_t GetIfSpecified (Int_t num, Double_t def) const
 
Int_t GetNoParameters () const
 
TString GetObjectName () const
 
TString GetObjectTitle () const
 Returns the desired plot title. More...
 
Bool_t GetOptionSame () const
 
TObjectGetOriginal () const
 
Double_t GetParameter (int num) const
 returns num-th parameter from brackets in the expression in case of an error (wrong number) returns 0.0 num - number of parameter (counted from 0) More...
 
TString GetProofSelectorName () const
 Returns appropriate TSelector class name for proof for the object that is to be drawn assumes that Parse() method has been called before. More...
 
TString GetSelection () const
 
Bool_t GetShouldDraw () const
 
TString GetVarExp () const
 Returns the variable string, i.e. [var1[:var2[:var2[:var4]]]]. More...
 
TString GetVarExp (Int_t num) const
 Returns the num-th variable string in case of an error prints an error message and returns an empty string. More...
 
Bool_t IsSpecified (int num) const
 returns kTRUE if the num-th parameter was specified otherwise returns fFALSE in case of an error (wrong num) prints an error message and returns kFALSE. More...
 
Bool_t Parse (const char *varexp, const char *selection, Option_t *option)
 Parses parameters from TTree::Draw(). More...
 
void SetObjectName (const char *s)
 
void SetOriginal (TObject *o)
 
- 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 ()
 Check and record whether 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 Clear (Option_t *="")
 
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 abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object. More...
 
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 ULong_t Hash () const
 Return hash value for this object. 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
 
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. More...
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
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...
 

Static Public Member Functions

static Int_t GetMaxDimension ()
 return fgMaxDimension (cannot be inline) More...
 
- 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...
 

Static Public Attributes

static Int_t fgMaxDimension = 4
 
static Int_t fgMaxParameters = 9
 

Protected Member Functions

void ClearPrevious ()
 Resets all the variables of the class. More...
 
TTreeDrawArgsParser::EOutputType DefineType ()
 Put the type of the draw result into fOutputType and return it. More...
 
Bool_t ParseName (TString name)
 Syntax: More...
 
Bool_t ParseOption ()
 Check if options contain some data important for choosing the type of the drawn object. More...
 
Bool_t ParseVarExp ()
 Split variables and parse name and parameters in brackets. More...
 
Bool_t SplitVariables (TString variables)
 Parse expression [var1 [:var2 [:var3] ...]], number of variables cannot be greater than fgMaxDimension. 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

Bool_t fAdd
 
Int_t fDimension
 
Bool_t fDrawProfile
 
Bool_t fEntryList
 
TString fExp
 
TString fName
 
Int_t fNoParameters
 
TString fOption
 
Bool_t fOptionSame
 
TObjectfOriginal
 
EOutputType fOutputType
 
Bool_t fParameterGiven [9]
 
Double_t fParameters [9]
 
TString fSelection
 
Bool_t fShouldDraw
 
TString fVarExp [4]
 

#include <TTreeDrawArgsParser.h>

Inheritance diagram for TTreeDrawArgsParser:
[legend]

Member Enumeration Documentation

◆ EOutputType

Enumerator
kUNKNOWN 
kEVENTLIST 
kENTRYLIST 
kPROFILE 
kPROFILE2D 
kGRAPH 
kPOLYMARKER3D 
kHISTOGRAM1D 
kHISTOGRAM2D 
kLISTOFGRAPHS 
kLISTOFPOLYMARKERS3D 
kHISTOGRAM3D 

Definition at line 38 of file TTreeDrawArgsParser.h.

Constructor & Destructor Documentation

◆ TTreeDrawArgsParser()

TTreeDrawArgsParser::TTreeDrawArgsParser ( )

Constructor - cleans all the class variables.

Definition at line 30 of file TTreeDrawArgsParser.cxx.

◆ ~TTreeDrawArgsParser()

TTreeDrawArgsParser::~TTreeDrawArgsParser ( )

Destructor.

Definition at line 38 of file TTreeDrawArgsParser.cxx.

Member Function Documentation

◆ ClearPrevious()

void TTreeDrawArgsParser::ClearPrevious ( )
protected

Resets all the variables of the class.

Definition at line 53 of file TTreeDrawArgsParser.cxx.

◆ DefineType()

TTreeDrawArgsParser::EOutputType TTreeDrawArgsParser::DefineType ( )
protected

Put the type of the draw result into fOutputType and return it.

Definition at line 266 of file TTreeDrawArgsParser.cxx.

◆ GetAdd()

Bool_t TTreeDrawArgsParser::GetAdd ( ) const
inline

Definition at line 92 of file TTreeDrawArgsParser.h.

◆ GetDimension()

Int_t TTreeDrawArgsParser::GetDimension ( ) const
inline

Definition at line 93 of file TTreeDrawArgsParser.h.

◆ GetExp()

TString TTreeDrawArgsParser::GetExp ( ) const
inline

Definition at line 95 of file TTreeDrawArgsParser.h.

◆ GetIfSpecified()

Double_t TTreeDrawArgsParser::GetIfSpecified ( Int_t  num,
Double_t  def 
) const
  • num - parameter number
  • def - default value of the parameter returns the value of num-th parameter from the brackets in the variable expression if the parameter of that number wasn't specified returns def.

Definition at line 366 of file TTreeDrawArgsParser.cxx.

◆ GetMaxDimension()

Int_t TTreeDrawArgsParser::GetMaxDimension ( )
static

return fgMaxDimension (cannot be inline)

Definition at line 45 of file TTreeDrawArgsParser.cxx.

◆ GetNoParameters()

Int_t TTreeDrawArgsParser::GetNoParameters ( ) const
inline

Definition at line 97 of file TTreeDrawArgsParser.h.

◆ GetObjectName()

TString TTreeDrawArgsParser::GetObjectName ( ) const
inline

Definition at line 100 of file TTreeDrawArgsParser.h.

◆ GetObjectTitle()

TString TTreeDrawArgsParser::GetObjectTitle ( ) const

Returns the desired plot title.

Definition at line 421 of file TTreeDrawArgsParser.cxx.

◆ GetOptionSame()

Bool_t TTreeDrawArgsParser::GetOptionSame ( ) const
inline

Definition at line 102 of file TTreeDrawArgsParser.h.

◆ GetOriginal()

TObject* TTreeDrawArgsParser::GetOriginal ( ) const
inline

Definition at line 103 of file TTreeDrawArgsParser.h.

◆ GetParameter()

Double_t TTreeDrawArgsParser::GetParameter ( int  num) const

returns num-th parameter from brackets in the expression in case of an error (wrong number) returns 0.0 num - number of parameter (counted from 0)

Definition at line 350 of file TTreeDrawArgsParser.cxx.

◆ GetProofSelectorName()

TString TTreeDrawArgsParser::GetProofSelectorName ( ) const

Returns appropriate TSelector class name for proof for the object that is to be drawn assumes that Parse() method has been called before.

Definition at line 315 of file TTreeDrawArgsParser.cxx.

◆ GetSelection()

TString TTreeDrawArgsParser::GetSelection ( ) const
inline

Definition at line 104 of file TTreeDrawArgsParser.h.

◆ GetShouldDraw()

Bool_t TTreeDrawArgsParser::GetShouldDraw ( ) const
inline

Definition at line 94 of file TTreeDrawArgsParser.h.

◆ GetVarExp() [1/2]

TString TTreeDrawArgsParser::GetVarExp ( ) const

Returns the variable string, i.e. [var1[:var2[:var2[:var4]]]].

Definition at line 405 of file TTreeDrawArgsParser.cxx.

◆ GetVarExp() [2/2]

TString TTreeDrawArgsParser::GetVarExp ( Int_t  num) const

Returns the num-th variable string in case of an error prints an error message and returns an empty string.

Definition at line 393 of file TTreeDrawArgsParser.cxx.

◆ IsSpecified()

Bool_t TTreeDrawArgsParser::IsSpecified ( int  num) const

returns kTRUE if the num-th parameter was specified otherwise returns fFALSE in case of an error (wrong num) prints an error message and returns kFALSE.

Definition at line 380 of file TTreeDrawArgsParser.cxx.

◆ Parse()

Bool_t TTreeDrawArgsParser::Parse ( const char *  varexp,
const char *  selection,
Option_t option 
)

Parses parameters from TTree::Draw().

Definition at line 237 of file TTreeDrawArgsParser.cxx.

◆ ParseName()

Bool_t TTreeDrawArgsParser::ParseName ( TString  name)
protected

Syntax:

[' '*][[\+][' '*]name[(num1 [, [num2] ] [, [num3] ] ...)]]

num's are floating point numbers sets the fileds fNoParameters, fParameterGiven, fParameters, fAdd, fName to appropriate values.

Returns kFALSE in case of an error.

Definition at line 131 of file TTreeDrawArgsParser.cxx.

◆ ParseOption()

Bool_t TTreeDrawArgsParser::ParseOption ( )
protected

Check if options contain some data important for choosing the type of the drawn object.

Definition at line 212 of file TTreeDrawArgsParser.cxx.

◆ ParseVarExp()

Bool_t TTreeDrawArgsParser::ParseVarExp ( )
protected

Split variables and parse name and parameters in brackets.

Definition at line 186 of file TTreeDrawArgsParser.cxx.

◆ SetObjectName()

void TTreeDrawArgsParser::SetObjectName ( const char *  s)
inline

Definition at line 108 of file TTreeDrawArgsParser.h.

◆ SetOriginal()

void TTreeDrawArgsParser::SetOriginal ( TObject o)
inline

Definition at line 109 of file TTreeDrawArgsParser.h.

◆ SplitVariables()

Bool_t TTreeDrawArgsParser::SplitVariables ( TString  variables)
protected

Parse expression [var1 [:var2 [:var3] ...]], number of variables cannot be greater than fgMaxDimension.

A colon which is followed by (or that follows) another semicolon is not regarded as a separator.

If there are more separating : than fgMaxDimension - 1 then all characters after (fgMaxDimension - 1)th colon is put into the last variable.

  • fDimension := <number of variables>
  • fVarExp[0] := <first variable string>
  • fVarExp[1] := <second variable string> .. Returns kFALSE in case of an error.

Definition at line 95 of file TTreeDrawArgsParser.cxx.

Member Data Documentation

◆ fAdd

Bool_t TTreeDrawArgsParser::fAdd
protected

Definition at line 66 of file TTreeDrawArgsParser.h.

◆ fDimension

Int_t TTreeDrawArgsParser::fDimension
protected

Definition at line 61 of file TTreeDrawArgsParser.h.

◆ fDrawProfile

Bool_t TTreeDrawArgsParser::fDrawProfile
protected

Definition at line 77 of file TTreeDrawArgsParser.h.

◆ fEntryList

Bool_t TTreeDrawArgsParser::fEntryList
protected

Definition at line 75 of file TTreeDrawArgsParser.h.

◆ fExp

TString TTreeDrawArgsParser::fExp
protected

Definition at line 57 of file TTreeDrawArgsParser.h.

◆ fgMaxDimension

Int_t TTreeDrawArgsParser::fgMaxDimension = 4
static

Definition at line 53 of file TTreeDrawArgsParser.h.

◆ fgMaxParameters

Int_t TTreeDrawArgsParser::fgMaxParameters = 9
static

Definition at line 54 of file TTreeDrawArgsParser.h.

◆ fName

TString TTreeDrawArgsParser::fName
protected

Definition at line 67 of file TTreeDrawArgsParser.h.

◆ fNoParameters

Int_t TTreeDrawArgsParser::fNoParameters
protected

Definition at line 69 of file TTreeDrawArgsParser.h.

◆ fOption

TString TTreeDrawArgsParser::fOption
protected

Definition at line 59 of file TTreeDrawArgsParser.h.

◆ fOptionSame

Bool_t TTreeDrawArgsParser::fOptionSame
protected

Definition at line 74 of file TTreeDrawArgsParser.h.

◆ fOriginal

TObject* TTreeDrawArgsParser::fOriginal
protected

Definition at line 76 of file TTreeDrawArgsParser.h.

◆ fOutputType

EOutputType TTreeDrawArgsParser::fOutputType
protected

Definition at line 78 of file TTreeDrawArgsParser.h.

◆ fParameterGiven

Bool_t TTreeDrawArgsParser::fParameterGiven[9]
protected

Definition at line 70 of file TTreeDrawArgsParser.h.

◆ fParameters

Double_t TTreeDrawArgsParser::fParameters[9]
protected

Definition at line 71 of file TTreeDrawArgsParser.h.

◆ fSelection

TString TTreeDrawArgsParser::fSelection
protected

Definition at line 58 of file TTreeDrawArgsParser.h.

◆ fShouldDraw

Bool_t TTreeDrawArgsParser::fShouldDraw
protected

Definition at line 73 of file TTreeDrawArgsParser.h.

◆ fVarExp

TString TTreeDrawArgsParser::fVarExp[4]
protected

Definition at line 62 of file TTreeDrawArgsParser.h.

Libraries for TTreeDrawArgsParser:
[legend]

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