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 () | |
RooExpensiveObjectCache (const RooExpensiveObjectCache &other) | |
~RooExpensiveObjectCache () override | |
Destructor. | |
void | clearAll () |
Clear all cache elements. | |
bool | clearObj (Int_t uniqueID) |
Clear cache element with given unique ID Retrieve payload object of cache element with given unique ID. | |
bool | empty () const |
const TObject * | getObj (Int_t uniqueID) |
Retrieve payload object of cache element with given unique ID. | |
void | importCacheObjects (RooExpensiveObjectCache &other, const char *ownerName, bool verbose=false) |
TClass * | IsA () const override |
void | print () const |
bool | registerObject (const char *ownerName, const char *objectName, TObject &cacheObject, const RooArgSet ¶ms) |
Register object associated with given name and given associated parameters with given values in cache. | |
const TObject * | retrieveObject (const char *name, TClass *tclass, const RooArgSet ¶ms) |
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. | |
bool | setObj (Int_t uniqueID, TObject *obj) |
Place new payload object in cache element with given unique ID. | |
Int_t | size () const |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
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 TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
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 with: gROOT->SetSelectedPad(c1) . | |
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=nullptr) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
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 const char * | GetName () const |
Returns 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) |
Bool_t | IsDestructed () const |
IsDestructed. | |
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 (the base implementation is no-op). | |
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, void *vp) |
Only called by placement new when throwing an exception. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void | operator delete[] (void *ptr, void *vp) |
Only called by placement new[] when throwing an exception. | |
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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. | |
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. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
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=nullptr, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static RooExpensiveObjectCache & | instance () |
Return reference to singleton instance. | |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Longptr_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. | |
Protected Attributes | |
std::map< TString, ExpensiveObject * > | _map |
Int_t | _nextUID = 0 |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
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 () |
#include <RooExpensiveObjectCache.h>
|
inline |
Definition at line 27 of file RooExpensiveObjectCache.h.
|
inline |
Definition at line 28 of file RooExpensiveObjectCache.h.
|
override |
Destructor.
Definition at line 45 of file RooExpensiveObjectCache.cxx.
|
static |
|
inlinestaticconstexpr |
Definition at line 83 of file RooExpensiveObjectCache.h.
void RooExpensiveObjectCache::clearAll | ( | ) |
Clear all cache elements.
Definition at line 164 of file RooExpensiveObjectCache.cxx.
Clear cache element with given unique ID Retrieve payload object of cache element with given unique ID.
Definition at line 131 of file RooExpensiveObjectCache.cxx.
|
inlinestatic |
Definition at line 83 of file RooExpensiveObjectCache.h.
|
inline |
Definition at line 44 of file RooExpensiveObjectCache.h.
Retrieve payload object of cache element with given unique ID.
Definition at line 115 of file RooExpensiveObjectCache.cxx.
void RooExpensiveObjectCache::importCacheObjects | ( | RooExpensiveObjectCache & | other, |
const char * | ownerName, | ||
bool | verbose = false |
||
) |
Definition at line 298 of file RooExpensiveObjectCache.cxx.
|
static |
Return reference to singleton instance.
Definition at line 58 of file RooExpensiveObjectCache.cxx.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 83 of file RooExpensiveObjectCache.h.
void RooExpensiveObjectCache::print | ( | ) | const |
Definition at line 261 of file RooExpensiveObjectCache.cxx.
bool 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 71 of file RooExpensiveObjectCache.cxx.
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 93 of file RooExpensiveObjectCache.cxx.
Place new payload object in cache element with given unique ID.
Cache will take ownership of provided object!
Definition at line 148 of file RooExpensiveObjectCache.cxx.
|
inline |
Definition at line 43 of file RooExpensiveObjectCache.h.
|
overridevirtual |
|
inline |
Definition at line 83 of file RooExpensiveObjectCache.h.
|
protected |
Definition at line 80 of file RooExpensiveObjectCache.h.
|
protected |
Definition at line 78 of file RooExpensiveObjectCache.h.