/***************************************************************************** * Project: RooFit * * Package: RooFitCore * * File: $Id: RooAbsCollection.h,v 1.26 2007/08/09 19:55:47 wouter Exp $ * Authors: * * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu * * DK, David Kirkby, UC Irvine, dkirkby@uci.edu * * * * Copyright (c) 2000-2005, Regents of the University of California * * and Stanford University. All rights reserved. * * * * Redistribution and use in source and binary forms, * * with or without modification, are permitted according to the terms * * listed in LICENSE (http://roofit.sourceforge.net/license.txt) * *****************************************************************************/ #ifndef ROO_ABS_COLLECTION #define ROO_ABS_COLLECTION #include "TString.h" #include "RooAbsArg.h" #include "RooPrintable.h" #include "RooLinkedList.h" #include "RooCmdArg.h" #include "RooLinkedListIter.h" #include class RooAbsCollection : public TObject, public RooPrintable { public: // Constructors, assignment etc. RooAbsCollection(); RooAbsCollection(const char *name); virtual TObject* clone(const char* newname) const = 0 ; virtual TObject* create(const char* newname) const = 0 ; virtual TObject* Clone(const char* newname=0) const { return clone(newname?newname:GetName()) ; } virtual ~RooAbsCollection(); // Create a copy of an existing list. New variables cannot be added // to a copied list. The variables in the copied list are independent // of the original variables. RooAbsCollection(const RooAbsCollection& other, const char *name=""); RooAbsCollection& operator=(const RooAbsCollection& other); RooAbsCollection& assignValueOnly(const RooAbsCollection& other, Bool_t oneSafe=kFALSE) ; void assignFast(const RooAbsCollection& other, Bool_t setValDirty=kTRUE) ; // Copy list and contents (and optionally 'deep' servers) RooAbsCollection *snapshot(Bool_t deepCopy=kTRUE) const ; Bool_t snapshot(RooAbsCollection& output, Bool_t deepCopy=kTRUE) const ; // Hash table control void setHashTableSize(Int_t i) { // Set size of internal hash table to i (should be a prime number) _list.setHashTableSize(i) ; } Int_t getHashTableSize() const { // Return size of internal hash table return _list.getHashTableSize() ; } // List content management virtual Bool_t add(const RooAbsArg& var, Bool_t silent=kFALSE) ; virtual Bool_t addOwned(RooAbsArg& var, Bool_t silent=kFALSE); virtual RooAbsArg *addClone(const RooAbsArg& var, Bool_t silent=kFALSE) ; virtual Bool_t replace(const RooAbsArg& var1, const RooAbsArg& var2) ; virtual Bool_t remove(const RooAbsArg& var, Bool_t silent=kFALSE, Bool_t matchByNameOnly=kFALSE) ; virtual void removeAll() ; virtual Bool_t add(const RooAbsCollection& list, Bool_t silent=kFALSE) ; virtual Bool_t addOwned(const RooAbsCollection& list, Bool_t silent=kFALSE); virtual void addClone(const RooAbsCollection& list, Bool_t silent=kFALSE); Bool_t replace(const RooAbsCollection &other); Bool_t remove(const RooAbsCollection& list, Bool_t silent=kFALSE, Bool_t matchByNameOnly=kFALSE) ; // Group operations on AbsArgs void setAttribAll(const Text_t* name, Bool_t value=kTRUE) ; // List search methods RooAbsArg *find(const char *name) const ; RooAbsArg *find(const RooAbsArg&) const ; Bool_t contains(const RooAbsArg& var) const { // Returns true if object with same name as var is contained in this collection return (0 == find(var)) ? kFALSE:kTRUE; } Bool_t containsInstance(const RooAbsArg& var) const { // Returns true if var is contained in this collection return (0 == _list.FindObject(&var)) ? kFALSE:kTRUE; } RooAbsCollection* selectByAttrib(const char* name, Bool_t value) const ; RooAbsCollection* selectCommon(const RooAbsCollection& refColl) const ; RooAbsCollection* selectByName(const char* nameList, Bool_t verbose=kFALSE) const ; Bool_t equals(const RooAbsCollection& otherColl) const ; Bool_t overlaps(const RooAbsCollection& otherColl) const ; // export subset of THashList interface inline TIterator* createIterator(Bool_t dir = kIterForward) const { // Create and return an iterator over the elements in this collection return _list.MakeIterator(dir); } RooLinkedListIter iterator(Bool_t dir = kIterForward) const ; RooFIter fwdIterator() const { return RooFIter(&_list); } inline Int_t getSize() const { // Return the number of elements in the collection return _list.GetSize(); } inline RooAbsArg *first() const { // Return the first element in this collection return (RooAbsArg*)_list.First(); } inline virtual void Print(Option_t *options= 0) const { // Printing interface (human readable) printStream(defaultPrintStream(),defaultPrintContents(options),defaultPrintStyle(options)); } std::string contentsString() const ; virtual void printName(std::ostream& os) const ; virtual void printTitle(std::ostream& os) const ; virtual void printClassName(std::ostream& os) const ; virtual void printValue(std::ostream& os) const ; virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ; virtual Int_t defaultPrintContents(Option_t* opt) const ; // Latex printing methods 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(std::ostream& ofs, Int_t ncol, const char* option="NEYU", Int_t sigDigit=1, const RooLinkedList& siblingLists=RooLinkedList(), const RooCmdArg* formatCmd=0) const ; void setName(const char *name) { // Set name of collection _name= name; } const char* GetName() const { // Return namer of collection return _name.Data() ; } Bool_t isOwning() const { // Does collection own contents? return _ownCont ; } Bool_t allInRange(const char* rangeSpec) const ; void dump() const ; void releaseOwnership() { _ownCont = kFALSE ; } void takeOwnership() { _ownCont = kTRUE ; } void sort(Bool_t ascend=kTRUE) { _list.Sort(ascend) ; } protected: friend class RooMultiCatIter ; RooLinkedList _list ; // Actual object store Bool_t _ownCont; // Flag to identify a list that owns its contents. TString _name; // Our name. Bool_t _allRRV ; // All contents are RRV void safeDeleteList() ; // Support for snapshot method Bool_t addServerClonesToList(const RooAbsArg& var) ; inline TNamed* structureTag() { if (_structureTag==0) makeStructureTag() ; return _structureTag ; } inline TNamed* typedStructureTag() { if (_typedStructureTag==0) makeTypedStructureTag() ; return _typedStructureTag ; } mutable TNamed* _structureTag ; //! Structure tag mutable TNamed* _typedStructureTag ; //! Typed structure tag inline void clearStructureTags() { _structureTag=0 ; _typedStructureTag = 0 ; } void makeStructureTag() ; void makeTypedStructureTag() ; private: ClassDef(RooAbsCollection,2) // Collection of RooAbsArg objects }; #endif