ROOT logo
ROOT » ROOFIT » ROOFITCORE » RooCmdConfig

class RooCmdConfig: public TObject



Class RooCmdConfig is a 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

Function Members (Methods)

public:
RooCmdConfig(const char* methodName)
RooCmdConfig(const RooCmdConfig& other)
virtual~RooCmdConfig()
voidTObject::AbstractMethod(const char* method) const
voidallowUndefined(Bool_t flag = kTRUE)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
static Int_tdecodeIntOnTheFly(const char* callerID, const char* cmdArgName, Int_t intIdx, Int_t defVal, const RooCmdArg& arg1, const RooCmdArg& arg2 = RooCmdArg(), const RooCmdArg& arg3 = RooCmdArg(), const RooCmdArg& arg4 = RooCmdArg(), const RooCmdArg& arg5 = RooCmdArg(), const RooCmdArg& arg6 = RooCmdArg(), const RooCmdArg& arg7 = RooCmdArg(), const RooCmdArg& arg8 = RooCmdArg(), const RooCmdArg& arg9 = RooCmdArg())
static TObject*decodeObjOnTheFly(const char* callerID, const char* cmdArgName, Int_t objIdx, TObject* defVal, const RooCmdArg& arg1, const RooCmdArg& arg2 = RooCmdArg(), const RooCmdArg& arg3 = RooCmdArg(), const RooCmdArg& arg4 = RooCmdArg(), const RooCmdArg& arg5 = RooCmdArg(), const RooCmdArg& arg6 = RooCmdArg(), const RooCmdArg& arg7 = RooCmdArg(), const RooCmdArg& arg8 = RooCmdArg(), const RooCmdArg& arg9 = RooCmdArg())
static const char*decodeStringOnTheFly(const char* callerID, const char* cmdArgName, Int_t intIdx, const char* defVal, const RooCmdArg& arg1, const RooCmdArg& arg2 = RooCmdArg(), const RooCmdArg& arg3 = RooCmdArg(), const RooCmdArg& arg4 = RooCmdArg(), const RooCmdArg& arg5 = RooCmdArg(), const RooCmdArg& arg6 = RooCmdArg(), const RooCmdArg& arg7 = RooCmdArg(), const RooCmdArg& arg8 = RooCmdArg(), const RooCmdArg& arg9 = RooCmdArg())
voiddefineDependency(const char* refArgName, const char* neededArgName)
Bool_tdefineDouble(const char* name, const char* argName, Int_t doubleNum, Double_t defValue = 0.)
Bool_tdefineInt(const char* name, const char* argName, Int_t intNum, Int_t defValue = 0)
voiddefineMutex(const char* argName1, const char* argName2)
voiddefineMutex(const char* argName1, const char* argName2, const char* argName3)
voiddefineMutex(const char* argName1, const char* argName2, const char* argName3, const char* argName4)
voiddefineMutex(const char* argName1, const char* argName2, const char* argName3, const char* argName4, const char* argName5)
Bool_tdefineObject(const char* name, const char* argName, Int_t setNum, const TObject* obj = 0, Bool_t isArray = kFALSE)
voiddefineRequiredArgs(const char* argName1, const char* argName2 = 0, const char* argName3 = 0, const char* argName4 = 0, const char* argName5 = 0, const char* argName6 = 0, const char* argName7 = 0, const char* argName8 = 0)
Bool_tdefineSet(const char* name, const char* argName, Int_t setNum, const RooArgSet* set = 0)
Bool_tdefineString(const char* name, const char* argName, Int_t stringNum, const char* defValue = "", Bool_t appendMode = kFALSE)
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
RooLinkedListfilterCmdList(RooLinkedList& cmdInList, const char* cmdNameList, Bool_t removeFromInList = kTRUE)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
Double_tgetDouble(const char* name, Double_t defaultValue = 0)
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
Int_tgetInt(const char* name, Int_t defaultValue = 0)
virtual const char*TObject::GetName() const
TObject*getObject(const char* name, TObject* obj = 0)
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
const RooLinkedList&getObjectList(const char* name)
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
RooArgSet*getSet(const char* name, RooArgSet* set = 0)
const char*getString(const char* name, const char* defaultValue = "", Bool_t convEmptyToNull = kFALSE)
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
Bool_thasProcessed(const char* cmdName) const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
const char*missingArgs() const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
Bool_tok(Bool_t verbose) const
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TObject&TObject::operator=(const TObject& rhs)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
voidprint()
virtual voidTObject::Print(Option_t* option = "") const
Bool_tprocess(const RooCmdArg& arg)
Bool_tprocess(const RooLinkedList& argList)
Bool_tprocess(const RooCmdArg& arg1, const RooCmdArg& arg2, const RooCmdArg& arg3 = RooCmdArg::none(), const RooCmdArg& arg4 = RooCmdArg::none(), const RooCmdArg& arg5 = RooCmdArg::none(), const RooCmdArg& arg6 = RooCmdArg::none(), const RooCmdArg& arg7 = RooCmdArg::none(), const RooCmdArg& arg8 = RooCmdArg::none())
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
static voidTObject::SetObjectStat(Bool_t stat)
virtual voidTObject::SetUniqueID(UInt_t uid)
voidsetVerbose(Bool_t flag)
virtual voidShowMembers(TMemberInspector& insp)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
voidstripCmdList(RooLinkedList& cmdList, const char* cmdsToPurge)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()

Data Members

protected:
Bool_t_allowUndefined
TIterator*_cIterIterator over RooArgSet list
TList_cListRooArgSet list
TIterator*_dIterIterator over double list
TList_dListDouble list
Bool_t_error
TIterator*_fIterIterator over forbidden cmd list
TList_fListForbidden cmd list
TIterator*_iIterIterator over integer list
TList_iListInteger list
TIterator*_mIterIterator over mutex list
TList_mListMutex cmd list
TString_name
TIterator*_oIterIterator over object list
TList_oListObject list
TIterator*_pIterIterator over processed cmd list
TList_pListProcessed cmd list
TIterator*_rIterIterator over required cmd list
TList_rListRequired cmd list
TIterator*_sIterIterator over string list
TList_sListString list
Bool_t_verbose
TIterator*_yIterIterator over dependency list
TList_yListDependency cmd list

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

RooCmdConfig(const char* methodName)
 Constructor taking descriptive name of owner/user which
 is used as prefix for any warning or error messages
 generated by this parser
RooCmdConfig(const RooCmdConfig& other)
 Copy constructor
~RooCmdConfig()
 Destructor
void defineRequiredArgs(const char* argName1, const char* argName2 = 0, const char* argName3 = 0, const char* argName4 = 0, const char* argName5 = 0, const char* argName6 = 0, const char* argName7 = 0, const char* argName8 = 0)
 Add condition that any of listed arguments must be processed
 for parsing to be declared successful
const char* missingArgs() const
 Return string with names of arguments that were required, but not
 processed
void defineDependency(const char* refArgName, const char* neededArgName)
 Define that processing argument name refArgName requires processing
 of argument named neededArgName to succesfully complete parsing
void defineMutex(const char* argName1, const char* argName2)
 Define arguments named argName1 and argName2 mutually exclusive
void defineMutex(const char* argName1, const char* argName2, const char* argName3)
 Define arguments named argName1,argName2 and argName3 mutually exclusive
void defineMutex(const char* argName1, const char* argName2, const char* argName3, const char* argName4)
 Define arguments named argName1,argName2,argName3 and argName4 mutually exclusive
void defineMutex(const char* argName1, const char* argName2, const char* argName3, const char* argName4, const char* argName5)
 Define arguments named argName1,argName2,argName3 and argName4 mutually exclusive
Bool_t defineInt(const char* name, const char* argName, Int_t intNum, Int_t 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
Bool_t defineDouble(const char* name, const char* argName, Int_t doubleNum, Double_t defValue = 0.)
 Define Double_t property name 'name' mapped to Double_t in slot 'doubleNum' in RooCmdArg with name argName
 Define default value for this Double_t property to be defVal in case named argument is not processed
Bool_t defineString(const char* name, const char* argName, Int_t stringNum, const char* defValue = "", Bool_t appendMode = kFALSE)
 Define Double_t property name 'name' mapped to Double_t in slot 'stringNum' in RooCmdArg with name argName
 Define default value for this Double_t 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
Bool_t defineObject(const char* name, const char* argName, Int_t setNum, const TObject* obj = 0, Bool_t isArray = kFALSE)
 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
Bool_t defineSet(const char* name, const char* argName, Int_t setNum, const RooArgSet* set = 0)
 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
void print()
 Print configuration of parser
Bool_t process(const RooLinkedList& argList)
 Process given list with RooCmdArgs
Bool_t process(const RooCmdArg& arg1, const RooCmdArg& arg2, const RooCmdArg& arg3 = RooCmdArg::none(), const RooCmdArg& arg4 = RooCmdArg::none(), const RooCmdArg& arg5 = RooCmdArg::none(), const RooCmdArg& arg6 = RooCmdArg::none(), const RooCmdArg& arg7 = RooCmdArg::none(), const RooCmdArg& arg8 = RooCmdArg::none())
 Process given RooCmdArgs
Bool_t process(const RooCmdArg& arg)
 Process given RooCmdArg
Bool_t hasProcessed(const char* cmdName) const
 Return true if RooCmdArg with name 'cmdName' has been processed
Int_t getInt(const char* name, Int_t defaultValue = 0)
 Return integer property registered with name 'name'. If no
 property is registered, return defVal
Double_t getDouble(const char* name, Double_t defaultValue = 0)
 Return Double_t property registered with name 'name'. If no
 property is registered, return defVal
const char* getString(const char* name, const char* defaultValue = "", Bool_t convEmptyToNull = kFALSE)
 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
TObject* getObject(const char* name, TObject* obj = 0)
 Return TObject property registered with name 'name'. If no
 property is registered, return defVal
RooArgSet* getSet(const char* name, RooArgSet* set = 0)
 Return RooArgSet property registered with name 'name'. If no
 property is registered, return defVal
const RooLinkedList& getObjectList(const char* name)
 Return list of objects registered with name 'name'
Bool_t ok(Bool_t verbose) const
 Return true of parsing was succesfull
void stripCmdList(RooLinkedList& cmdList, const char* cmdsToPurge)
 Utility function that strips command names listed (comma separated) in cmdsToPurge from cmdList
RooLinkedList filterCmdList(RooLinkedList& cmdInList, const char* cmdNameList, Bool_t removeFromInList = kTRUE)
 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
Int_t decodeIntOnTheFly(const char* callerID, const char* cmdArgName, Int_t intIdx, Int_t defVal, const RooCmdArg& arg1, const RooCmdArg& arg2 = RooCmdArg(), const RooCmdArg& arg3 = RooCmdArg(), const RooCmdArg& arg4 = RooCmdArg(), const RooCmdArg& arg5 = RooCmdArg(), const RooCmdArg& arg6 = RooCmdArg(), const RooCmdArg& arg7 = RooCmdArg(), const RooCmdArg& arg8 = RooCmdArg(), const RooCmdArg& arg9 = RooCmdArg())
 Static decoder function allows to retrieve integer property from set of RooCmdArgs
 For use in base member initializers in constructors
const char* decodeStringOnTheFly(const char* callerID, const char* cmdArgName, Int_t intIdx, const char* defVal, const RooCmdArg& arg1, const RooCmdArg& arg2 = RooCmdArg(), const RooCmdArg& arg3 = RooCmdArg(), const RooCmdArg& arg4 = RooCmdArg(), const RooCmdArg& arg5 = RooCmdArg(), const RooCmdArg& arg6 = RooCmdArg(), const RooCmdArg& arg7 = RooCmdArg(), const RooCmdArg& arg8 = RooCmdArg(), const RooCmdArg& arg9 = RooCmdArg())
 Static decoder function allows to retrieve string property from set of RooCmdArgs
 For use in base member initializers in constructors
TObject* decodeObjOnTheFly(const char* callerID, const char* cmdArgName, Int_t objIdx, TObject* defVal, const RooCmdArg& arg1, const RooCmdArg& arg2 = RooCmdArg(), const RooCmdArg& arg3 = RooCmdArg(), const RooCmdArg& arg4 = RooCmdArg(), const RooCmdArg& arg5 = RooCmdArg(), const RooCmdArg& arg6 = RooCmdArg(), const RooCmdArg& arg7 = RooCmdArg(), const RooCmdArg& arg8 = RooCmdArg(), const RooCmdArg& arg9 = RooCmdArg())
 Static decoder function allows to retrieve object property from set of RooCmdArgs
 For use in base member initializers in constructors
void setVerbose(Bool_t flag)
 If flag is true verbose messaging is activated
void allowUndefined(Bool_t flag = kTRUE)
 If flag is true the processing of unrecognized RooCmdArgs
 is not considered an error