Named container for two doubles, two integers two object points and three string pointers that can be passed as generic named arguments to a variety of RooFit end user methods.

To achieved the named syntax, RooCmdArg objects are created using global helper functions defined in RooGlobalFunc.h that create and fill these generic containers

Definition at line 26 of file RooCmdArg.h.

Public Member Functions
	RooCmdArg ()
	Default constructor.

	RooCmdArg (const char name, Int_t i1, Int_t i2=0, double d1=0.0, double d2=0.0, const char s1=nullptr, const char s2=nullptr, const TObject o1=nullptr, const TObject o2=nullptr, const RooCmdArg ca=nullptr, const char s3=nullptr, const RooArgSet c1=nullptr, const RooArgSet *c2=nullptr)
	Constructor from payload parameters.

	RooCmdArg (const RooCmdArg &other)
	Copy constructor.

	~RooCmdArg () override
	Destructor.

void	addArg (const RooCmdArg &arg)
	Utility function to add nested RooCmdArg to payload of this RooCmdArg.

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

std::string	constructorCode () const

double	getDouble (Int_t idx) const
	Return double stored in slot idx.

Int_t	getInt (Int_t idx) const

const TObject *	getObject (Int_t idx) const
	Return TObject stored in slot idx.

const RooArgSet *	getSet (Int_t idx) const
	Return RooArgSet stored in slot idx.

const char *	getString (Int_t idx) const
	Return string stored in slot idx.

TClass *	IsA () const override

const char *	opcode () const

RooCmdArg &	operator= (const RooCmdArg &other)
	Assignment operator.

bool	prefixSubArgs () const

void	Print (const char *="") const override
	This method must be overridden when a class wants to print itself.

bool	procSubArgs () const

void	setDouble (Int_t idx, double value)

void	setInt (Int_t idx, Int_t value)

void	setObject (Int_t idx, TObject *value)

void	setProcessRecArgs (bool flag, bool prefix=true)

void	setSet (Int_t idx, const RooArgSet &set)

void	setString (Int_t idx, const char *value)

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

RooLinkedList &	subArgs ()
	Return list of sub-arguments in this RooCmdArg.

RooLinkedList const &	subArgs () const
	Return list of sub-arguments in this RooCmdArg.

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.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static const RooCmdArg &	none ()
	Return reference to null argument.

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.

Private Attributes
RooLinkedList	_argList
	Payload sub-arguments.

RooArgSet *	_c = nullptr
	Payload RooArgSets.

double	_d [2]
	Payload doubles.

Int_t	_i [2]
	Payload integers.

TObject *	_o [2]
	Payload objects.

bool	_prefixSubArgs = true
	Prefix sub-arguments with container name?

bool	_procSubArgs = false
	If true argument requires recursive processing.

std::string	_s [3]
	Payload strings.

Static Private Attributes
static const RooCmdArg	_none
	Static instance of null 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 TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <RooCmdArg.h>

Inheritance diagram for RooCmdArg:

[legend]

Constructor & Destructor Documentation

◆ RooCmdArg() [1/3]

RooCmdArg::RooCmdArg ( )

Default constructor.

Definition at line 61 of file RooCmdArg.cxx.

◆ RooCmdArg() [2/3]

RooCmdArg::RooCmdArg	(	const char *	name,
		Int_t	i1,
		Int_t	i2 = `0`,
		double	d1 = `0.0`,
		double	d2 = `0.0`,
		const char *	s1 = `nullptr`,
		const char *	s2 = `nullptr`,
		const TObject *	o1 = `nullptr`,
		const TObject *	o2 = `nullptr`,
		const RooCmdArg *	ca = `nullptr`,
		const char *	s3 = `nullptr`,
		const RooArgSet *	c1 = `nullptr`,
		const RooArgSet *	c2 = `nullptr`
	)

Constructor from payload parameters.

Constructor with full specification of payload: two integers, two doubles, three string poiners, two object pointers and one RooCmdArg pointer.

Note that the first payload parameter has no default value, because otherwise the implicit creation of a RooCmdArg from const char* would be possible. This would cause ambiguity problems in RooFit code. It is not a problem that the first parameter always has to be given, because creating a RooCmdArg with only a name and no payload doesn't make sense anyway.

Definition at line 76 of file RooCmdArg.cxx.

◆ RooCmdArg() [3/3]

RooCmdArg::RooCmdArg ( const RooCmdArg & other )

Copy constructor.

Definition at line 108 of file RooCmdArg.cxx.

◆ ~RooCmdArg()

RooCmdArg::~RooCmdArg ( )

override

Destructor.

Definition at line 176 of file RooCmdArg.cxx.

Member Function Documentation

◆ addArg()

void RooCmdArg::addArg ( const RooCmdArg & arg )

Utility function to add nested RooCmdArg to payload of this RooCmdArg.

Definition at line 187 of file RooCmdArg.cxx.

◆ Class()

static TClass * RooCmdArg::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * RooCmdArg::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t RooCmdArg::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 127 of file RooCmdArg.h.

◆ Clone()

TObject * RooCmdArg::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 58 of file RooCmdArg.h.

◆ constructorCode()

std::string RooCmdArg::constructorCode ( ) const

Definition at line 214 of file RooCmdArg.cxx.

◆ DeclFileName()

static const char * RooCmdArg::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 127 of file RooCmdArg.h.

◆ getDouble()

double RooCmdArg::getDouble ( Int_t idx ) const

inline

Return double stored in slot idx.

Definition at line 92 of file RooCmdArg.h.

◆ getInt()

Int_t RooCmdArg::getInt ( Int_t idx ) const

inline

Definition at line 87 of file RooCmdArg.h.

◆ getObject()

const TObject * RooCmdArg::getObject ( Int_t idx ) const

inline

Return TObject stored in slot idx.

Definition at line 100 of file RooCmdArg.h.

◆ getSet()

const RooArgSet * RooCmdArg::getSet ( Int_t idx ) const

Return RooArgSet stored in slot idx.

Definition at line 197 of file RooCmdArg.cxx.

◆ getString()

const char * RooCmdArg::getString ( Int_t idx ) const

inline

Return string stored in slot idx.

Definition at line 96 of file RooCmdArg.h.

◆ IsA()

TClass * RooCmdArg::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 127 of file RooCmdArg.h.

◆ none()

const RooCmdArg & RooCmdArg::none ( )

static

Return reference to null argument.

Definition at line 52 of file RooCmdArg.cxx.

◆ opcode()

const char * RooCmdArg::opcode ( ) const

inline

Definition at line 68 of file RooCmdArg.h.

◆ operator=()

RooCmdArg & RooCmdArg::operator= ( const RooCmdArg & other )

Assignment operator.

Definition at line 139 of file RooCmdArg.cxx.

◆ prefixSubArgs()

bool RooCmdArg::prefixSubArgs ( ) const

inline

Definition at line 109 of file RooCmdArg.h.

◆ Print()

void RooCmdArg::Print ( const char * option = "" ) const

overridevirtual

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 285 of file RooCmdArg.cxx.

◆ procSubArgs()

bool RooCmdArg::procSubArgs ( ) const

inline

Definition at line 108 of file RooCmdArg.h.

◆ setDouble()

void RooCmdArg::setDouble	(	Int_t	idx,
		double	value
	)

inline

Definition at line 76 of file RooCmdArg.h.

◆ setInt()

void RooCmdArg::setInt	(	Int_t	idx,
		Int_t	value
	)

inline

Definition at line 73 of file RooCmdArg.h.

◆ setObject()

void RooCmdArg::setObject	(	Int_t	idx,
		TObject *	value
	)

inline

Definition at line 82 of file RooCmdArg.h.

◆ setProcessRecArgs()

void RooCmdArg::setProcessRecArgs	(	bool	flag,
		bool	prefix = `true`
	)

inline

Definition at line 46 of file RooCmdArg.h.

◆ setSet()

void RooCmdArg::setSet	(	Int_t	idx,
		const RooArgSet &	set
	)

Definition at line 205 of file RooCmdArg.cxx.

◆ setString()

void RooCmdArg::setString	(	Int_t	idx,
		const char *	value
	)

inline

Definition at line 79 of file RooCmdArg.h.

◆ Streamer()

void RooCmdArg::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void RooCmdArg::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 127 of file RooCmdArg.h.

◆ subArgs() [1/2]

RooLinkedList & RooCmdArg::subArgs ( )

inline

Return list of sub-arguments in this RooCmdArg.

Definition at line 56 of file RooCmdArg.h.

◆ subArgs() [2/2]

RooLinkedList const & RooCmdArg::subArgs ( ) const

inline

Return list of sub-arguments in this RooCmdArg.

Definition at line 53 of file RooCmdArg.h.

Member Data Documentation

◆ _argList

RooLinkedList RooCmdArg::_argList

private

Payload sub-arguments.

Definition at line 124 of file RooCmdArg.h.

◆ _c

RooArgSet* RooCmdArg::_c = nullptr

private

Payload RooArgSets.

Definition at line 123 of file RooCmdArg.h.

◆ _d

double RooCmdArg::_d[2]

private

Payload doubles.

Definition at line 118 of file RooCmdArg.h.

◆ _i

Int_t RooCmdArg::_i[2]

private

Payload integers.

Definition at line 119 of file RooCmdArg.h.

◆ _none

const RooCmdArg RooCmdArg::_none

staticprivate

Static instance of null object.

Definition at line 115 of file RooCmdArg.h.

◆ _o

TObject* RooCmdArg::_o[2]

private

Payload objects.

Definition at line 121 of file RooCmdArg.h.

◆ _prefixSubArgs

bool RooCmdArg::_prefixSubArgs = true

private

Prefix sub-arguments with container name?

Definition at line 125 of file RooCmdArg.h.

◆ _procSubArgs

bool RooCmdArg::_procSubArgs = false

private

If true argument requires recursive processing.

Definition at line 122 of file RooCmdArg.h.

◆ _s

std::string RooCmdArg::_s[3]

private

Payload strings.

Definition at line 120 of file RooCmdArg.h.

Libraries for RooCmdArg:

[legend]

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

roofit/roofitcore/inc/RooCmdArg.h
roofit/roofitcore/src/RooCmdArg.cxx

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooCmdArg() [1/3]

◆ RooCmdArg() [2/3]

◆ RooCmdArg() [3/3]

◆ ~RooCmdArg()

Member Function Documentation

◆ addArg()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Clone()

◆ constructorCode()

◆ DeclFileName()

◆ getDouble()

◆ getInt()

◆ getObject()

◆ getSet()

◆ getString()

◆ IsA()

◆ none()

◆ opcode()

◆ operator=()

◆ prefixSubArgs()

◆ Print()

◆ procSubArgs()

◆ setDouble()

◆ setInt()

◆ setObject()

◆ setProcessRecArgs()

◆ setSet()

◆ setString()

◆ Streamer()

◆ StreamerNVirtual()

◆ subArgs() [1/2]

◆ subArgs() [2/2]

Member Data Documentation

◆ _argList

◆ _c

◆ _d

◆ _i

◆ _none

◆ _o

◆ _prefixSubArgs

◆ _procSubArgs

◆ _s