RooArgList is a container object that can hold multiple RooAbsArg objects.
The container has list semantics which means that:
Ownership of contents.
Unowned objects are inserted with the add() method. Owned objects are added with addOwned() or addClone(). A RooArgSet either owns all of it contents, or none, which is determined by the first <add> call. Once an ownership status is selected, inappropriate <add> calls will return error status. Clearing the list via removeAll() resets the ownership status. Arguments supplied in the constructor are always added as unowned elements.
Definition at line 21 of file RooArgList.h.
Public Member Functions | |
RooArgList () | |
Default constructor. | |
RooArgList (const char *name) | |
Empty list constructor. | |
template<typename... Arg_t> | |
RooArgList (const RooAbsArg &arg, const Arg_t &... argsOrName) | |
Construct a (non-owning) RooArgList from one or more RooFit objects. | |
RooArgList (const RooArgList &other, const char *name="") | |
Copy constructor. | |
RooArgList (const RooArgSet &set) | |
Constructor from a RooArgSet. | |
RooArgList (const TCollection &tcoll, const char *name="") | |
Constructor from a root TCollection. | |
template<typename Iterator_t , typename value_type = typename std::iterator_traits<Iterator_t>::value_type, typename = std::enable_if<std::is_convertible<const value_type*, const RooAbsArg*>::value>> | |
RooArgList (Iterator_t beginIt, Iterator_t endIt, const char *name="") | |
Construct from iterators. | |
virtual | ~RooArgList () |
Destructor. | |
RooAbsArg * | at (Int_t idx) const |
Return object at given index, or nullptr if index is out of range. | |
virtual TObject * | clone (const char *newname) const |
virtual TObject * | create (const char *newname) const |
RooArgList & | operator= (const RooArgList &other) |
RooAbsArg & | operator[] (Int_t idx) const |
Array operator. | |
virtual Bool_t | readFromStream (std::istream &is, Bool_t compact, Bool_t verbose=kFALSE) |
Read the contents of the argset in ASCII form from given stream. | |
virtual void | writeToStream (std::ostream &os, Bool_t compact) |
Write the contents of the argset in ASCII form to given stream. | |
Public Member Functions inherited from RooAbsCollection | |
RooAbsCollection () | |
Default constructor. | |
RooAbsCollection (const char *name) | |
Empty collection constructor. | |
RooAbsCollection (const RooAbsCollection &other, const char *name="") | |
Copy constructor. | |
virtual | ~RooAbsCollection () |
Destructor. | |
virtual Bool_t | add (const RooAbsArg &var, Bool_t silent=kFALSE) |
Add the specified argument to list. | |
virtual Bool_t | add (const RooAbsCollection &list, Bool_t silent=kFALSE) |
Add a collection of arguments to this collection by calling add() for each element in the source collection. | |
virtual RooAbsArg * | addClone (const RooAbsArg &var, Bool_t silent=kFALSE) |
Add a clone of the specified argument to list. | |
virtual void | addClone (const RooAbsCollection &list, Bool_t silent=kFALSE) |
Add a collection of arguments to this collection by calling addOwned() for each element in the source collection. | |
virtual Bool_t | addOwned (const RooAbsCollection &list, Bool_t silent=kFALSE) |
Add a collection of arguments to this collection by calling addOwned() for each element in the source collection. | |
virtual Bool_t | addOwned (RooAbsArg &var, Bool_t silent=kFALSE) |
Add the specified argument to list. | |
Bool_t | allInRange (const char *rangeSpec) const |
Return true if all contained object report to have their value inside the specified range. | |
void | assignFast (const RooAbsCollection &other, Bool_t setValDirty=kTRUE) |
Functional equivalent of operator=() but assumes this and other collection have same layout. | |
RooAbsCollection & | assignValueOnly (const RooAbsCollection &other, Bool_t oneSafe=kFALSE) |
The assignment operator sets the value of any argument in our set that also appears in the other set. | |
const_iterator | begin () const |
void | clear () |
Clear contents. If the collection is owning, it will also delete the contents. | |
virtual TObject * | Clone (const char *newname=0) const |
Make a clone of an object using the Streamer facility. | |
Bool_t | contains (const RooAbsArg &var) const |
Check if collection contains an argument with the same name as var. | |
Bool_t | containsInstance (const RooAbsArg &var) const |
Check if this exact instance is in this collection. | |
std::string | contentsString () const |
Return comma separated list of contained object names as STL string. | |
TIterator * | createIterator (Bool_t dir=kIterForward) const |
TIterator-style iteration over contained elements. | |
virtual Int_t | defaultPrintContents (Option_t *opt) const |
Define default RooPrinable print options for given Print() flag string For inline printing only show value of objects, for default print show name,class name value and extras of each object. | |
void | dump () const |
Base contents dumper for debugging purposes. | |
bool | empty () const |
const_iterator | end () const |
Bool_t | equals (const RooAbsCollection &otherColl) const |
Check if this and other collection have identically-named contents. | |
RooAbsArg * | find (const char *name) const |
Find object with given name in list. | |
RooAbsArg * | find (const RooAbsArg &) const |
Find object with given name in list. | |
RooAbsArg * | first () const |
RooFIter | fwdIterator () const |
One-time forward iterator. | |
Int_t | getCatIndex (const char *name, Int_t defVal=0, Bool_t verbose=kFALSE) const |
Get index value of a RooAbsCategory stored in set with given name. | |
const char * | getCatLabel (const char *name, const char *defVal="", Bool_t verbose=kFALSE) const |
Get state name of a RooAbsCategory stored in set with given name. | |
Int_t | getHashTableSize () const |
Query the size at which the collection will automatically start using an extra lookup table instead of performing a linear search. | |
const char * | GetName () const |
Returns name of object. | |
Double_t | getRealValue (const char *name, Double_t defVal=0, Bool_t verbose=kFALSE) const |
Get value of a RooAbsReal stored in set with given name. | |
Int_t | getSize () const |
const char * | getStringValue (const char *name, const char *defVal="", Bool_t verbose=kFALSE) const |
Get string value of a RooStringVar stored in set with given name. | |
Int_t | index (const char *name) const |
Return index of item with given name, or -1 in case it's not in the collection. | |
Int_t | index (const RooAbsArg &arg) const |
Returns index of given arg, or -1 if arg is not in the collection. | |
Int_t | index (const RooAbsArg *arg) const |
Returns index of given arg, or -1 if arg is not in the collection. | |
Bool_t | isOwning () const |
RooLinkedListIter | iterator (Bool_t dir=kIterForward) const |
TIterator-style iteration over contained elements. | |
RooAbsCollection & | operator= (const RooAbsCollection &other) |
The assignment operator sets the value of any argument in our set that also appears in the other set. | |
RooAbsArg * | operator[] (Storage_t::size_type i) const |
Bool_t | overlaps (const RooAbsCollection &otherColl) const |
Check if this and other collection have common entries. | |
virtual void | Print (Option_t *options=0) const |
This method must be overridden when a class wants to print itself. | |
virtual void | printClassName (std::ostream &os) const |
Return collection class name. | |
void | printLatex (const RooCmdArg &arg1=RooCmdArg(), 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 |
Output content of collection as LaTex table. | |
void | printLatex (std::ostream &ofs, Int_t ncol, const char *option="NEYU", Int_t sigDigit=1, const RooLinkedList &siblingLists=RooLinkedList(), const RooCmdArg *formatCmd=0) const |
Internal implementation function of printLatex. | |
virtual void | printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const |
Implement multiline printing of collection, one line for each contained object showing the requested content. | |
virtual void | printName (std::ostream &os) const |
Return collection name. | |
virtual void | printTitle (std::ostream &os) const |
Return collection title. | |
virtual void | printValue (std::ostream &os) const |
Print value of collection, i.e. | |
Storage_t::const_reverse_iterator | rbegin () const |
virtual void | RecursiveRemove (TObject *obj) |
If one of the TObject we have a referenced to is deleted, remove the reference. | |
void | releaseOwnership () |
virtual Bool_t | remove (const RooAbsArg &var, Bool_t silent=kFALSE, Bool_t matchByNameOnly=kFALSE) |
Remove the specified argument from our list. | |
Bool_t | remove (const RooAbsCollection &list, Bool_t silent=kFALSE, Bool_t matchByNameOnly=kFALSE) |
Remove each argument in the input list from our list using remove(const RooAbsArg&). | |
template<class forwardIt > | |
void | remove (forwardIt rangeBegin, forwardIt rangeEnd, Bool_t silent=kFALSE, Bool_t matchByNameOnly=kFALSE) |
virtual void | removeAll () |
Remove all arguments from our set, deleting them if we own them. | |
Storage_t::const_reverse_iterator | rend () const |
virtual Bool_t | replace (const RooAbsArg &var1, const RooAbsArg &var2) |
Replace var1 with var2 and return kTRUE for success. | |
Bool_t | replace (const RooAbsCollection &other) |
Replace any args in our set with args of the same name from the other set and return kTRUE for success. | |
void | reserve (Storage_t::size_type count) |
RooAbsCollection * | selectByAttrib (const char *name, Bool_t value) const |
Create a subset of the current collection, consisting only of those elements with the specified attribute set. | |
RooAbsCollection * | selectByName (const char *nameList, Bool_t verbose=kFALSE) const |
Create a subset of the current collection, consisting only of those elements with names matching the wildcard expressions in nameList, supplied as a comma separated list. | |
RooAbsCollection * | selectCommon (const RooAbsCollection &refColl) const |
Create a subset of the current collection, consisting only of those elements that are contained as well in the given reference collection. | |
void | setAttribAll (const Text_t *name, Bool_t value=kTRUE) |
Set given attribute in each element of the collection by calling each elements setAttribute() function. | |
Bool_t | setCatIndex (const char *name, Int_t newVal=0, Bool_t verbose=kFALSE) |
Set index value of a RooAbsCategoryLValue stored in set with given name to newVal. | |
Bool_t | setCatLabel (const char *name, const char *newVal="", Bool_t verbose=kFALSE) |
Set state name of a RooAbsCategoryLValue stored in set with given name to newVal. | |
void | setHashTableSize (Int_t number) |
Set the size at which the collection will automatically start using an extra lookup table instead of performing a linear search. | |
void | setName (const char *name) |
Bool_t | setRealValue (const char *name, Double_t newVal=0, Bool_t verbose=kFALSE) |
Set value of a RooAbsRealLValye stored in set with given name to newVal No error messages are printed unless the verbose flag is set. | |
Bool_t | setStringValue (const char *name, const char *newVal="", Bool_t verbose=kFALSE) |
Set string value of a RooStringVar stored in set with given name to newVal. | |
Storage_t::size_type | size () const |
RooAbsCollection * | snapshot (Bool_t deepCopy=kTRUE) const |
Take a snap shot of current collection contents. | |
Bool_t | snapshot (RooAbsCollection &output, Bool_t deepCopy=kTRUE) const |
Take a snap shot of current collection contents: A collection that owns its elements is returned containing clones of. | |
void | sort (Bool_t reverse=false) |
Sort collection using std::sort and name comparison. | |
void | takeOwnership () |
void | useHashMapForFind (bool flag) const |
Install an internal hash map for fast finding of elements by name. | |
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 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 for instance with: gROOT->SetSelectedPad(gPad) . | |
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=0) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
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 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) |
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. | |
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) |
Operator delete []. | |
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 Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
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. | |
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=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Public Member Functions inherited from RooPrintable | |
RooPrintable () | |
virtual | ~RooPrintable () |
virtual StyleOption | defaultPrintStyle (Option_t *opt) const |
virtual void | printAddress (std::ostream &os) const |
Print class name of object. | |
virtual void | printArgs (std::ostream &os) const |
Interface for printing of object arguments. | |
virtual void | printExtras (std::ostream &os) const |
Interface to print extras of object. | |
virtual void | printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const |
Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. | |
virtual void | printTree (std::ostream &os, TString indent="") const |
Interface for tree structure printing of object. | |
Private Member Functions | |
void | processArg (const char *name) |
void | processArg (const RooAbsArg &arg) |
Additional Inherited Members | |
Public Types inherited from RooAbsCollection | |
using | const_iterator = Storage_t::const_iterator |
using | Storage_t = std::vector< RooAbsArg * > |
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 Types inherited from RooPrintable | |
enum | ContentsOption { kName =1 , kClassName =2 , kValue =4 , kArgs =8 , kExtras =16 , kAddress =32 , kTitle =64 , kCollectionHeader =128 } |
enum | StyleOption { kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 , kTreeStructure =5 } |
Static Public Member Functions inherited from TObject | |
static Long_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. | |
Static Public Member Functions inherited from RooPrintable | |
static std::ostream & | defaultPrintStream (std::ostream *os=0) |
Return a reference to the current default stream to use in Print(). | |
static void | nameFieldLength (Int_t newLen) |
Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. | |
Protected Types inherited from RooAbsCollection | |
using | LegacyIterator_t = TIteratorToSTLInterface< Storage_t > |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = BIT(3) } |
Protected Member Functions inherited from RooAbsCollection | |
Bool_t | addServerClonesToList (const RooAbsArg &var) |
Add clones of servers of given argument to end of list. | |
void | clearStructureTags () |
Typed structure tag. | |
void | makeStructureTag () |
void | makeTypedStructureTag () |
void | safeDeleteList () |
Examine client server dependencies in list and delete contents in safe order: any client is deleted before a server is deleted. | |
TNamed * | structureTag () |
TNamed * | typedStructureTag () |
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 RooAbsCollection | |
Bool_t | _allRRV |
Storage_t | _list |
TString | _name |
Bool_t | _ownCont |
TNamed * | _structureTag {nullptr} |
TNamed * | _typedStructureTag {nullptr} |
Structure tag. | |
Static Protected Attributes inherited from RooPrintable | |
static Int_t | _nameLength |
#include <RooArgList.h>
RooArgList::RooArgList | ( | ) |
Default constructor.
Definition at line 59 of file RooArgList.cxx.
RooArgList::RooArgList | ( | const RooArgSet & | set | ) |
Constructor from a RooArgSet.
Definition at line 70 of file RooArgList.cxx.
|
explicit |
Constructor from a root TCollection.
Elements in the collection that do not inherit from RooAbsArg will be skipped. A warning message will be printed for every skipped item.
Definition at line 94 of file RooArgList.cxx.
|
explicit |
Empty list constructor.
Definition at line 82 of file RooArgList.cxx.
|
inline |
Construct a (non-owning) RooArgList from one or more RooFit objects.
arg | A RooFit object to be put in the set. |
varsOrName | Arbitrary number of |
Definition at line 36 of file RooArgList.h.
|
inline |
Construct from iterators.
Iterator_t | An iterator pointing to RooFit objects or references thereof. |
beginIt | Iterator to first element to add. |
end | Iterator to end of range to be added. |
name | Optional name of the collection. |
Definition at line 52 of file RooArgList.h.
|
virtual |
Destructor.
Definition at line 129 of file RooArgList.cxx.
RooArgList::RooArgList | ( | const RooArgList & | other, |
const char * | name = "" |
||
) |
Copy constructor.
Note that a copy of a list is always non-owning, even the source list is owning. To create an owning copy of a list (owning or not), use the snaphot() method.
Definition at line 118 of file RooArgList.cxx.
Return object at given index, or nullptr if index is out of range.
Definition at line 70 of file RooArgList.h.
|
inlinevirtual |
Implements RooAbsCollection.
Definition at line 64 of file RooArgList.h.
|
inlinevirtual |
Implements RooAbsCollection.
Definition at line 65 of file RooArgList.h.
|
inline |
Definition at line 66 of file RooArgList.h.
Array operator.
Element in slot idx
must exist.
std::invalid_argument | if idx is out of range. |
When used as
note that the element contained in the list will not be replaced! Instead, operator=
of the existing element is called.
Definition at line 146 of file RooArgList.cxx.
|
inlineprivate |
Definition at line 86 of file RooArgList.h.
Definition at line 85 of file RooArgList.h.
|
virtual |
Read the contents of the argset in ASCII form from given stream.
A single line is read, and all elements are assumed to be separated by white space. The value of each argument is read by the arguments readFromStream function.
Definition at line 189 of file RooArgList.cxx.
Write the contents of the argset in ASCII form to given stream.
All elements will be printed on a single line separated by a single white space. The contents of each element is written by the arguments' writeToStream() function
Definition at line 166 of file RooArgList.cxx.