Logo ROOT   6.21/01
Reference Guide
RooTemplateProxy< T > Class Template Reference

template<class T>
class RooTemplateProxy< T >


A RooTemplateProxy is used to hold references to other objects in an expression tree.

A RooGaussian(..., x, mean, sigma) e.g. stores x, mean, sigma as RooRealProxy (= RooTemplateProxy<RooAbsReal>.

This allows access to their current values, to retrieve batches of observable data, and it automatically registers these variables as "servers" of the Gaussian.

Renaming or exchanging objects that serve values to the owner of the proxy is handled automatically.

A few typedefs have been defined:

Definition at line 44 of file RooTemplateProxy.h.

Public Member Functions

 RooTemplateProxy ()
 
 RooTemplateProxy (const char *theName, const char *desc, RooAbsArg *owner, Bool_t valueServer=true, Bool_t shapeServer=false, Bool_t proxyOwnsArg=false)
 Constructor with owner. More...
 
 RooTemplateProxy (const char *theName, const char *desc, RooAbsArg *owner, T &ref, Bool_t valueServer=true, Bool_t shapeServer=false, Bool_t proxyOwnsArg=false)
 Constructor with owner and proxied real-valued object. More...
 
 RooTemplateProxy (const char *theName, RooAbsArg *owner, const RooTemplateProxy &other)
 Copy constructor. More...
 
const T & arg () const
 Return reference to object held in proxy. More...
 
virtual TObjectClone (const char *newName=0) const
 Make a clone of an object using the Streamer facility. More...
 
RooSpan< const double > getValBatch (std::size_t begin, std::size_t batchSize) const
 
Bool_t hasMax (const char *rname=0) const
 Check if the range has a upper bound. This requires the payload to be RooAbsRealLValue or derived. More...
 
Bool_t hasMin (const char *rname=0) const
 Check if the range has a lower bound. This requires the payload to be RooAbsRealLValue or derived. More...
 
Double_t max (const char *rname=0) const
 Query upper limit of range. This requires the payload to be RooAbsRealLValue or derived. More...
 
Double_t min (const char *rname=0) const
 Query lower limit of range. This requires the payload to be RooAbsRealLValue or derived. More...
 
 operator Double_t () const
 
RooTemplateProxy< T > & operator= (const Double_t &value)
 Assign a new value to the object pointed to by the proxy. This requires the payload to be assignable (RooAbsRealLValue or derived). More...
 
Bool_t setArg (T &newRef)
 Change object held in proxy into newRef. More...
 
- Public Member Functions inherited from RooArgProxy
 RooArgProxy ()
 
 RooArgProxy (const char *name, const char *desc, RooAbsArg *owner, Bool_t valueServer, Bool_t shapeServer, Bool_t proxyOwnsArg=kFALSE)
 Constructor with owner and proxied variable. More...
 
 RooArgProxy (const char *name, const char *desc, RooAbsArg *owner, RooAbsArg &arg, Bool_t valueServer, Bool_t shapeServer, Bool_t proxyOwnsArg=kFALSE)
 Constructor with owner and proxied variable. More...
 
 RooArgProxy (const char *name, RooAbsArg *owner, const RooArgProxy &other)
 Copy constructor. More...
 
virtual ~RooArgProxy ()
 Destructor. More...
 
RooAbsArgabsArg () const
 
virtual const char * name () const
 
virtual void print (std::ostream &os, Bool_t addContents=kFALSE) const
 Print the name of the proxy on ostream. More...
 
- 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 Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. 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 Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). 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 RooAbsProxy
 RooAbsProxy ()
 Constructor. More...
 
 RooAbsProxy (const char *name, const RooAbsProxy &other)
 Copy constructor. More...
 
virtual ~RooAbsProxy ()
 
const RooArgSetnset () const
 

Private Member Functions

RooAbsRealLValuelvptr () const
 Return l-value pointer to contents. More...
 
RooAbsRealLValuelvptr_impl (RooAbsRealLValue *) const
 Overload when the class template parameter is RooAbsRealLValue or more derived. Just returns the pointer. More...
 
RooAbsRealLValuelvptr_impl (RooAbsArg *) const R__SUGGEST_ALTERNATIVE("Change the template parameter to RooAbsRealLValue or more derived when using functions that assume that the proxied object is RooAbsRealLValue.")
 Overload for cases where the class template parameter is does not derive from RooAbsRealLValue. More...
 

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)
}
 
- 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 Member Functions inherited from RooArgProxy
virtual void changeDataSet (const RooArgSet *newNormSet)
 Change the normalization set that should be offered to the content objects getVal() when evaluated. More...
 
virtual Bool_t changePointer (const RooAbsCollection &newServerSet, Bool_t nameChange=kFALSE, Bool_t factoryInitMode=kFALSE)
 Change proxied object to object of same name in given list. More...
 
Bool_t isShapeServer () const
 
Bool_t isValueServer () const
 
- 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 Member Functions inherited from RooAbsProxy
virtual void changeNormSet (const RooArgSet *newNormSet)
 Destructor. More...
 
- Protected Attributes inherited from RooArgProxy
RooAbsArg_arg
 
Bool_t _isFund
 
Bool_t _ownArg
 
RooAbsArg_owner
 
Bool_t _shapeServer
 
Bool_t _valueServer
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from RooAbsProxy
RooArgSet_nset
 

#include <RooTemplateProxy.h>

Inheritance diagram for RooTemplateProxy< T >:
[legend]

Constructor & Destructor Documentation

◆ RooTemplateProxy() [1/4]

template<class T>
RooTemplateProxy< T >::RooTemplateProxy ( )
inline

Definition at line 48 of file RooTemplateProxy.h.

◆ RooTemplateProxy() [2/4]

template<class T>
RooTemplateProxy< T >::RooTemplateProxy ( const char *  theName,
const char *  desc,
RooAbsArg owner,
Bool_t  valueServer = true,
Bool_t  shapeServer = false,
Bool_t  proxyOwnsArg = false 
)
inline

Constructor with owner.

Definition at line 52 of file RooTemplateProxy.h.

◆ RooTemplateProxy() [3/4]

template<class T>
RooTemplateProxy< T >::RooTemplateProxy ( const char *  theName,
const char *  desc,
RooAbsArg owner,
T &  ref,
Bool_t  valueServer = true,
Bool_t  shapeServer = false,
Bool_t  proxyOwnsArg = false 
)
inline

Constructor with owner and proxied real-valued object.

The propagation of value and shape dirty flags of the contained arg to the owner is controlled by the valueServer and shapeServer flags. If ownArg is true the proxy will take ownership of the contained arg.

Definition at line 61 of file RooTemplateProxy.h.

◆ RooTemplateProxy() [4/4]

template<class T>
RooTemplateProxy< T >::RooTemplateProxy ( const char *  theName,
RooAbsArg owner,
const RooTemplateProxy< T > &  other 
)
inline

Copy constructor.

Definition at line 68 of file RooTemplateProxy.h.

Member Function Documentation

◆ arg()

template<class T>
const T& RooTemplateProxy< T >::arg ( ) const
inline

Return reference to object held in proxy.

Definition at line 82 of file RooTemplateProxy.h.

◆ Clone()

template<class T>
virtual TObject* RooTemplateProxy< T >::Clone ( const char *  newname = 0) const
inlinevirtual

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TNamed.

Definition at line 71 of file RooTemplateProxy.h.

◆ getValBatch()

template<class T>
RooSpan<const double> RooTemplateProxy< T >::getValBatch ( std::size_t  begin,
std::size_t  batchSize 
) const
inline

Definition at line 77 of file RooTemplateProxy.h.

◆ hasMax()

template<class T>
Bool_t RooTemplateProxy< T >::hasMax ( const char *  rname = 0) const
inline

Check if the range has a upper bound. This requires the payload to be RooAbsRealLValue or derived.

Definition at line 107 of file RooTemplateProxy.h.

◆ hasMin()

template<class T>
Bool_t RooTemplateProxy< T >::hasMin ( const char *  rname = 0) const
inline

Check if the range has a lower bound. This requires the payload to be RooAbsRealLValue or derived.

Definition at line 105 of file RooTemplateProxy.h.

◆ lvptr()

template<class T>
RooAbsRealLValue* RooTemplateProxy< T >::lvptr ( ) const
inlineprivate

Return l-value pointer to contents.

If the contents derive from RooAbsLValue, the function simply returns the pointer. If the template parameter of this proxy does not derive from RooAbsLValue, then

  • in a debug build, a dynamic_cast is attempted.
  • in a release build, a static_cast is forced, irrespective of what the type of the object actually is. This is dangerous, but equivalent to the behaviour before refactoring.
    Deprecated:
    This function is unneccessary if the template parameter is RooAbsRealLValue or a derived type, as arg() will always return the correct type.

Definition at line 120 of file RooTemplateProxy.h.

◆ lvptr_impl() [1/2]

template<class T>
RooAbsRealLValue* RooTemplateProxy< T >::lvptr_impl ( RooAbsRealLValue ) const
inlineprivate

Overload when the class template parameter is RooAbsRealLValue or more derived. Just returns the pointer.

Definition at line 125 of file RooTemplateProxy.h.

◆ lvptr_impl() [2/2]

template<class T>
RooAbsRealLValue* RooTemplateProxy< T >::lvptr_impl ( RooAbsArg ) const
inlineprivate

Overload for cases where the class template parameter is does not derive from RooAbsRealLValue.

Attempts a cast.

Deprecated:
Instead of using a proxy with a base type like RooAbsReal, change the template parameter to a type that makes downcasting to RooAbsRealLValue unnecessary.

Definition at line 132 of file RooTemplateProxy.h.

◆ max()

template<class T>
Double_t RooTemplateProxy< T >::max ( const char *  rname = 0) const
inline

Query upper limit of range. This requires the payload to be RooAbsRealLValue or derived.

Definition at line 103 of file RooTemplateProxy.h.

◆ min()

template<class T>
Double_t RooTemplateProxy< T >::min ( const char *  rname = 0) const
inline

Query lower limit of range. This requires the payload to be RooAbsRealLValue or derived.

Definition at line 101 of file RooTemplateProxy.h.

◆ operator Double_t()

template<class T>
RooTemplateProxy< T >::operator Double_t ( ) const
inline

Definition at line 73 of file RooTemplateProxy.h.

◆ operator=()

template<class T>
RooTemplateProxy<T>& RooTemplateProxy< T >::operator= ( const Double_t value)
inline

Assign a new value to the object pointed to by the proxy. This requires the payload to be assignable (RooAbsRealLValue or derived).

Definition at line 99 of file RooTemplateProxy.h.

◆ setArg()

template<class T>
Bool_t RooTemplateProxy< T >::setArg ( T &  newRef)
inline

Change object held in proxy into newRef.

Definition at line 86 of file RooTemplateProxy.h.


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