Logo ROOT  
Reference Guide
RooTemplateProxy< T > Class Template Reference

template<class T>
class RooTemplateProxy< T >


Introduction

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

A RooGaussian(..., x, mean, sigma) can e.g. store references to x, mean, sigma as

Now, the values of these three can be accessed, and the template argument ensures that only objects that evaluate to real numbers (RooAbsReal) can be stored in such a proxy. These can e.g. be variables, PDFs and functions. To store an object that's a RooCategory, one would, for example, use

Since ROOT 6.22, the proxy can be used like a pointer to an instance of the template argument. For this, it provides operator* and operator->, e.g.

double oldValue = _x->getVal(normalisationSet);
*_x = 17.;

RooTemplateProxy's base class RooArgProxy registers the proxied objects as "servers" of the object that holds the proxy. When the value of the proxied object is changed, the owner is notified, and can recalculate its own value. Renaming or exchanging objects that serve values to the owner of the proxy is handled automatically.

Modernisation of proxies in ROOT 6.22

In ROOT 6.22, the classes RooRealProxy and RooCategoryProxy were replaced by RooTemplateProxy<class T>.

Two typedefs have been defined for backward compatibility:

To modernise a class, one can change the template argument of the proxy to the most appropriate type, and increment the class version of the owner.

RooFit before ROOT 6.22 RooFit starting with ROOT 6.22
// In .h: Declare member
RooRealProxy pdfProxy;
ClassDef(MyPdf, 1)
};
// In .cxx: Initialise proxy in constructor
// The proxy will accept any RooAbsArg, so the type of
// "thePdf" has to be checked manually.
MyPdf::MyPdf(name, title, ...) :
pdfProxy("pdfProxy", "Proxy holding a PDF", this, thePdf) {
[ Extra checking here ... ]
}
// In .cxx: Accessing the proxy
RooAbsArg* absArg = pdfProxy.absArg();
RooAbsPdf* pdf = dynamic_cast<RooAbsPdf*>(absArg);
assert(pdf); // Manual type checking ...
pdf->fitTo(...);
// In .h: Declare member
ClassDef(MyPdf, 2)
};
// In .cxx: Initialise proxy in constructor
// The program will not compile if "thePdf" is not a
// type deriving from RooAbsPdf
MyPdf::MyPdf(name, title, ...) :
pdfProxy("pdfProxy", "Proxy holding a PDF", this, thePdf) {
}
// In .cxx: Accessing the proxy
pdfProxy->fitTo(...);

How to modernise old code

  1. Choose the proper template argument for the proxy.
  2. Increment the class version of the owning class.
  3. Make sure that the right type is passed in the constructor of the proxy.
  4. Always use proxy-> and *proxy to work with the stored object. No need to cast.
  5. Only if necessary If errors about missing symbols connected to RooTemplateProxy appear at link time, a specific template instantiation for RooTemplateProxy is not yet in ROOT's dictionaries. These two lines should be added to the LinkDef.h of the project:

    #pragma link C++ class RooTemplateProxy<RooMultiCategory>+;
    #pragma read sourceClass="RooCategoryProxy" targetClass="RooTemplateProxy<RooMultiCategory>"

    Replace RooMultiCategory by the proper type. If the proxy was holding a real-valued object, use sourceClass="RooRealProxy".

    The first line adds the proxy class to the dictionary, the second line enables reading a legacy RooCategoryProxy from a file, and converting it to the new type-safe proxy. If no old proxies have to be read from files, this line can be omitted.

    If the template instantiation that triggered the missing symbols seems to be a very common instantiation, request for it to be added to RooFit by creating a pull request for ROOT. If it is rather uncommon, it is sufficient to add it to the LinkDef.h of the local project only.

Definition at line 148 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 object. More...
 
template<typename U >
 RooTemplateProxy (const char *theName, RooAbsArg *owner, const RooTemplateProxy< U > &other, bool allowWrongTypes=false)
 Copy from an existing proxy. More...
 
virtual TObjectClone (const char *newName=0) const
 Make a clone of an object using the Streamer facility. More...
 
 operator typename T::value_type () const
 Convert the proxy into a number. More...
 
T & operator* () const
 Return reference to the proxied object. More...
 
T * operator-> () const
 Member access operator to proxied object. More...
 
bool setArg (T &newRef)
 Change object held in proxy into newRef. More...
 
Legacy interface

In ROOT versions before 6.22, RooFit didn't have this typed proxy.

Therefore, a number of functions for forwarding calls to the proxied objects were necessary. The functions in this group can all be replaced by directly accessing the proxied objects using e.g. the member access operator like proxy->function() or by dereferencing like *proxy = value. For this to work, choose the template argument appropriately. That is, if the proxy stores a PDF, use RooTemplateProxy<RooAbsPdf>, etc..

const char * label () const
 Get the label of the current category state. This function only makes sense for category proxies. More...
 
bool hasRange (const char *rangeName) const
 Check if the stored object has a range with the given name. More...
 
RooSpan< const typename T::value_type > getValBatch (std::size_t begin, std::size_t batchSize) const
 Retrieve a batch of real or category data. More...
 
const T & arg () const
 Return reference to object held in proxy. More...
 
RooTemplateProxy< T > & operator= (typename T::value_type value)
 Assign a new value to the object pointed to by the proxy. More...
 
RooTemplateProxy< T > & operator= (const std::string &newState)
 Set a category state using its state name. This function can only work for category-type proxies. More...
 
double min (const char *rname=0) const
 Query lower limit of range. This requires the payload to be RooAbsRealLValue or derived. More...
 
double max (const char *rname=0) const
 Query upper limit of range. This requires the payload to be RooAbsRealLValue or derived. More...
 
bool hasMin (const char *rname=0) const
 Check if the range has a lower bound. This requires the payload to be RooAbsRealLValue or derived. More...
 
bool hasMax (const char *rname=0) const
 Check if the range has a upper bound. This requires the payload to be RooAbsRealLValue or derived. 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 Types

using LValue_t = typename std::conditional< std::is_base_of< RooAbsReal, T >::value, RooAbsRealLValue, RooAbsCategoryLValue >::type
 Are we a real-valued proxy or a category proxy? More...
 

Private Member Functions

const LValue_tlvptr (const LValue_t *) const
 Return l-value pointer to contents. More...
 
LValue_tlvptr (LValue_t *)
 Return l-value pointer to contents. More...
 
const LValue_tlvptr (const RooAbsArg *) const
 Return l-value pointer to contents. More...
 
LValue_tlvptr (RooAbsArg *)
 Return l-value pointer to contents. More...
 
RooSpan< const typename T::value_type > retrieveBatchVal (std::size_t begin, std::size_t batchSize, const RooAbsCategory &cat) const
 Retrieve a batch of index states from a category. More...
 
RooSpan< const typename T::value_type > retrieveBatchVal (std::size_t begin, std::size_t batchSize, const RooAbsReal &real) const
 Retrieve a batch of values from a real-valued object. The current normalisation set associated to the proxy will be passed on. More...
 
T::value_type retrieveValue (const RooAbsCategory &cat) const
 Retrieve index state from a category. More...
 
T::value_type retrieveValue (const RooAbsReal &real) const
 Retrieve value from a real-valued object. 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]

Member Typedef Documentation

◆ LValue_t

template<class T>
using RooTemplateProxy< T >::LValue_t = typename std::conditional<std::is_base_of<RooAbsReal, T>::value, RooAbsRealLValue, RooAbsCategoryLValue>::type
private

Are we a real-valued proxy or a category proxy?

Definition at line 300 of file RooTemplateProxy.h.

Constructor & Destructor Documentation

◆ RooTemplateProxy() [1/4]

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

Definition at line 151 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.

Parameters
[in]theNameName of this proxy (for printing).
[in]descDescription what this proxy should act as.
[in]ownerThe object that owns the proxy. This is important for tracking of client-server dependencies.
[in]valueServerNotify the owner if value changes.
[in]shapeServerNotify the owner if shape (e.g. binning) changes.
[in]proxyOwnsArgProxy will delete the payload if owning.

Definition at line 162 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 object.

Parameters
[in]theNameName of this proxy (for printing).
[in]descDescription what this proxy should act as.
[in]ownerThe object that owns the proxy. This is important for tracking of client-server dependencies.
[in]refReference to the object that the proxy should hold.
[in]valueServerNotify the owner if value changes.
[in]shapeServerNotify the owner if shape (e.g. binning) changes.
[in]proxyOwnsArgProxy will delete the payload if owning.

Definition at line 176 of file RooTemplateProxy.h.

◆ RooTemplateProxy() [4/4]

template<class T>
template<typename U >
RooTemplateProxy< T >::RooTemplateProxy ( const char *  theName,
RooAbsArg owner,
const RooTemplateProxy< U > &  other,
bool  allowWrongTypes = false 
)
inline

Copy from an existing proxy.

It will accept any RooTemplateProxy instance, and attempt a dynamic_cast on its payload.

Parameters
[in]theNameName of this proxy.
[in]ownerPointer to the owner this proxy should be registered to.
[in]otherInstance of a differen proxy whose payload should be copied.
[in]allowWrongTypesInstead of throwing a std::invalid_argument, only issue an error message when payload with wrong type is found. This is unsafe, but may be necessary when reading back legacy types. Defaults to false.
Exceptions
std::invalid_argumentif the types of the payloads are incompatible.

Definition at line 192 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 270 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 203 of file RooTemplateProxy.h.

◆ getValBatch()

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

Retrieve a batch of real or category data.

When retrieving real-valued data from e.g. a PDF, the normalisation set saved by this proxy will be passed on the the proxied object.

Parameters
[in]beginBegin of the range to be retrieved.
[in]batchSizeSize of the range to be retrieved. Batch may be smaller if no more data available.
Returns
RooSpan<const double> for real-valued proxies, RooSpan<const int> for category proxies.

Definition at line 264 of file RooTemplateProxy.h.

◆ hasMax()

template<class T>
bool 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 292 of file RooTemplateProxy.h.

◆ hasMin()

template<class T>
bool 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 290 of file RooTemplateProxy.h.

◆ hasRange()

template<class T>
bool RooTemplateProxy< T >::hasRange ( const char *  rangeName) const
inline

Check if the stored object has a range with the given name.

Definition at line 253 of file RooTemplateProxy.h.

◆ label()

template<class T>
const char* RooTemplateProxy< T >::label ( ) const
inline

Get the label of the current category state. This function only makes sense for category proxies.

Definition at line 248 of file RooTemplateProxy.h.

◆ lvptr() [1/4]

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

Return l-value pointer to contents.

If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then

  • in a debug build, a dynamic_cast with an assertion is used.
  • 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 the RooFit proxies.
    Deprecated:
    This function is unneccessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 311 of file RooTemplateProxy.h.

◆ lvptr() [2/4]

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

Return l-value pointer to contents.

If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then

  • in a debug build, a dynamic_cast with an assertion is used.
  • 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 the RooFit proxies.
    Deprecated:
    This function is unneccessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 315 of file RooTemplateProxy.h.

◆ lvptr() [3/4]

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

Return l-value pointer to contents.

If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then

  • in a debug build, a dynamic_cast with an assertion is used.
  • 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 the RooFit proxies.
    Deprecated:
    This function is unneccessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 319 of file RooTemplateProxy.h.

◆ lvptr() [4/4]

template<class T>
LValue_t* RooTemplateProxy< T >::lvptr ( RooAbsArg )
inlineprivate

Return l-value pointer to contents.

If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then

  • in a debug build, a dynamic_cast with an assertion is used.
  • 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 the RooFit proxies.
    Deprecated:
    This function is unneccessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 330 of file RooTemplateProxy.h.

◆ max()

template<class T>
double 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 288 of file RooTemplateProxy.h.

◆ min()

template<class T>
double 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 286 of file RooTemplateProxy.h.

◆ operator typename T::value_type()

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

Convert the proxy into a number.

Returns
A category proxy will return the index state, real proxies the result of RooAbsReal::getVal(normSet).

Definition at line 219 of file RooTemplateProxy.h.

◆ operator*()

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

Return reference to the proxied object.

Definition at line 207 of file RooTemplateProxy.h.

◆ operator->()

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

Member access operator to proxied object.

Definition at line 212 of file RooTemplateProxy.h.

◆ operator=() [1/2]

template<class T>
RooTemplateProxy<T>& RooTemplateProxy< T >::operator= ( typename T::value_type  value)
inline

Assign a new value to the object pointed to by the proxy.

This requires the payload to be assignable (RooAbsRealLValue or derived, RooAbsCategoryLValue).

Definition at line 274 of file RooTemplateProxy.h.

◆ operator=() [2/2]

template<class T>
RooTemplateProxy<T>& RooTemplateProxy< T >::operator= ( const std::string &  newState)
inline

Set a category state using its state name. This function can only work for category-type proxies.

Definition at line 279 of file RooTemplateProxy.h.

◆ retrieveBatchVal() [1/2]

template<class T>
RooSpan<const typename T::value_type> RooTemplateProxy< T >::retrieveBatchVal ( std::size_t  begin,
std::size_t  batchSize,
const RooAbsCategory cat 
) const
inlineprivate

Retrieve a batch of index states from a category.

Definition at line 353 of file RooTemplateProxy.h.

◆ retrieveBatchVal() [2/2]

template<class T>
RooSpan<const typename T::value_type> RooTemplateProxy< T >::retrieveBatchVal ( std::size_t  begin,
std::size_t  batchSize,
const RooAbsReal real 
) const
inlineprivate

Retrieve a batch of values from a real-valued object. The current normalisation set associated to the proxy will be passed on.

Definition at line 358 of file RooTemplateProxy.h.

◆ retrieveValue() [1/2]

template<class T>
T::value_type RooTemplateProxy< T >::retrieveValue ( const RooAbsCategory cat) const
inlineprivate

Retrieve index state from a category.

Definition at line 343 of file RooTemplateProxy.h.

◆ retrieveValue() [2/2]

template<class T>
T::value_type RooTemplateProxy< T >::retrieveValue ( const RooAbsReal real) const
inlineprivate

Retrieve value from a real-valued object.

Definition at line 348 of file RooTemplateProxy.h.

◆ setArg()

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

Change object held in proxy into newRef.

Definition at line 226 of file RooTemplateProxy.h.


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