Logo ROOT  
Reference Guide
RooExpensiveObjectCache Class Reference

RooExpensiveObjectCache is a singleton class that serves as repository for objects that are expensive to calculate. Owners of such objects can registers these here with associated parameter values for which the object is valid, so that other instances can, at a later moment retrieve these precalculated objects.

Definition at line 24 of file RooExpensiveObjectCache.h.

Classes

class  ExpensiveObject
 

Public Member Functions

 RooExpensiveObjectCache ()
 Constructor. More...
 
 RooExpensiveObjectCache (const RooExpensiveObjectCache &)
 Copy constructor. More...
 
virtual ~RooExpensiveObjectCache ()
 Destructor. More...
 
void clearAll ()
 Clear all cache elements. More...
 
Bool_t clearObj (Int_t uniqueID)
 Clear cache element with given unique ID Retrieve payload object of cache element with given unique ID
More...
 
const TObjectgetObj (Int_t uniqueID)
 Retrieve payload object of cache element with given unique ID
More...
 
void importCacheObjects (RooExpensiveObjectCache &other, const char *ownerName, Bool_t verbose=kFALSE)
 
void print () const
 
Bool_t registerObject (const char *ownerName, const char *objectName, TObject &cacheObject, const RooArgSet &params)
 Register object associated with given name and given associated parameters with given values in cache. More...
 
Bool_t registerObject (const char *ownerName, const char *objectName, TObject &cacheObject, TIterator *paramIter)
 Register object associated with given name and given associated parameters with given values in cache. More...
 
const TObjectretrieveObject (const char *name, TClass *tclass, const RooArgSet &params)
 Retrieve object from cache that was registered under given name with given parameters, if current parameter values match those that were stored in the registry for this object. More...
 
Bool_t setObj (Int_t uniqueID, TObject *obj)
 Place new payload object in cache element with given unique ID. More...
 
Int_t size () const
 
- 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 Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object. More...
 
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...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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
 
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. More...
 
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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
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...
 

Static Public Member Functions

static RooExpensiveObjectCacheinstance ()
 Return reference to singleton instance. 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...
 

Protected Attributes

std::map< TString, ExpensiveObject * > _map
 
Int_t _nextUID
 

Additional Inherited Members

- 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)
}
 
- 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 ()
 

#include <RooExpensiveObjectCache.h>

Inheritance diagram for RooExpensiveObjectCache:
[legend]

Constructor & Destructor Documentation

◆ RooExpensiveObjectCache() [1/2]

RooExpensiveObjectCache::RooExpensiveObjectCache ( )

Constructor.

Definition at line 48 of file RooExpensiveObjectCache.cxx.

◆ RooExpensiveObjectCache() [2/2]

RooExpensiveObjectCache::RooExpensiveObjectCache ( const RooExpensiveObjectCache other)

Copy constructor.

Definition at line 57 of file RooExpensiveObjectCache.cxx.

◆ ~RooExpensiveObjectCache()

RooExpensiveObjectCache::~RooExpensiveObjectCache ( )
virtual

Destructor.

Definition at line 67 of file RooExpensiveObjectCache.cxx.

Member Function Documentation

◆ clearAll()

void RooExpensiveObjectCache::clearAll ( )

Clear all cache elements.

Definition at line 203 of file RooExpensiveObjectCache.cxx.

◆ clearObj()

Bool_t RooExpensiveObjectCache::clearObj ( Int_t  uniqueID)

Clear cache element with given unique ID Retrieve payload object of cache element with given unique ID

Definition at line 170 of file RooExpensiveObjectCache.cxx.

◆ getObj()

const TObject * RooExpensiveObjectCache::getObj ( Int_t  uniqueID)

Retrieve payload object of cache element with given unique ID

Definition at line 154 of file RooExpensiveObjectCache.cxx.

◆ importCacheObjects()

void RooExpensiveObjectCache::importCacheObjects ( RooExpensiveObjectCache other,
const char *  ownerName,
Bool_t  verbose = kFALSE 
)

Definition at line 347 of file RooExpensiveObjectCache.cxx.

◆ instance()

RooExpensiveObjectCache & RooExpensiveObjectCache::instance ( )
static

Return reference to singleton instance.

Definition at line 80 of file RooExpensiveObjectCache.cxx.

◆ print()

void RooExpensiveObjectCache::print ( ) const

Definition at line 307 of file RooExpensiveObjectCache.cxx.

◆ registerObject() [1/2]

Bool_t RooExpensiveObjectCache::registerObject ( const char *  ownerName,
const char *  objectName,
TObject cacheObject,
const RooArgSet params 
)

Register object associated with given name and given associated parameters with given values in cache.

The cache will take ownership_of_object and is indexed under the given name (which does not need to be the name of cacheObject and with given set of dependent parameters with validity for the current values of those parameters. It can be retrieved later by callin retrieveObject()

Definition at line 93 of file RooExpensiveObjectCache.cxx.

◆ registerObject() [2/2]

Bool_t RooExpensiveObjectCache::registerObject ( const char *  ownerName,
const char *  objectName,
TObject cacheObject,
TIterator parIter 
)

Register object associated with given name and given associated parameters with given values in cache.

The cache will take ownership_of_object and is indexed under the given name (which does not need to be the name of cacheObject and with given set of dependent parameters with validity for the current values of those parameters. It can be retrieved later by callin retrieveObject()

Definition at line 110 of file RooExpensiveObjectCache.cxx.

◆ retrieveObject()

const TObject * RooExpensiveObjectCache::retrieveObject ( const char *  name,
TClass tc,
const RooArgSet params 
)

Retrieve object from cache that was registered under given name with given parameters, if current parameter values match those that were stored in the registry for this object.

The return object is owned by the cache instance.

Definition at line 132 of file RooExpensiveObjectCache.cxx.

◆ setObj()

Bool_t RooExpensiveObjectCache::setObj ( Int_t  uid,
TObject obj 
)

Place new payload object in cache element with given unique ID.

Cache will take ownership of provided object!

Definition at line 187 of file RooExpensiveObjectCache.cxx.

◆ size()

Int_t RooExpensiveObjectCache::size ( ) const
inline

Definition at line 58 of file RooExpensiveObjectCache.h.

Member Data Documentation

◆ _map

std::map<TString,ExpensiveObject*> RooExpensiveObjectCache::_map
protected

Definition at line 94 of file RooExpensiveObjectCache.h.

◆ _nextUID

Int_t RooExpensiveObjectCache::_nextUID
protected

Definition at line 92 of file RooExpensiveObjectCache.h.

Libraries for RooExpensiveObjectCache:
[legend]

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