Logo ROOT   6.21/01
Reference Guide
RooCategory Class Reference

RooCategory represents a fundamental (non-derived) discrete value object.

The class has a public interface to define the possible value states.

Definition at line 24 of file RooCategory.h.

Public Member Functions

 RooCategory ()
 
 RooCategory (const char *name, const char *title)
 Constructor. Types must be defined using defineType() before variable can be used. More...
 
 RooCategory (const RooCategory &other, const char *name=0)
 Copy constructor. More...
 
virtual ~RooCategory ()
 Destructor. More...
 
void addToRange (const char *rangeName, const char *stateNameList)
 Check that both input arguments are not null pointers. More...
 
void clearRange (const char *name, Bool_t silent)
 Check that both input arguments are not null pointers. More...
 
void clearTypes ()
 
virtual TObjectclone (const char *newname) const
 
Bool_t defineType (const char *label)
 Define a state with given name, the lowest available positive integer is assigned as index. More...
 
Bool_t defineType (const char *label, Int_t index)
 Define a state with given name and index. More...
 
virtual Int_t getIndex () const
 Return index number of current state. More...
 
virtual const char * getLabel () const
 Return label string of current state. More...
 
virtual Bool_t hasRange (const char *rangeName) const
 
virtual Bool_t inRange (const char *rangeName) const
 
virtual Bool_t isDerived () const
 Does value or shape of this arg depend on any other arg? More...
 
virtual Bool_t isFundamental () const
 Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses override this method to return kTRUE. More...
 
Bool_t isStateInRange (const char *rangeName, const char *stateName) const
 If no range is specified [ i.e. the default range ] all category states are in range. More...
 
virtual Bool_t readFromStream (std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
 Read object contents from given stream. More...
 
virtual Bool_t setIndex (Int_t index, Bool_t printError=kTRUE)
 Set value by specifying the index code of the desired state. More...
 
virtual Bool_t setLabel (const char *label, Bool_t printError=kTRUE)
 Set value by specifying the name of the desired state If printError is set, a message will be printed if the specified label does not represent a valid state. More...
 
void setRange (const char *rangeName, const char *stateNameList)
 
virtual void writeToStream (std::ostream &os, Bool_t compact) const
 compact only at the moment More...
 
- Public Member Functions inherited from RooAbsCategoryLValue
 RooAbsCategoryLValue ()
 
 RooAbsCategoryLValue (const char *name, const char *title)
 Constructor. More...
 
 RooAbsCategoryLValue (const RooAbsCategoryLValue &other, const char *name=0)
 Copy constructor. More...
 
virtual ~RooAbsCategoryLValue ()
 Destructor. More...
 
virtual Int_t getBin (const char *rangeName=0) const
 Get index of plot bin for current value this category. More...
 
virtual Int_t getBin (const RooAbsBinning *) const
 
virtual std::list< std::string > getBinningNames () const
 
virtual const RooAbsBinninggetBinningPtr (const char *) const
 
virtual Double_t getBinWidth (Int_t, const char *=0) const
 
virtual Bool_t isLValue () const
 Is this argument an l-value, i.e., can it appear on the left-hand side of an assignment expression? LValues are also special since they can potentially be analytically integrated and generated. More...
 
virtual Int_t numBins (const char *rangeName) const
 Returm the number of fit bins ( = number of types ) More...
 
RooAbsArgoperator= (int index)
 Assignment operator from integer index number. More...
 
RooAbsArgoperator= (const char *label)
 Assignment operator from string pointer. More...
 
RooAbsArgoperator= (const RooAbsCategory &other)
 Assignment from another RooAbsCategory. More...
 
virtual void randomize (const char *rangeName=0)
 Randomize current value. More...
 
virtual void setBin (Int_t ibin, const char *rangeName=0)
 Set category to i-th fit bin, which is the i-th registered state. More...
 
void setConstant (Bool_t value=kTRUE)
 
virtual Double_t volume (const char *rangeName) const
 
- Public Member Functions inherited from RooAbsCategory
 RooAbsCategory ()
 
 RooAbsCategory (const char *name, const char *title)
 Constructor. More...
 
 RooAbsCategory (const RooAbsCategory &other, const char *name=0)
 Copy constructor, copies the registered category states from the original. More...
 
virtual ~RooAbsCategory ()
 Destructor. More...
 
std::vector< RooCatType * >::const_iterator begin () const
 
RooAbsArgcreateFundamental (const char *newname=0) const
 Create a RooCategory fundamental object with our properties. More...
 
Roo1DTablecreateTable (const char *label) const
 Create a table matching the shape of this category. More...
 
std::vector< RooCatType * >::const_iterator end () const
 
virtual RooSpan< const value_typegetValBatch (std::size_t, std::size_t) const
 Retrieve a batch of category values for events in the range [begin, begin+batchSize). More...
 
virtual Bool_t isIdentical (const RooAbsArg &other, Bool_t assumeSameType=kFALSE) const
 
virtual Bool_t isIntegrationSafeLValue (const RooArgSet *) const
 
Bool_t isSignType (Bool_t mustHaveZero=kFALSE) const
 Determine if category has 2 or 3 states with index values -1,0,1. More...
 
Bool_t isValidIndex (value_type index) const
 Check if state with given index is defined. More...
 
Bool_t isValidLabel (const char *label) const
 Check if state with given name is defined. More...
 
const RooCatTypelookupType (value_type index, Bool_t printError=kFALSE) const
 Find our type corresponding to the specified index, or return 0 for no match. More...
 
const RooCatTypelookupType (const char *label, Bool_t printError=kFALSE) const
 Find our type corresponding to the specified label, or return 0 for no match. More...
 
const RooCatTypelookupType (const RooCatType &type, Bool_t printError=kFALSE) const
 Find our type that matches the specified type, or return 0 for no match. More...
 
Int_t numTypes (const char *=0) const
 Return number of types defined (in range named rangeName if rangeName!=0) More...
 
Bool_t operator!= (value_type index)
 
Bool_t operator!= (const char *label)
 
Bool_t operator!= (const RooAbsArg &other)
 
Bool_t operator== (value_type index) const
 Equality operator with a integer (compares with state index number) More...
 
Bool_t operator== (const char *label) const
 Equality operator with a string (compares with state label string) More...
 
virtual Bool_t operator== (const RooAbsArg &other) const
 Equality operator with another RooAbsArg. More...
 
virtual void printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
 Print info about this object to the specified stream. More...
 
virtual void printValue (std::ostream &os) const
 Print value (label name) More...
 
TIteratorR__SUGGEST_ALTERNATIVE ("Use begin(), end() or range-based for loops.") typeIterator() const
 
std::size_t size () const
 
- Public Member Functions inherited from RooAbsArg
 RooAbsArg ()
 Default constructor. More...
 
 RooAbsArg (const char *name, const char *title)
 Create an object with the specified name and descriptive title. More...
 
 RooAbsArg (const RooAbsArg &other, const char *name=0)
 Copy constructor transfers all boolean and string properties of the original object. More...
 
virtual ~RooAbsArg ()
 Destructor. More...
 
Bool_t addOwnedComponents (const RooArgSet &comps)
 Take ownership of the contents of 'comps'. More...
 
void addServer (RooAbsArg &server, Bool_t valueProp=kTRUE, Bool_t shapeProp=kFALSE, std::size_t refCount=1)
 Register another RooAbsArg as a server to us, ie, declare that we depend on it. More...
 
void addServerList (RooAbsCollection &serverList, Bool_t valueProp=kTRUE, Bool_t shapeProp=kFALSE)
 Register a list of RooAbsArg as servers to us by calling addServer() for each arg in the list. More...
 
const char * aggregateCacheUniqueSuffix () const
 
void attachDataSet (const RooAbsData &set)
 Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset. More...
 
void attachDataStore (const RooAbsDataStore &set)
 Replace server nodes with names matching the dataset variable names with those data set variables, making this PDF directly dependent on the dataset. More...
 
const std::set< std::string > & attributes () const
 
void branchNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=0, Bool_t recurseNonDerived=kFALSE) const
 Fill supplied list with all branch nodes of the arg tree starting with ourself as top node. More...
 
virtual const char * cacheUniqueSuffix () const
 
virtual CacheMode canNodeBeCached () const
 
void changeServer (RooAbsArg &server, Bool_t valueProp, Bool_t shapeProp)
 Change dirty flag propagation mask for specified server. More...
 
Bool_t checkDependents (const RooArgSet *nset) const
 
virtual Bool_t checkObservables (const RooArgSet *nset) const
 Overloadable function in which derived classes can implement consistency checks of the variables. More...
 
TIteratorclientIterator () const R__SUGGEST_ALTERNATIVE("Use clients() and begin()
 
const RefCountList_tclients () const
 List of all clients of this object. More...
 
virtual TObjectClone (const char *newname=0) const
 Make a clone of an object using the Streamer facility. More...
 
virtual RooAbsArgcloneTree (const char *newname=0) const
 Clone tree expression of objects. More...
 
Int_t Compare (const TObject *other) const
 Utility function used by TCollection::Sort to compare contained TObjects We implement comparison by name, resulting in alphabetical sorting by object name. More...
 
virtual void constOptimizeTestStatistic (ConstOpCode opcode, Bool_t doAlsoTrackingOpt=kTRUE)
 Interface function signaling a request to perform constant term optimization. More...
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Define default contents to print. More...
 
Bool_t dependentOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const
 
Bool_t dependentOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const
 
Bool_t dependsOn (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=0, Bool_t valueOnly=kFALSE) const
 Test whether we depend on (ie, are served by) any object in the specified collection. More...
 
Bool_t dependsOn (const RooAbsArg &server, const RooAbsArg *ignoreArg=0, Bool_t valueOnly=kFALSE) const
 Test whether we depend on (ie, are served by) the specified object. More...
 
Bool_t dependsOnValue (const RooAbsCollection &serverList, const RooAbsArg *ignoreArg=0) const
 
Bool_t dependsOnValue (const RooAbsArg &server, const RooAbsArg *ignoreArg=0) const
 
TIterator end () or range-based loops.")
 
TIterator end () or range-based loops.")
 
TIterator end () or range-based loops.")
 
TIterator end () or range-based loops.")
 
RooFIter end () or range-based loops.")
 
RooFIter end () or range-based loops.")
 
RooFIter end () or range-based loops.")
 
RooExpensiveObjectCacheexpensiveObjectCache () const
 
Bool_t findConstantNodes (const RooArgSet &observables, RooArgSet &cacheList)
 Find branch nodes with all-constant parameters, and add them to the list of nodes that can be cached with a dataset in a test statistic calculation. More...
 
Bool_t findConstantNodes (const RooArgSet &observables, RooArgSet &cacheList, RooLinkedList &processedNodes)
 Find branch nodes with all-constant parameters, and add them to the list of nodes that can be cached with a dataset in a test statistic calculation. More...
 
RooAbsArgfindNewServer (const RooAbsCollection &newSet, Bool_t nameChange) const
 Find the new server in the specified set that matches the old server. More...
 
RooAbsArgfindServer (const char *name) const
 Return server of this with name name. Returns nullptr if not found. More...
 
RooAbsArgfindServer (const RooAbsArg &arg) const
 Return server of this that has the same name as arg. Returns nullptr if not found. More...
 
RooAbsArgfindServer (Int_t index) const
 Return i-th server from server list. More...
 
Bool_t getAttribute (const Text_t *name) const
 Check if a named attribute is set. By default, all attributes are unset. More...
 
RooAbsCachegetCache (Int_t index) const
 Return registered cache object by index. More...
 
RooLinkedList getCloningAncestors () const
 Return ancestors in cloning chain of this RooAbsArg. More...
 
RooArgSetgetComponents () const
 
RooArgSetgetDependents (const RooArgSet &set) const
 
RooArgSetgetDependents (const RooAbsData *set) const
 
RooArgSetgetDependents (const RooArgSet *depList) const
 
RooArgSetgetObservables (const RooArgSet &set, Bool_t valueOnly=kTRUE) const
 Return the observables of this pdf given a set of observables. More...
 
RooArgSetgetObservables (const RooAbsData *data) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names of the variable list of the supplied data set (the dependents). More...
 
RooArgSetgetObservables (const RooAbsData &data) const
 Return the observables of this pdf given the observables defined by data. More...
 
RooArgSetgetObservables (const RooArgSet *depList, Bool_t valueOnly=kTRUE) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that match any of the names the args in the supplied argset. More...
 
RooArgSetgetParameters (const RooAbsData *data, Bool_t stripDisconnected=kTRUE) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that don't match any of the names of the variable list of the supplied data set (the dependents). More...
 
RooArgSetgetParameters (const RooAbsData &data, Bool_t stripDisconnected=kTRUE) const
 Return the parameters of this p.d.f when used in conjuction with dataset 'data'. More...
 
RooArgSetgetParameters (const RooArgSet &observables, Bool_t stripDisconnected=kTRUE) const
 Return the parameters of the p.d.f given the provided set of observables. More...
 
virtual RooArgSetgetParameters (const RooArgSet *depList, Bool_t stripDisconnected=kTRUE) const
 Create a list of leaf nodes in the arg tree starting with ourself as top node that don't match any of the names the args in the supplied argset. More...
 
const Text_tgetStringAttribute (const Text_t *key) const
 Get string attribute mapped under key 'key'. More...
 
Bool_t getTransientAttribute (const Text_t *name) const
 Check if a named attribute is set. More...
 
RooArgSetgetVariables (Bool_t stripDisconnected=kTRUE) const
 Return RooArgSet with all variables (tree leaf nodes of expresssion tree) More...
 
void graphVizTree (const char *fileName, const char *delimiter="\, bool useTitle=false, bool useLatex=false)
 Create a GraphViz .dot file visualizing the expression tree headed by this RooAbsArg object. More...
 
void graphVizTree (std::ostream &os, const char *delimiter="\, bool useTitle=false, bool useLatex=false)
 Write the GraphViz representation of the expression tree headed by this RooAbsArg object to the given ostream. More...
 
Bool_t hasClients () const
 
virtual Bool_t importWorkspaceHook (RooWorkspace &ws)
 
Bool_t isCloneOf (const RooAbsArg &other) const
 Check if this object was created as a clone of 'other'. More...
 
Bool_t isConstant () const
 
Bool_t isShapeDirty () const
 
Bool_t isShapeServer (const RooAbsArg &arg) const
 Check if this is serving shape to arg. More...
 
Bool_t isShapeServer (const char *name) const
 Check if this is serving shape to an object with name name. More...
 
virtual Bool_t IsSortable () const
 
Bool_t isValueDirty () const
 
Bool_t isValueDirtyAndClear () const
 
Bool_t isValueOrShapeDirtyAndClear () const
 
Bool_t isValueServer (const RooAbsArg &arg) const
 Check if this is serving values to arg. More...
 
Bool_t isValueServer (const char *name) const
 Check if this is serving values to an object with name name. More...
 
void leafNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=0, Bool_t recurseNonDerived=kFALSE) const
 Fill supplied list with all leaf nodes of the arg tree, starting with ourself as top node. More...
 
Bool_t localNoDirtyInhibit () const
 
const TNamednamePtr () const
 
Int_t numCaches () const
 Return number of registered caches. More...
 
Bool_t observableOverlaps (const RooAbsData *dset, const RooAbsArg &testArg) const
 Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg. More...
 
Bool_t observableOverlaps (const RooArgSet *depList, const RooAbsArg &testArg) const
 Test if any of the dependents of the arg tree (as determined by getObservables) overlaps with those of the testArg. More...
 
RooAbsArgoperator= (const RooAbsArg &other)
 Assign all boolean and string properties of the original object. More...
 
OperMode operMode () const
 
virtual void optimizeCacheMode (const RooArgSet &observables)
 Activate cache mode optimization with given definition of observables. More...
 
virtual void optimizeCacheMode (const RooArgSet &observables, RooArgSet &optNodes, RooLinkedList &processedNodes)
 Activate cache mode optimization with given definition of observables. More...
 
Bool_t overlaps (const RooAbsArg &testArg, Bool_t valueOnly=kFALSE) const
 Test if any of the nodes of tree are shared with that of the given tree. More...
 
const RooArgSetownedComponents () const
 
virtual void Print (Option_t *options=0) const
 Print the object to the defaultPrintStream(). More...
 
virtual void printAddress (std::ostream &os) const
 Print class name of object. More...
 
virtual void printArgs (std::ostream &os) const
 Print object arguments, ie its proxies. More...
 
virtual void printClassName (std::ostream &os) const
 Print object class name. More...
 
void printCompactTree (const char *indent="", const char *fileName=0, const char *namePat=0, RooAbsArg *client=0)
 Print tree structure of expression tree on stdout, or to file if filename is specified. More...
 
void printCompactTree (std::ostream &os, const char *indent="", const char *namePat=0, RooAbsArg *client=0)
 Print tree structure of expression tree on given ostream. More...
 
virtual void printCompactTreeHook (std::ostream &os, const char *ind="")
 Hook function interface for object to insert additional information when printed in the context of a tree structure. More...
 
void printComponentTree (const char *indent="", const char *namePat=0, Int_t nLevel=999)
 Print tree structure of expression tree on given ostream, only branch nodes are printed. More...
 
void printDirty (Bool_t depth=kTRUE) const
 Print information about current value dirty state information. More...
 
virtual void printMetaArgs (std::ostream &) const
 
virtual void printName (std::ostream &os) const
 Print object name. More...
 
virtual void printTitle (std::ostream &os) const
 Print object title. More...
 
virtual void printTree (std::ostream &os, TString indent="") const
 Print object tree structure. More...
 
Bool_t recursiveCheckDependents (const RooArgSet *nset) const
 
Bool_t recursiveCheckObservables (const RooArgSet *nset) const
 Recursively call checkObservables on all nodes in the expression tree. More...
 
Bool_t recursiveRedirectServers (const RooAbsCollection &newServerList, Bool_t mustReplaceAll=kFALSE, Bool_t nameChange=kFALSE, Bool_t recurseInNewSet=kTRUE)
 
Bool_t redirectServers (const RooAbsCollection &newServerList, Bool_t mustReplaceAll=kFALSE, Bool_t nameChange=kFALSE, Bool_t isRecursionStep=kFALSE)
 Substitute our servers with those listed in newSet. More...
 
virtual Bool_t redirectServersHook (const RooAbsCollection &, Bool_t, Bool_t, Bool_t)
 
void registerCache (RooAbsCache &cache)
 Register RooAbsCache with this object. More...
 
void removeServer (RooAbsArg &server, Bool_t force=kFALSE)
 Unregister another RooAbsArg as a server to us, ie, declare that we no longer depend on its value and shape. More...
 
void replaceServer (RooAbsArg &oldServer, RooAbsArg &newServer, Bool_t valueProp, Bool_t shapeProp)
 Replace 'oldServer' with 'newServer'. More...
 
TIteratorserverIterator () const R__SUGGEST_ALTERNATIVE("Use servers() and begin()
 
RooFIter serverMIterator () const R__SUGGEST_ALTERNATIVE("Use shapeClients() and begin()
 
virtual void serverNameChangeHook (const RooAbsArg *, const RooAbsArg *)
 
const RefCountList_tservers () const
 List of all servers of this object. More...
 
void setAttribute (const Text_t *name, Bool_t value=kTRUE)
 Set (default) or clear a named boolean attribute of this object. More...
 
virtual void setCacheAndTrackHints (RooArgSet &)
 
virtual void setExpensiveObjectCache (RooExpensiveObjectCache &cache)
 
void setLocalNoDirtyInhibit (Bool_t flag) const
 
void SetName (const char *name)
 Set the name of the TNamed. More...
 
void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
void setOperMode (OperMode mode, Bool_t recurseADirty=kTRUE)
 Change cache operation mode to given mode. More...
 
void setProhibitServerRedirect (Bool_t flag)
 
void setShapeDirty ()
 Notify that a shape-like property (e.g. binning) has changed. More...
 
void setStringAttribute (const Text_t *key, const Text_t *value)
 Associate string 'value' to this object under key 'key'. More...
 
void setTransientAttribute (const Text_t *name, Bool_t value=kTRUE)
 Set (default) or clear a named boolean attribute of this object. More...
 
void setValueDirty ()
 Mark the element dirty. This forces a re-evaluation when a value is requested. More...
 
void setWorkspace (RooWorkspace &ws)
 
TIteratorshapeClientIterator () const R__SUGGEST_ALTERNATIVE("Use shapeClients() and begin()
 
RooFIter shapeClientMIterator () const R__SUGGEST_ALTERNATIVE("Use shapeClients() and begin()
 
const RefCountList_tshapeClients () const
 List of all shape clients of this object. More...
 
const std::map< std::string, std::string > & stringAttributes () const
 
const std::set< std::string > & transientAttributes () const
 
void treeNodeServerList (RooAbsCollection *list, const RooAbsArg *arg=0, Bool_t doBranch=kTRUE, Bool_t doLeaf=kTRUE, Bool_t valueOnly=kFALSE, Bool_t recurseNonDerived=kFALSE) const
 Fill supplied list with nodes of the arg tree, following all server links, starting with ourself as top node. More...
 
void unRegisterCache (RooAbsCache &cache)
 Unregister a RooAbsCache. Called from the RooAbsCache destructor. More...
 
TIteratorvalueClientIterator () const R__SUGGEST_ALTERNATIVE("Use valueClients() and begin()
 
RooFIter valueClientMIterator () const R__SUGGEST_ALTERNATIVE("Use valueClients() and begin()
 
const RefCountList_tvalueClients () const
 List of all value clients of this object. Value clients receive value updates. More...
 
void wireAllCaches ()
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
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). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
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'. More...
 
- Public Member Functions inherited from RooAbsLValue
 RooAbsLValue ()
 Constructor. More...
 
virtual ~RooAbsLValue ()
 Destructor. More...
 

Protected Member Functions

virtual RooCatType evaluate () const
 Shared properties associated with this instance. More...
 
- Protected Member Functions inherited from RooAbsCategoryLValue
void copyCache (const RooAbsArg *source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE)
 Copy the cached value from given source and raise dirty flag. More...
 
virtual void setIndexFast (Int_t index)
 
Bool_t setOrdinal (UInt_t index, const char *rangeName)
 Set our state to our n'th defined type and return kTRUE. More...
 
- Protected Member Functions inherited from RooAbsCategory
virtual void attachToTree (TTree &t, Int_t bufSize=32000)
 Attach the category index and label to as branches to the given TTree. More...
 
virtual void attachToVStore (RooVectorDataStore &vstore)
 Attach the category index and label to as branches to the given vector store. More...
 
void clearTypes ()
 Delete all currently defined states. More...
 
const RooCatTypedefineType (const char *label)
 Define a new state with given name. More...
 
const RooCatTypedefineType (const char *label, value_type index)
 Define new state with given name and index number. More...
 
const RooCatTypedefineTypeUnchecked (const char *label, value_type index)
 Internal version of defineType that does not check if type already exists. More...
 
virtual void fillTreeBranch (TTree &t)
 Fill tree branches associated with current object with current value. More...
 
const RooCatTypegetOrdinal (UInt_t n, const char *rangeName=0) const
 Return state definition of ordinal nth defined state, needed by the generator mechanism. More...
 
virtual Bool_t isValid () const
 Check if current value is a valid state. More...
 
virtual Bool_t isValid (const RooCatType &value) const
 Check if given state is defined for this object. More...
 
virtual void setTreeBranchStatus (TTree &t, Bool_t active)
 (De)activate associate tree branch More...
 
virtual void syncCache (const RooArgSet *set=0)
 Explicitly synchronize RooAbsCategory internal cache. More...
 
RooCatType traceEval () const
 Recalculate current value and check validity of new result. More...
 
virtual Bool_t traceEvalHook (RooCatType) const
 
- Protected Member Functions inherited from RooAbsArg
void attachToStore (RooAbsDataStore &store)
 Attach this argument to the data store such that it reads data from there. More...
 
TString cleanBranchName () const
 Construct a mangled name from the actual name that is free of any math symbols that might be interpreted by TTree. More...
 
void clearShapeDirty () const
 
void clearValueAndShapeDirty () const
 
void clearValueDirty () const
 
virtual void getObservablesHook (const RooArgSet *, RooArgSet *) const
 
virtual void getParametersHook (const RooArgSet *, RooArgSet *, Bool_t) const
 
RooAbsProxygetProxy (Int_t index) const
 Return the nth proxy from the proxy list. More...
 
void graphVizAddConnections (std::set< std::pair< RooAbsArg *, RooAbsArg *> > &)
 Utility function that inserts all point-to-point client-server connections between any two RooAbsArgs in the expression tree headed by this object in the linkSet argument. More...
 
Bool_t inhibitDirty () const
 Delete watch flag. More...
 
virtual void ioStreamerPass2 ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass. More...
 
Int_t numProxies () const
 Return the number of registered proxies. More...
 
virtual void operModeHook ()
 
virtual void optimizeDirtyHook (const RooArgSet *)
 
void printAttribList (std::ostream &os) const
 Transient boolean attributes (not copied in ctor) More...
 
void registerProxy (RooArgProxy &proxy)
 Register an RooArgProxy in the proxy list. More...
 
void registerProxy (RooSetProxy &proxy)
 Register an RooSetProxy in the proxy list. More...
 
void registerProxy (RooListProxy &proxy)
 Register an RooListProxy in the proxy list. More...
 
void setProxyNormSet (const RooArgSet *nset)
 Forward a change in the cached normalization argset to all the registered proxies. More...
 
void setShapeDirty (const RooAbsArg *source)
 Notify that a shape-like property (e.g. binning) has changed. More...
 
void setValueDirty (const RooAbsArg *source)
 Force element to re-evaluate itself when a value is requested. More...
 
void unRegisterProxy (RooArgProxy &proxy)
 Remove proxy from proxy list. More...
 
void unRegisterProxy (RooSetProxy &proxy)
 Remove proxy from proxy list. More...
 
void unRegisterProxy (RooListProxy &proxy)
 Remove proxy from proxy list. More...
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

RooCategorySharedProperties_sharedProp
 
- Protected Attributes inherited from RooAbsCategory
UChar_t _byteValue
 
Bool_t _treeVar
 
std::vector< RooCatType * > _types
 
RooCatType _value
 Transient cache for byte values from tree branches. More...
 
- Protected Attributes inherited from RooAbsArg
bool _allBatchesDirty {true}
 
std::set< std::string > _boolAttrib
 
std::set< std::string > _boolAttribTransient
 
std::deque< RooAbsCache * > _cacheList
 
RefCountList_t _clientList
 
RefCountList_t _clientListShape
 
RefCountList_t _clientListValue
 
Bool_t _deleteWatch
 
RooExpensiveObjectCache_eocache
 Prohibit server redirects – Debugging tool. More...
 
Bool_t _fast
 
Bool_t _isConstant
 Do not persist. Pointer to global instance of string that matches object named. More...
 
Bool_t _localNoInhibitDirty
 Cached isConstant status. More...
 
RooWorkspace_myws
 Prevent 'AlwaysDirty' mode for this node. More...
 
TNamed_namePtr
 
OperMode _operMode
 Mark batches as dirty (only meaningful for RooAbsReal). More...
 
RooArgSet_ownedComponents
 
Bool_t _prohibitServerRedirect
 Set of owned component. More...
 
RooRefArray _proxyList
 
RefCountList_t _serverList
 
Bool_t _shapeDirty
 
std::map< std::string, std::string > _stringAttrib
 
Bool_t _valueDirty
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Static Protected Attributes

static RooCategorySharedProperties _nullProp
 
static RooSharedPropertiesList _sharedPropList
 
- Static Protected Attributes inherited from RooAbsArg
static Bool_t _inhibitDirty
 
static std::stack< RooAbsArg * > _ioReadStack
 
static Bool_t _verboseDirty
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

Additional Inherited Members

- Public Types inherited from RooAbsCategory
using value_type = int
 The type used to denote a specific category state. More...
 
- Public Types inherited from RooAbsArg
enum  CacheMode { Always =0, NotAdvised =1, Never =2 }
 
enum  ConstOpCode { Activate =0, DeActivate =1, ConfigChange =2, ValueChange =3 }
 
enum  OperMode { Auto =0, AClean =1, ADirty =2 }
 
using RefCountList_t = RooSTLRefCountList< RooAbsArg >
 
using RefCountListLegacyIterator_t = TIteratorToSTLInterface< RefCountList_t::Container_t >
 
- 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 RooAbsArg
static void setDirtyInhibit (Bool_t flag)
 Control global dirty inhibit mode. More...
 
static void verboseDirty (Bool_t flag)
 Activate verbose messaging related to dirty flag propagation. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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(). More...
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. More...
 
- Static Public Attributes inherited from RooAbsArg
static std::map< RooAbsArg *, TRefArray * > _ioEvoList
 
- Static Protected Member Functions inherited from RooAbsArg
static void ioStreamerPass2Finalize ()
 Method called by workspace container to finalize schema evolution issues that cannot be handled in a single ioStreamer pass. More...
 

#include <RooCategory.h>

Inheritance diagram for RooCategory:
[legend]

Constructor & Destructor Documentation

◆ RooCategory() [1/3]

RooCategory::RooCategory ( )

Definition at line 51 of file RooCategory.cxx.

◆ RooCategory() [2/3]

RooCategory::RooCategory ( const char *  name,
const char *  title 
)

Constructor. Types must be defined using defineType() before variable can be used.

Definition at line 61 of file RooCategory.cxx.

◆ RooCategory() [3/3]

RooCategory::RooCategory ( const RooCategory other,
const char *  name = 0 
)

Copy constructor.

Definition at line 76 of file RooCategory.cxx.

◆ ~RooCategory()

RooCategory::~RooCategory ( )
virtual

Destructor.

Definition at line 88 of file RooCategory.cxx.

Member Function Documentation

◆ addToRange()

void RooCategory::addToRange ( const char *  rangeName,
const char *  stateNameList 
)

Check that both input arguments are not null pointers.

Definition at line 228 of file RooCategory.cxx.

◆ clearRange()

void RooCategory::clearRange ( const char *  name,
Bool_t  silent 
)

Check that both input arguments are not null pointers.

Definition at line 196 of file RooCategory.cxx.

◆ clearTypes()

void RooCategory::clearTypes ( )
inline

Definition at line 67 of file RooCategory.h.

◆ clone()

virtual TObject* RooCategory::clone ( const char *  newname) const
inlinevirtual

Implements RooAbsArg.

Definition at line 31 of file RooCategory.h.

◆ defineType() [1/2]

Bool_t RooCategory::defineType ( const char *  label)

Define a state with given name, the lowest available positive integer is assigned as index.

Category state labels may not contain semicolons. Error status is return if state with given name is already defined

Definition at line 136 of file RooCategory.cxx.

◆ defineType() [2/2]

Bool_t RooCategory::defineType ( const char *  label,
Int_t  index 
)

Define a state with given name and index.

Category state labels may not contain semicolons Error status is return if state with given name or index is already defined

Definition at line 154 of file RooCategory.cxx.

◆ evaluate()

virtual RooCatType RooCategory::evaluate ( ) const
inlineprotectedvirtual

Shared properties associated with this instance.

Implements RooAbsCategory.

Definition at line 88 of file RooCategory.h.

◆ getIndex()

virtual Int_t RooCategory::getIndex ( ) const
inlinevirtual

Return index number of current state.

Reimplemented from RooAbsCategory.

Definition at line 34 of file RooCategory.h.

◆ getLabel()

virtual const char* RooCategory::getLabel ( ) const
inlinevirtual

Return label string of current state.

Reimplemented from RooAbsCategory.

Definition at line 39 of file RooCategory.h.

◆ hasRange()

virtual Bool_t RooCategory::hasRange ( const char *  rangeName) const
inlinevirtual

Reimplemented from RooAbsArg.

Definition at line 77 of file RooCategory.h.

◆ inRange()

virtual Bool_t RooCategory::inRange ( const char *  rangeName) const
inlinevirtual

Reimplemented from RooAbsArg.

Definition at line 73 of file RooCategory.h.

◆ isDerived()

virtual Bool_t RooCategory::isDerived ( ) const
inlinevirtual

Does value or shape of this arg depend on any other arg?

Reimplemented from RooAbsArg.

Definition at line 60 of file RooCategory.h.

◆ isFundamental()

virtual Bool_t RooCategory::isFundamental ( ) const
inlinevirtual

Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses override this method to return kTRUE.

Note that this test is subtlely different from the dynamic isDerived() test, e.g. a constant is not derived but is also not fundamental.

Reimplemented from RooAbsArg.

Definition at line 55 of file RooCategory.h.

◆ isStateInRange()

Bool_t RooCategory::isStateInRange ( const char *  rangeName,
const char *  stateName 
) const

If no range is specified [ i.e. the default range ] all category states are in range.

Definition at line 273 of file RooCategory.cxx.

◆ readFromStream()

Bool_t RooCategory::readFromStream ( std::istream &  is,
Bool_t  compact,
Bool_t  verbose = kFALSE 
)
virtual

Read object contents from given stream.

Reimplemented from RooAbsCategoryLValue.

Definition at line 169 of file RooCategory.cxx.

◆ setIndex()

Bool_t RooCategory::setIndex ( Int_t  index,
Bool_t  printError = kTRUE 
)
virtual

Set value by specifying the index code of the desired state.

If printError is set, a message will be printed if the specified index does not represent a valid state.

Implements RooAbsCategoryLValue.

Definition at line 102 of file RooCategory.cxx.

◆ setLabel()

Bool_t RooCategory::setLabel ( const char *  label,
Bool_t  printError = kTRUE 
)
virtual

Set value by specifying the name of the desired state If printError is set, a message will be printed if the specified label does not represent a valid state.

Implements RooAbsCategoryLValue.

Definition at line 118 of file RooCategory.cxx.

◆ setRange()

void RooCategory::setRange ( const char *  rangeName,
const char *  stateNameList 
)

Definition at line 217 of file RooCategory.cxx.

◆ writeToStream()

void RooCategory::writeToStream ( std::ostream &  os,
Bool_t  compact 
) const
virtual

compact only at the moment

Reimplemented from RooAbsCategoryLValue.

Definition at line 183 of file RooCategory.cxx.

Member Data Documentation

◆ _nullProp

RooCategorySharedProperties RooCategory::_nullProp
staticprotected

Definition at line 85 of file RooCategory.h.

◆ _sharedProp

RooCategorySharedProperties* RooCategory::_sharedProp
protected

Definition at line 86 of file RooCategory.h.

◆ _sharedPropList

RooSharedPropertiesList RooCategory::_sharedPropList
staticprotected

Definition at line 84 of file RooCategory.h.

Libraries for RooCategory:
[legend]

The documentation for this class was generated from the following files: