template<class AParamType>
class TParameter< AParamType >

Named parameter, streamable and storable.

Definition at line 35 of file TParameter.h.

Public Types
enum	EStatusBits { kMultiply = (1ULL << ( 16 )) , kMax = (1ULL << ( 17 )) , kMin = (1ULL << ( 18 )) , kFirst = (1ULL << ( 19 )) , kLast = (1ULL << ( 20 )) , kIsConst = (1ULL << ( 21 )) }

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

Public Member Functions
	TParameter ()

	TParameter (const char *name, const AParamType &val)

	TParameter (const char *name, const AParamType &val, char mergemode)

virtual	~TParameter ()

Int_t	Compare (const TObject *obj) const override
	Compare abstract method.

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

const AParamType &	GetVal () const

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

TClass *	IsA () const override

Bool_t	IsConst () const

Bool_t	IsSortable () const override

void	ls (Option_t *) const override
	The ls function lists the contents of a class on stdout.

virtual Int_t	Merge (TCollection *in)

Int_t	Merge (TCollection *in)

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

void	SetMergeMode (char mergemode='+')

void	SetVal (const AParamType &val)

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

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

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

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

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

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

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

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 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 Member Functions
void	Reset ()

Private Attributes
TString	fName

AParamType	fVal

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TParameter.h>

Inheritance diagram for TParameter< AParamType >:

[legend]

Member Enumeration Documentation

◆ EStatusBits

template<class AParamType >

enum TParameter::EStatusBits

Enumerator
kMultiply
kMax
kMin
kFirst
kLast
kIsConst

Definition at line 39 of file TParameter.h.

Constructor & Destructor Documentation

◆ TParameter() [1/3]

template<class AParamType >

TParameter< AParamType >::TParameter ( )

inline

Definition at line 55 of file TParameter.h.

◆ TParameter() [2/3]

template<class AParamType >

TParameter< AParamType >::TParameter	(	const char *	name,
		const AParamType &	val
	)

inline

Definition at line 56 of file TParameter.h.

◆ TParameter() [3/3]

template<class AParamType >

TParameter< AParamType >::TParameter	(	const char *	name,
		const AParamType &	val,
		char	mergemode
	)

inline

Definition at line 58 of file TParameter.h.

◆ ~TParameter()

template<class AParamType >

virtual TParameter< AParamType >::~TParameter ( )

inlinevirtual

Definition at line 60 of file TParameter.h.

Member Function Documentation

◆ Class()

template<class AParamType >

static TClass * TParameter< AParamType >::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

template<class AParamType >

static const char * TParameter< AParamType >::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

template<class AParamType >

static constexpr Version_t TParameter< AParamType >::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 119 of file TParameter.h.

◆ Compare()

template<class AParamType >

Int_t TParameter< AParamType >::Compare ( const TObject * obj ) const

inlineoverridevirtual

Compare abstract method.

Must be overridden if a class wants to be able to compare itself with other objects. Must return -1 if this is smaller than obj, 0 if objects are equal and 1 if this is larger than obj.

Reimplemented from TObject.

Definition at line 94 of file TParameter.h.

◆ DeclFileName()

template<class AParamType >

static const char * TParameter< AParamType >::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 119 of file TParameter.h.

◆ GetName()

template<class AParamType >

const char * TParameter< AParamType >::GetName ( ) const

inlineoverridevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 66 of file TParameter.h.

◆ GetVal()

template<class AParamType >

const AParamType & TParameter< AParamType >::GetVal ( ) const

inline

Definition at line 67 of file TParameter.h.

◆ Hash()

template<class AParamType >

ULong_t TParameter< AParamType >::Hash ( ) const

inlineoverridevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

ROOT::CallRecursiveRemoveIfNeeded(*this)

ROOT::CallRecursiveRemoveIfNeeded

void CallRecursiveRemoveIfNeeded(TObject &obj)

call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.

Definition TROOT.h:395

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.

TObject

Mother of all ROOT objects.

Definition TObject.h:41

TObject::Error

virtual void Error(const char *method, const char *msgfmt,...) const

Issue error message.

Definition TObject.cxx:993

TParameter::Hash

ULong_t Hash() const override

Return hash value for this object.

Definition TParameter.h:92

TROOT::RecursiveRemove

void RecursiveRemove(TObject *obj) override

Recursively remove this object from the list of Cleanups.

Definition TROOT.cxx:2498

Reimplemented from TObject.

Definition at line 92 of file TParameter.h.

◆ IsA()

template<class AParamType >

TClass * TParameter< AParamType >::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Reimplemented in TSelectorScalar.

Definition at line 119 of file TParameter.h.

◆ IsConst()

template<class AParamType >

Bool_t TParameter< AParamType >::IsConst ( ) const

inline

Definition at line 68 of file TParameter.h.

◆ IsSortable()

template<class AParamType >

Bool_t TParameter< AParamType >::IsSortable ( ) const

inlineoverridevirtual

Reimplemented from TObject.

Definition at line 93 of file TParameter.h.

◆ ls()

template<class AParamType >

void TParameter< AParamType >::ls ( Option_t * option ) const

inlineoverridevirtual

The ls function lists the contents of a class on stdout.

Ls output is typically much less verbose then Dump().

Reimplemented from TObject.

Definition at line 103 of file TParameter.h.

◆ Merge() [1/2]

template<class AParamType >

Int_t TParameter< AParamType >::Merge ( TCollection * in )

inlinevirtual

Reimplemented in TSelectorScalar.

Definition at line 123 of file TParameter.h.

◆ Merge() [2/2]

Int_t TParameter< Bool_t >::Merge ( TCollection * in )

inline

Definition at line 158 of file TParameter.h.

◆ Print()

template<class AParamType >

void TParameter< AParamType >::Print ( Option_t * option ) const

inlineoverridevirtual

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

Reimplemented from TObject.

Definition at line 110 of file TParameter.h.

◆ Reset()

template<class AParamType >

void TParameter< AParamType >::Reset ( )

inlineprivate

Definition at line 51 of file TParameter.h.

◆ SetMergeMode()

template<class AParamType >

void TParameter< AParamType >::SetMergeMode ( char mergemode = '+' )

inline

Definition at line 78 of file TParameter.h.

◆ SetVal()

template<class AParamType >

void TParameter< AParamType >::SetVal ( const AParamType & val )

inline

Definition at line 69 of file TParameter.h.

◆ Streamer()

template<class AParamType >

void TParameter< AParamType >::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TSelectorScalar.

◆ StreamerNVirtual()

template<class AParamType >

void TParameter< AParamType >::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 119 of file TParameter.h.

Member Data Documentation

◆ fName

template<class AParamType >

TString TParameter< AParamType >::fName

private

Definition at line 48 of file TParameter.h.

◆ fVal

template<class AParamType >

AParamType TParameter< AParamType >::fVal

private

Definition at line 49 of file TParameter.h.

core/base/inc/TParameter.h

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EStatusBits

Constructor & Destructor Documentation

◆ TParameter() [1/3]

◆ TParameter() [2/3]

◆ TParameter() [3/3]

◆ ~TParameter()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Compare()

◆ DeclFileName()

◆ GetName()

◆ GetVal()

◆ Hash()

◆ IsA()

◆ IsConst()

◆ IsSortable()

◆ ls()

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ Print()

◆ Reset()

◆ SetMergeMode()

◆ SetVal()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fName

◆ fVal