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

RooTemplateProxy<RooAbsReal> _x;
RooTemplateProxy<RooAbsReal> _mean;
RooTemplateProxy<RooAbsReal> _sigma;

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

RooTemplateProxy<RooCategory> _category;

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:

RooRealProxy = RooTemplateProxy<RooAbsReal>. Any generic object that converts to a real value.
RooCategoryProxy = RooTemplateProxy<RooAbsCategory>. Any category object.

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;
 
ClassDefOverride(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
RooTemplateProxy<RooAbsPdf> pdfProxy;
 
ClassDefOverride(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

Choose the proper template argument for the proxy.
- If a PDF is stored: RooTemplateProxy<RooAbsPdf>.
- If a real-valued object is stored: RooTemplateProxy<RooAbsReal>.
- If a category is stored: RooTemplateProxy<RooCategory>.
- If a variable is stored (i.e. one wants to be able to assign values to it): RooTemplateProxy<RooRealVar> Other template arguments are possible, as long as they derive from RooAbsArg.
Increment the class version of the owning class.
Make sure that the right type is passed in the constructor of the proxy.
Always use proxy-> and *proxy to work with the stored object. No need to cast.
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 149 of file RooTemplateProxy.h.

Public Member Functions
	RooTemplateProxy ()

template<typename Bool = bool, typename = std::enable_if_t<std::is_same<Bool,bool>::value>>
	RooTemplateProxy (const char theName, const char desc, RooAbsArg *owner, Bool valueServer=true, bool shapeServer=false, bool proxyOwnsArg=false)
	Constructor with owner.

	RooTemplateProxy (const char theName, const char desc, RooAbsArg *owner, T &ref, bool valueServer=true, bool shapeServer=false, bool proxyOwnsArg=false)
	Constructor with owner and proxied object.

template<typename U >
	RooTemplateProxy (const char theName, RooAbsArg owner, const RooTemplateProxy< U > &other, bool allowWrongTypes=false)
	Copy from an existing proxy.

TObject *	Clone (const char *newName=nullptr) const override
	Make a clone of an object using the Streamer facility.

template<class U , class... ConstructorArgs>
U &	emplaceOwnedArg (ConstructorArgs &&... constructorArgs)
	Create a new object held and owned by proxy.

TClass *	IsA () const override

	operator typename T::value_type () const
	Convert the proxy into a number.

T &	operator* () const
	Return reference to the proxied object.

T *	operator-> () const
	Member access operator to proxied object.

template<class U >
U &	putOwnedArg (std::unique_ptr< U > ownedArg)
	Move a new object held and owned by proxy.

bool	setArg (T &newRef)
	Change object held in proxy into newRef.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

bool	hasRange (const char *rangeName) const
	Check if the stored object has a range with the given name.

const T &	arg () const
	Return reference to object held in proxy.

RooTemplateProxy< T > &	operator= (typename T::value_type value)
	Assign a new value to the object pointed to by the proxy.

RooTemplateProxy< T > &	operator= (const std::string &newState)
	Set a category state using its state name. This function can only work for category-type proxies.

double	min (const char *rname=nullptr) const
	Query lower limit of range. This requires the payload to be RooAbsRealLValue or derived.

double	max (const char *rname=nullptr) const
	Query upper limit of range. This requires the payload to be RooAbsRealLValue or derived.

bool	hasMin (const char *rname=nullptr) const
	Check if the range has a lower bound. This requires the payload to be RooAbsRealLValue or derived.

bool	hasMax (const char *rname=nullptr) const
	Check if the range has a upper bound. This requires the payload to be RooAbsRealLValue or derived.

Public Member Functions inherited from RooArgProxy
	RooArgProxy ()=default
	Default constructor.

	RooArgProxy (const char name, const char desc, RooAbsArg *owner, bool valueServer, bool shapeServer, bool proxyOwnsArg=false)
	Constructor with owner and proxied variable.

	RooArgProxy (const char name, const char desc, RooAbsArg *owner, RooAbsArg &arg, bool valueServer, bool shapeServer, bool proxyOwnsArg=false)
	Constructor with owner and proxied variable.

	RooArgProxy (const char name, RooAbsArg owner, const RooArgProxy &other)
	Copy constructor.

	RooArgProxy (RooArgProxy &&other)=delete

	RooArgProxy (RooArgProxy const &other)=delete

	~RooArgProxy () override
	Destructor.

RooAbsArg *	absArg () const
	Return pointer to contained argument.

bool	isShapeServer () const
	Returns true if contents is shape server of owner.

bool	isValueServer () const
	Returns true of contents is value server of owner.

const char *	name () const override
	Return name of proxy.

RooArgProxy &	operator= (RooArgProxy &&other)=delete

RooArgProxy &	operator= (RooArgProxy const &other)=delete

RooAbsArg *	owner () const
	Returns the owner of this proxy.

void	print (std::ostream &os, bool addContents=false) const override
	Print the name of the proxy on ostream.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

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	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 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 UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

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

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).

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 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.

Public Member Functions inherited from RooAbsProxy
	RooAbsProxy ()

	RooAbsProxy (const char *name, const RooAbsProxy &other)
	Copy constructor.

virtual	~RooAbsProxy ()

const RooArgSet *	nset () const

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from RooArgProxy
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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.

Static Public Member Functions inherited from RooAbsProxy
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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?

Private Member Functions
const LValue_t *	lvptr (const LValue_t *) const
	Return l-value pointer to contents.

const LValue_t *	lvptr (const RooAbsArg *) const
	Return l-value pointer to contents.

LValue_t *	lvptr (LValue_t *)
	Return l-value pointer to contents.

LValue_t *	lvptr (RooAbsArg *)
	Return l-value pointer to contents.

T::value_type	retrieveValue (const RooAbsCategory &cat) const
	Retrieve index state from a category.

T::value_type	retrieveValue (const RooAbsReal &real) const
	Retrieve value from a real-valued object.

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 RooArgProxy
virtual void	changeDataSet (const RooArgSet *newNormSet)
	Change the normalization set that should be offered to the content objects getVal() when evaluated.

bool	changePointer (const RooAbsCollection &newServerSet, bool nameChange=false, bool factoryInitMode=false) override
	Change proxied object to object of same name in given list.

bool	changePointer (std::unordered_map< RooAbsArg , RooAbsArg > const &replacements) override

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

Protected Member Functions inherited from RooAbsProxy
virtual void	changeNormSet (const RooArgSet *newNormSet)
	Destructor.

Protected Attributes inherited from RooArgProxy
RooAbsArg *	_arg = nullptr
	Pointer to content of proxy.

bool	_isFund = true
	If true proxy contains an lvalue.

bool	_ownArg = false
	If true proxy owns contents.

RooAbsArg *	_owner = nullptr
	Pointer to owner of proxy.

bool	_shapeServer = false
	If true contents is shape server of owner.

bool	_valueServer = false
	If true contents is value server of owner.

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from RooAbsProxy
RooArgSet *	_nset = nullptr
	! Normalization set to be used for evaluation of RooAbsPdf contents

#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 329 of file RooTemplateProxy.h.

Constructor & Destructor Documentation

◆ RooTemplateProxy() [1/4]

template<class T >

RooTemplateProxy< T >::RooTemplateProxy ( )

inline

Definition at line 152 of file RooTemplateProxy.h.

◆ RooTemplateProxy() [2/4]

template<class T >

template<typename Bool = bool, typename = std::enable_if_t<std::is_same<Bool,bool>::value>>

RooTemplateProxy< T >::RooTemplateProxy	(	const char *	theName,
		const char *	desc,
		RooAbsArg *	owner,
		Bool	valueServer = `true`,
		bool	shapeServer = `false`,
		bool	proxyOwnsArg = `false`
	)

inline

Constructor with owner.

Parameters

[in]	theName	Name of this proxy (for printing).
[in]	desc	Description what this proxy should act as.
[in]	owner	The object that owns the proxy. This is important for tracking of client-server dependencies.
[in]	valueServer	Notify the owner if value changes.
[in]	shapeServer	Notify the owner if shape (e.g. binning) changes.
[in]	proxyOwnsArg	Proxy will delete the payload if owning.

Definition at line 164 of file RooTemplateProxy.h.

◆ RooTemplateProxy() [3/4]

template<class T >

RooTemplateProxy< T >::RooTemplateProxy	(	const char *	theName,
		const char *	desc,
		RooAbsArg *	owner,
		T &	ref,
		bool	valueServer = `true`,
		bool	shapeServer = `false`,
		bool	proxyOwnsArg = `false`
	)

inline

Constructor with owner and proxied object.

Parameters

[in]	theName	Name of this proxy (for printing).
[in]	desc	Description what this proxy should act as.
[in]	owner	The object that owns the proxy. This is important for tracking of client-server dependencies.
[in]	ref	Reference to the object that the proxy should hold.
[in]	valueServer	Notify the owner if value changes.
[in]	shapeServer	Notify the owner if shape (e.g. binning) changes.
[in]	proxyOwnsArg	Proxy will delete the payload if owning.

Definition at line 187 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]	theName	Name of this proxy.
[in]	owner	Pointer to the owner this proxy should be registered to.
[in]	other	Instance of a different proxy whose payload should be copied.
[in]	allowWrongTypes	Instead 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_argument if the types of the payloads are incompatible.

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

◆ Class()

template<class T >

static TClass * RooTemplateProxy< T >::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

template<class T >

static const char * RooTemplateProxy< T >::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

template<class T >

static constexpr Version_t RooTemplateProxy< T >::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 382 of file RooTemplateProxy.h.

◆ Clone()

template<class T >

TObject * RooTemplateProxy< T >::Clone ( const char * newname = nullptr ) const

inlineoverridevirtual

Make a clone of an object using the Streamer facility.

If the object derives from TNamed, this function is called by TNamed::Clone. TNamed::Clone uses the optional argument to set a new name to the newly created object.

If the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented from TObject.

Definition at line 214 of file RooTemplateProxy.h.

◆ DeclFileName()

template<class T >

static const char * RooTemplateProxy< T >::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 382 of file RooTemplateProxy.h.

◆ emplaceOwnedArg()

template<class T >

template<class U , class... ConstructorArgs>

U & RooTemplateProxy< T >::emplaceOwnedArg ( ConstructorArgs &&... constructorArgs )

inline

Create a new object held and owned by proxy.

Can only be done if the proxy was non-owning before.

Definition at line 253 of file RooTemplateProxy.h.

◆ hasMax()

template<class T >

bool RooTemplateProxy< T >::hasMax ( const char * rname = nullptr ) const

inline

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

Definition at line 322 of file RooTemplateProxy.h.

◆ hasMin()

template<class T >

bool RooTemplateProxy< T >::hasMin ( const char * rname = nullptr ) const

inline

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

Definition at line 320 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 295 of file RooTemplateProxy.h.

◆ IsA()

template<class T >

TClass * RooTemplateProxy< T >::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from RooArgProxy.

Definition at line 382 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 290 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 unnecessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 341 of file RooTemplateProxy.h.

◆ lvptr() [2/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 unnecessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 349 of file RooTemplateProxy.h.

◆ lvptr() [3/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 unnecessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 345 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 unnecessary if the template parameter is RooAbsRealLValue (+ derived types) or RooAbsCategoryLValue (+derived types), as arg() will always return the correct type.

Definition at line 360 of file RooTemplateProxy.h.

◆ max()

template<class T >

double RooTemplateProxy< T >::max ( const char * rname = nullptr ) const

inline

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

Definition at line 318 of file RooTemplateProxy.h.

◆ min()

template<class T >

double RooTemplateProxy< T >::min ( const char * rname = nullptr ) const

inline

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

Definition at line 316 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 230 of file RooTemplateProxy.h.

◆ operator*()

template<class T >

T & RooTemplateProxy< T >::operator* ( ) const

inline

Return reference to the proxied object.

Definition at line 218 of file RooTemplateProxy.h.

◆ operator->()

template<class T >

T * RooTemplateProxy< T >::operator-> ( ) const

inline

Member access operator to proxied object.

Definition at line 223 of file RooTemplateProxy.h.

◆ operator=() [1/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 309 of file RooTemplateProxy.h.

◆ operator=() [2/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 304 of file RooTemplateProxy.h.

◆ putOwnedArg()

template<class T >

template<class U >

U & RooTemplateProxy< T >::putOwnedArg ( std::unique_ptr< U > ownedArg )

inline

Move a new object held and owned by proxy.

Can only be done if the proxy was non-owning before.

Definition at line 269 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 373 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 378 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 237 of file RooTemplateProxy.h.

◆ Streamer()

template<class T >

void RooTemplateProxy< T >::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from RooArgProxy.

◆ StreamerNVirtual()

template<class T >

void RooTemplateProxy< T >::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 382 of file RooTemplateProxy.h.

roofit/roofitcore/inc/RooFit/Detail/CodeSquashContext.h

roofit/roofitcore/inc/RooTemplateProxy.h

Introduction

Modernisation of proxies in ROOT 6.22

How to modernise old code

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ LValue_t

Constructor & Destructor Documentation

◆ RooTemplateProxy() [1/4]

◆ RooTemplateProxy() [2/4]

◆ RooTemplateProxy() [3/4]

◆ RooTemplateProxy() [4/4]

Member Function Documentation

◆ arg()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Clone()

◆ DeclFileName()

◆ emplaceOwnedArg()

◆ hasMax()

◆ hasMin()

◆ hasRange()

◆ IsA()

◆ label()

◆ lvptr() [1/4]

◆ lvptr() [2/4]

◆ lvptr() [3/4]

◆ lvptr() [4/4]

◆ max()

◆ min()

◆ operator typename T::value_type()

◆ operator*()

◆ operator->()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ putOwnedArg()

◆ retrieveValue() [1/2]

◆ retrieveValue() [2/2]

◆ setArg()

◆ Streamer()

◆ StreamerNVirtual()