library: libRooFit #include "RooAbsCollection.h"

# RooAbsCollection

class description - source file - inheritance tree (.pdf)

## class RooAbsCollection : public TObject, public RooPrintable

| Inheritance Chart:
`TObject`
`RooPrintable`
| <- | `RooAbsCollection` |
<- |
`RooArgList` | <- |
`RooListProxy` |
`RooArgSet` | <- |
`RooSetProxy` |

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

        protected:

          Bool_t addServerClonesToList(const RooAbsArg& var)
            void safeDeleteList()

        public:

                      virtual ~RooAbsCollection()
               virtual Bool_t add(const RooAbsArg& var, Bool_t silent = kFALSE)
               virtual Bool_t add(const RooAbsCollection& list, Bool_t silent = kFALSE)
           virtual RooAbsArg* addClone(const RooAbsArg& var, Bool_t silent = kFALSE)
                 virtual void addClone(const RooAbsCollection& list, Bool_t silent = kFALSE)
               virtual Bool_t addOwned(RooAbsArg& var, Bool_t silent = kFALSE)
               virtual Bool_t addOwned(const RooAbsCollection& list, Bool_t silent = kFALSE)
                       Bool_t allInRange(const char* rangeSpec) const
               static TClass* Class()
             virtual TObject* clone(const char* newname) const
             virtual TObject* Clone(const char* newname = "0") const
                       Bool_t contains(const RooAbsArg& var) const
             virtual TObject* create(const char* newname) const
                   TIterator* createIterator(Bool_t dir = kIterForward) const
                         void dump() const
                       Bool_t equals(const RooAbsCollection& otherColl) const
                   RooAbsArg* find(const char* name) const
                   RooAbsArg* first() const
                        Int_t getHashTableSize() const
          virtual const char* GetName() const
                        Int_t getSize() const
              virtual TClass* IsA() const
                       Bool_t isOwning() const
            RooAbsCollection& operator=(const RooAbsCollection& other)
                       Bool_t overlaps(const RooAbsCollection& otherColl) const
                 virtual void Print(Option_t* options = "0") const
                         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
                         void printLatex(ostream& ofs, Int_t ncol, const char* option = "NEYU", Int_t sigDigit = 1, const RooLinkedList& siblingLists = RooLinkedList(), const RooCmdArg* formatCmd = 0) const
                 virtual void printToStream(ostream& os, RooPrintable::PrintOption opt = Standard, TString indent = ) const
               virtual Bool_t remove(const RooAbsArg& var, Bool_t silent = kFALSE, Bool_t matchByNameOnly = kFALSE)
                       Bool_t remove(const RooAbsCollection& list, Bool_t silent = kFALSE, Bool_t matchByNameOnly = kFALSE)
                 virtual void removeAll()
               virtual Bool_t replace(const RooAbsArg& var1, const RooAbsArg& var2)
                       Bool_t replace(const RooAbsCollection& other)
            RooAbsCollection* selectByAttrib(const char* name, Bool_t value) const
            RooAbsCollection* selectByName(const char* nameList, Bool_t verbose = kFALSE) const
            RooAbsCollection* selectCommon(const RooAbsCollection& refColl) const
                         void setAttribAll(const Text_t* name, Bool_t value = kTRUE)
                         void setHashTableSize(Int_t i)
                         void setName(const char* name)
                 virtual void ShowMembers(TMemberInspector& insp, char* parent)
            RooAbsCollection* snapshot(Bool_t deepCopy = kTRUE) const
                 virtual void Streamer(TBuffer& b)
                         void StreamerNVirtual(TBuffer& b)

### Data Members

        protected:

          RooLinkedList _list     Actual object store
                 Bool_t _ownCont  Flag to identify a list that owns its contents.
                TString _name     Our name.

## Class Description

~RooAbsCollection()

     Destructor

void safeDeleteList()

     Examine client server dependencies in list and
     delete contents in safe order: any client
     is deleted before a server is deleted

RooAbsCollection* snapshot(Bool_t deepCopy) const

     Take a snap shot of current collection contents:
     An owning collection is returned containing clones of

         - Elements in this collection
         - External dependents of all elements
           and recursively any dependents of those dependents
           (if deepCopy flag is set)

     Ff deepCopy is specified, the client-server links between the cloned
     list elements and the cloned external dependents are reconnected to
     each other, making the snapshot a completely self-contained entity.

Bool_t addServerClonesToList(const RooAbsArg& var)

     Add clones of servers of given argument to list

Bool_t addOwned(RooAbsArg& var, Bool_t silent)

     Add the specified argument to list. Returns kTRUE if successful, or
     else kFALSE if a variable of the same name is already in the list.
     This method can only be called on a list that is flagged as owning
     all of its contents, or else on an empty list (which will force the
     list into that mode).

RooAbsArg* addClone(const RooAbsArg& var, Bool_t silent)

     Add a clone of the specified argument to list. Returns a pointer to
     the clone if successful, or else zero if a variable of the same name
     is already in the list or the list does *not* own its variables (in
     this case, try add() instead.) Calling addClone() on an empty list
     forces it to take ownership of all its subsequent variables.

Bool_t add(const RooAbsArg& var, Bool_t silent)

     Add the specified argument to list. Returns kTRUE if successful, or
     else kFALSE if a variable of the same name is already in the list
     or the list owns its variables (in this case, try addClone() or addOwned() instead).

Bool_t add(const RooAbsCollection& list, Bool_t silent)

     Add a collection of arguments to this collection by calling add()
     for each element in the source collection

Bool_t addOwned(const RooAbsCollection& list, Bool_t silent)

     Add a collection of arguments to this collection by calling addOwned()
     for each element in the source collection

void addClone(const RooAbsCollection& list, Bool_t silent)

     Add a collection of arguments to this collection by calling addOwned()
     for each element in the source collection

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. Fails if this list is a copy of another.

Bool_t replace(const RooAbsArg& var1, const RooAbsArg& var2)

     Replace var1 with var2 and return kTRUE for success. Fails if
     this list is a copy of another, if var1 is not already in this set,
     or if var2 is already in this set. var1 and var2 do not need to have
     the same name.

Bool_t remove(const RooAbsArg& var, Bool_t , Bool_t matchByNameOnly)

     Remove the specified argument from our list. Return kFALSE if
     the specified argument is not found in our list. An exact pointer
     match is required, not just a match by name. A variable can be
     removed from a copied list and will be deleted at the same time.

Bool_t remove(const RooAbsCollection& list, Bool_t silent, Bool_t matchByNameOnly)

     Remove each argument in the input list from our list using remove(const RooAbsArg&).
     Return kFALSE in case of problems.

void removeAll()

     Remove all arguments from our set, deleting them if we own them.
     This effectively restores our object to the state it would have
     just after calling the RooAbsCollection(const char*) constructor.

void setAttribAll(const Text_t* name, Bool_t value)

     Set given attribute in each element of the collection by
     calling each elements setAttribute() function.

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. The caller is responsibe
     for deleting the returned collection

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.
     The caller is responsible for deleting the returned collection

RooAbsCollection* selectByName(const char* nameList, Bool_t verbose) 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

Bool_t equals(const RooAbsCollection& otherColl) const

     Check if this and other collection have identically named contents

Bool_t overlaps(const RooAbsCollection& otherColl) const

     Check if this and other collection have common entries

RooAbsArg* find(const char *name) const

     Find object with given name in list. A null pointer
     is returned if no object with the given name is found

void printToStream(ostream& os, PrintOption opt, TString indent) const

     Print info about this argument set to the specified stream.

      Standard: OneLine description of each argument
         Shape: Standard description of each argument
       Verbose: Shape description of each argument

void dump() const

void printLatex(const RooCmdArg& arg1, const RooCmdArg& arg2, const RooCmdArg& arg3, const RooCmdArg& arg4, const RooCmdArg& arg5, const RooCmdArg& arg6, const RooCmdArg& arg7, const RooCmdArg& arg8) const

     Output content of collection as LaTex table. By default a table with two columns is created: the left
     column contains the name of each variable, the right column the value.

     The following optional named arguments can be used to modify the default behavior

       Columns(Int_t ncol)                    -- Fold table into multiple columns, i.e. ncol=3 will result in 3 x 2 = 6 total columns
       Sibling(const RooAbsCollection& other) -- Define sibling list. The sibling list is assumed to have objects with the same
                                                 name in the same order. If this is not the case warnings will be printed. If a single
                                                 sibling list is specified, 3 columns will be output: the (common) name, the value of this
                                                 list and the value in the sibling list. Multiple sibling lists can be specified by
                                                 repeating the Sibling() command.
       Format(const char* str)                -- Classic format string, provided for backward compatibility
       Format(...)                            -- Formatting arguments, details are given below
       OutputFile(const char* fname)          -- Send output to file with given name rather than standard output

     The Format(const char* what,...) has the following structure

       const char* what          -- Controls what is shown. "N" adds name, "E" adds error,
                                    "A" shows asymmetric error, "U" shows unit, "H" hides the value
       FixedPrecision(int n)     -- Controls precision, set fixed number of digits
       AutoPrecision(int n)      -- Controls precision. Number of shown digits is calculated from error
                                    + n specified additional digits (1 is sensible default)
       VerbatimName(Bool_t flag) -- Put variable name in a \verb+   + clause.

     Example use: list.printLatex(Columns(2), Format("NEU",AutoPrecision(1),VerbatimName()) ) ;

void printLatex(ostream& ofs, Int_t ncol, const char* option, Int_t sigDigit, const RooLinkedList& siblingList, const RooCmdArg* formatCmd) const

     Count number of rows to print

Bool_t allInRange(const char* rangeSpec) const

### Inline Functions

                     TObject* clone(const char* newname) const
                     TObject* create(const char* newname) const
                     TObject* Clone(const char* newname = "0") const
            RooAbsCollection& operator=(const RooAbsCollection& other)
                         void setHashTableSize(Int_t i)
                        Int_t getHashTableSize() const
                       Bool_t contains(const RooAbsArg& var) const
                   TIterator* createIterator(Bool_t dir = kIterForward) const
                        Int_t getSize() const
                   RooAbsArg* first() const
                         void Print(Option_t* options = "0") const
                         void setName(const char* name)
                  const char* GetName() const
                       Bool_t isOwning() const
                      TClass* Class()
                      TClass* IsA() const
                         void ShowMembers(TMemberInspector& insp, char* parent)
                         void Streamer(TBuffer& b)
                         void StreamerNVirtual(TBuffer& b)

Last update: Tue Jun 28 18:09:11 2005
Copyright (c) 2000-2005, Regents of the University of California *