Configurable parser for RooCmdArg named arguments.
It maps the contents of named arguments named to integers, doubles, strings and TObjects that can be retrieved after processing a set of RooCmdArgs. The parser also has options to enforce syntax rules such as (conditionally) required arguments, mutually exclusive arguments and dependencies between arguments.
Definition at line 32 of file RooCmdConfig.h.
Classes | |
struct | Var |
Public Member Functions | |
RooCmdConfig (const RooCmdConfig &other) | |
Copy constructor. | |
RooCmdConfig (RooStringView methodName) | |
Constructor taking descriptive name of owner/user which is used as prefix for any warning or error messages generated by this parser. | |
void | allowUndefined (bool flag=true) |
If flag is true the processing of unrecognized RooCmdArgs is not considered an error. | |
void | defineDependency (const char *refArgName, const char *neededArgName) |
Define that processing argument name refArgName requires processing of argument named neededArgName to successfully complete parsing. | |
bool | defineDouble (const char *name, const char *argName, int doubleNum, double defValue=0.0) |
Define double property name 'name' mapped to double in slot 'doubleNum' in RooCmdArg with name argName Define default value for this double property to be defVal in case named argument is not processed. | |
bool | defineInt (const char *name, const char *argName, int intNum, int defValue=0) |
Define integer property name 'name' mapped to integer in slot 'intNum' in RooCmdArg with name argName Define default value for this int property to be defVal in case named argument is not processed. | |
void | defineMutex (const char *) |
template<class... Args_t> | |
void | defineMutex (const char *head, Args_t &&... tail) |
Define arguments where any pair is mutually exclusive. | |
bool | defineObject (const char *name, const char *argName, int setNum, const TObject *obj=nullptr, bool isArray=false) |
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName Define default value for this TObject property to be defVal in case named argument is not processed. | |
template<class... Args_t> | |
void | defineRequiredArgs (const char *first, Args_t &&... args) |
Add condition that any of listed arguments must be processed for parsing to be declared successful. | |
bool | defineSet (const char *name, const char *argName, int setNum, const RooArgSet *set=nullptr) |
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName Define default value for this TObject property to be defVal in case named argument is not processed. | |
bool | defineString (const char *name, const char *argName, int stringNum, const char *defValue="", bool appendMode=false) |
Define double property name 'name' mapped to double in slot 'stringNum' in RooCmdArg with name argName Define default value for this double property to be defVal in case named argument is not processed If appendMode is true, values found in multiple matching RooCmdArg arguments will be concatenated in the output string. | |
RooLinkedList | filterCmdList (RooLinkedList &cmdInList, const char *cmdNameList, bool removeFromInList=true) const |
Utility function to filter commands listed in cmdNameList from cmdInList. | |
double | getDouble (const char *name, double defaultValue=0.0) const |
Return double property registered with name 'name'. | |
int | getInt (const char *name, int defaultValue=0) const |
Return integer property registered with name 'name'. | |
TObject * | getObject (const char *name, TObject *obj=nullptr) const |
Return TObject property registered with name 'name'. | |
const RooLinkedList & | getObjectList (const char *name) const |
Return list of objects registered with name 'name'. | |
RooArgSet * | getSet (const char *name, RooArgSet *set=nullptr) const |
Return RooArgSet property registered with name 'name'. | |
const char * | getString (const char *name, const char *defaultValue="", bool convEmptyToNull=false) const |
Return string property registered with name 'name'. | |
bool | hasProcessed (const char *cmdName) const |
Return true if RooCmdArg with name 'cmdName' has been processed. | |
TClass * | IsA () const override |
std::string | missingArgs () const |
Return string with names of arguments that were required, but not processed. | |
bool | ok (bool verbose) const |
Return true of parsing was successful. | |
void | print () const |
Print configuration of parser. | |
bool | process (const RooCmdArg &arg) |
Process given RooCmdArg. | |
template<class... Args_t> | |
bool | process (const RooCmdArg &arg, Args_t &&...args) |
Process given RooCmdArgs. | |
bool | process (const RooLinkedList &argList) |
Process given list with RooCmdArgs. | |
template<typename It_t > | |
bool | process (It_t begin, It_t end) |
Process several RooCmdArg using iterators. | |
void | setVerbose (bool flag) |
If flag is true verbose messaging is activated. | |
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 TObject * | Clone (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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () 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_t * | GetOption () 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) |
TObject & | operator= (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 TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static double | decodeDoubleOnTheFly (const char *callerID, const char *cmdArgName, int idx, double defVal, std::initializer_list< std::reference_wrapper< const RooCmdArg > > args) |
Find a given double in a list of RooCmdArg. | |
template<class ... Args_t> | |
static int | decodeIntOnTheFly (const char *callerID, const char *cmdArgName, int intIdx, int defVal, Args_t &&...args) |
Static decoder function allows to retrieve integer property from set of RooCmdArgs For use in base member initializers in constructors. | |
template<class ... Args_t> | |
static TObject * | decodeObjOnTheFly (const char *callerID, const char *cmdArgName, int objIdx, TObject *defVal, Args_t &&...args) |
Static decoder function allows to retrieve object property from set of RooCmdArgs For use in base member initializers in constructors. | |
template<class ... Args_t> | |
static RooArgSet * | decodeSetOnTheFly (const char *callerID, const char *cmdArgName, int objIdx, RooArgSet *defVal, Args_t &&...args) |
template<class ... Args_t> | |
static std::string | decodeStringOnTheFly (const char *callerID, const char *cmdArgName, int intIdx, const char *defVal, Args_t &&...args) |
Static decoder function allows to retrieve string property from set of RooCmdArgs For use in base member initializers in constructors. | |
static void | stripCmdList (RooLinkedList &cmdList, const char *cmdsToPurge) |
Utility function that strips command names listed (comma separated) in cmdsToPurge from cmdList. | |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
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 Attributes | |
bool | _allowUndefined = false |
std::vector< Var< RooArgSet * > > | _cList |
RooArgSet list. | |
std::vector< Var< double > > | _dList |
Double list. | |
bool | _error = false |
TList | _fList |
Forbidden cmd list. | |
std::vector< Var< int > > | _iList |
Integer list. | |
TList | _mList |
Mutex cmd list. | |
std::string | _name |
std::vector< Var< RooLinkedList > > | _oList |
Object list. | |
TList | _pList |
Processed cmd list. | |
TList | _rList |
Required cmd list. | |
std::vector< Var< std::string > > | _sList |
String list. | |
bool | _verbose = false |
TList | _yList |
Dependency cmd list. | |
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 <RooCmdConfig.h>
RooCmdConfig::RooCmdConfig | ( | RooStringView | methodName | ) |
Constructor taking descriptive name of owner/user which is used as prefix for any warning or error messages generated by this parser.
Definition at line 59 of file RooCmdConfig.cxx.
RooCmdConfig::RooCmdConfig | ( | const RooCmdConfig & | other | ) |
Copy constructor.
Definition at line 84 of file RooCmdConfig.cxx.
|
inline |
If flag is true the processing of unrecognized RooCmdArgs is not considered an error.
Definition at line 44 of file RooCmdConfig.h.
|
static |
|
inlinestaticconstexpr |
Definition at line 135 of file RooCmdConfig.h.
|
inlinestatic |
Definition at line 135 of file RooCmdConfig.h.
|
static |
Find a given double in a list of RooCmdArg.
Should only be used to initialise base classes in constructors.
Definition at line 615 of file RooCmdConfig.cxx.
|
static |
Static decoder function allows to retrieve integer property from set of RooCmdArgs For use in base member initializers in constructors.
Definition at line 189 of file RooCmdConfig.h.
|
static |
Static decoder function allows to retrieve object property from set of RooCmdArgs For use in base member initializers in constructors.
Definition at line 223 of file RooCmdConfig.h.
|
static |
Definition at line 235 of file RooCmdConfig.h.
|
static |
Static decoder function allows to retrieve string property from set of RooCmdArgs For use in base member initializers in constructors.
Definition at line 205 of file RooCmdConfig.h.
void RooCmdConfig::defineDependency | ( | const char * | refArgName, |
const char * | neededArgName | ||
) |
Define that processing argument name refArgName requires processing of argument named neededArgName to successfully complete parsing.
Definition at line 132 of file RooCmdConfig.cxx.
bool RooCmdConfig::defineDouble | ( | const char * | name, |
const char * | argName, | ||
int | doubleNum, | ||
double | defValue = 0.0 |
||
) |
Define double property name 'name' mapped to double in slot 'doubleNum' in RooCmdArg with name argName Define default value for this double property to be defVal in case named argument is not processed.
Definition at line 165 of file RooCmdConfig.cxx.
bool RooCmdConfig::defineInt | ( | const char * | name, |
const char * | argName, | ||
int | intNum, | ||
int | defValue = 0 |
||
) |
Define integer property name 'name' mapped to integer in slot 'intNum' in RooCmdArg with name argName Define default value for this int property to be defVal in case named argument is not processed.
Definition at line 143 of file RooCmdConfig.cxx.
|
inline |
Definition at line 54 of file RooCmdConfig.h.
void RooCmdConfig::defineMutex | ( | const char * | head, |
Args_t &&... | tail | ||
) |
Define arguments where any pair is mutually exclusive.
Definition at line 153 of file RooCmdConfig.h.
bool RooCmdConfig::defineObject | ( | const char * | name, |
const char * | argName, | ||
int | setNum, | ||
const TObject * | defVal = nullptr , |
||
bool | isArray = false |
||
) |
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName Define default value for this TObject property to be defVal in case named argument is not processed.
If isArray is true, an array of TObjects is harvested in case multiple matching named arguments are processed. If isArray is false, only the TObject in the last processed named argument is retained
Definition at line 214 of file RooCmdConfig.cxx.
void RooCmdConfig::defineRequiredArgs | ( | const char * | first, |
Args_t &&... | args | ||
) |
Add condition that any of listed arguments must be processed for parsing to be declared successful.
Definition at line 143 of file RooCmdConfig.h.
bool RooCmdConfig::defineSet | ( | const char * | name, |
const char * | argName, | ||
int | setNum, | ||
const RooArgSet * | defVal = nullptr |
||
) |
Define TObject property name 'name' mapped to object in slot 'setNum' in RooCmdArg with name argName Define default value for this TObject property to be defVal in case named argument is not processed.
If isArray is true, an array of TObjects is harvested in case multiple matching named arguments are processed. If isArray is false, only the TObject in the last processed named argument is retained
Definition at line 240 of file RooCmdConfig.cxx.
bool RooCmdConfig::defineString | ( | const char * | name, |
const char * | argName, | ||
int | stringNum, | ||
const char * | defVal = "" , |
||
bool | appendMode = false |
||
) |
Define double property name 'name' mapped to double in slot 'stringNum' in RooCmdArg with name argName Define default value for this double property to be defVal in case named argument is not processed If appendMode is true, values found in multiple matching RooCmdArg arguments will be concatenated in the output string.
If it is false, only the value of the last processed instance is retained
Definition at line 189 of file RooCmdConfig.cxx.
RooLinkedList RooCmdConfig::filterCmdList | ( | RooLinkedList & | cmdInList, |
const char * | cmdNameList, | ||
bool | removeFromInList = true |
||
) | const |
Utility function to filter commands listed in cmdNameList from cmdInList.
Filtered arguments are put in the returned list. If removeFromInList is true then these commands are removed from the input list
Definition at line 593 of file RooCmdConfig.cxx.
Return double property registered with name 'name'.
If no property is registered, return defVal
Definition at line 493 of file RooCmdConfig.cxx.
Return integer property registered with name 'name'.
If no property is registered, return defVal
Definition at line 481 of file RooCmdConfig.cxx.
Return TObject property registered with name 'name'.
If no property is registered, return defVal
Definition at line 519 of file RooCmdConfig.cxx.
const RooLinkedList & RooCmdConfig::getObjectList | ( | const char * | name | ) | const |
Return list of objects registered with name 'name'.
Definition at line 541 of file RooCmdConfig.cxx.
Return RooArgSet property registered with name 'name'.
If no property is registered, return defVal
Definition at line 530 of file RooCmdConfig.cxx.
const char * RooCmdConfig::getString | ( | const char * | name, |
const char * | defVal = "" , |
||
bool | convEmptyToNull = false |
||
) | const |
Return string property registered with name 'name'.
If no property is registered, return defVal. If convEmptyToNull is true, empty string will be returned as null pointers
Definition at line 506 of file RooCmdConfig.cxx.
bool RooCmdConfig::hasProcessed | ( | const char * | cmdName | ) | const |
Return true if RooCmdArg with name 'cmdName' has been processed.
Definition at line 470 of file RooCmdConfig.cxx.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 135 of file RooCmdConfig.h.
std::string RooCmdConfig::missingArgs | ( | ) | const |
Return string with names of arguments that were required, but not processed.
Definition at line 109 of file RooCmdConfig.cxx.
Return true of parsing was successful.
Definition at line 553 of file RooCmdConfig.cxx.
void RooCmdConfig::print | ( | ) | const |
Print configuration of parser.
Definition at line 262 of file RooCmdConfig.cxx.
Process given RooCmdArg.
Definition at line 311 of file RooCmdConfig.cxx.
Process given RooCmdArgs.
Definition at line 165 of file RooCmdConfig.h.
bool RooCmdConfig::process | ( | const RooLinkedList & | argList | ) |
Process given list with RooCmdArgs.
Definition at line 297 of file RooCmdConfig.cxx.
bool RooCmdConfig::process | ( | It_t | begin, |
It_t | end | ||
) |
Process several RooCmdArg using iterators.
Definition at line 175 of file RooCmdConfig.h.
|
inline |
If flag is true verbose messaging is activated.
Definition at line 39 of file RooCmdConfig.h.
|
overridevirtual |
|
inline |
Definition at line 135 of file RooCmdConfig.h.
|
static |
Utility function that strips command names listed (comma separated) in cmdsToPurge from cmdList.
Definition at line 573 of file RooCmdConfig.cxx.
|
protected |
Definition at line 121 of file RooCmdConfig.h.
RooArgSet list.
Definition at line 127 of file RooCmdConfig.h.
Double list.
Definition at line 124 of file RooCmdConfig.h.
|
protected |
Definition at line 120 of file RooCmdConfig.h.
|
protected |
Forbidden cmd list.
Definition at line 130 of file RooCmdConfig.h.
Integer list.
Definition at line 123 of file RooCmdConfig.h.
|
protected |
Mutex cmd list.
Definition at line 131 of file RooCmdConfig.h.
|
protected |
Definition at line 117 of file RooCmdConfig.h.
|
protected |
Object list.
Definition at line 126 of file RooCmdConfig.h.
|
protected |
Processed cmd list.
Definition at line 133 of file RooCmdConfig.h.
|
protected |
Required cmd list.
Definition at line 129 of file RooCmdConfig.h.
|
protected |
String list.
Definition at line 125 of file RooCmdConfig.h.
|
protected |
Definition at line 119 of file RooCmdConfig.h.
|
protected |
Dependency cmd list.
Definition at line 132 of file RooCmdConfig.h.