Logo ROOT  
Reference Guide
TParameter< AParamType > Class Template Reference

template<class AParamType>
class TParameter< AParamType >

Named parameter, streamable and storable.

Definition at line 35 of file TParameter.h.

Public Types

enum  EStatusBits {
  kMultiply = BIT(16), kMax = BIT(17), kMin = BIT(18), kFirst = BIT(19),
  kLast = BIT(20), kIsConst = BIT(21)
}
 
- 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)
}
 

Public Member Functions

 TParameter ()
 
 TParameter (const char *name, const AParamType &val)
 
 TParameter (const char *name, const AParamType &val, char mergemode)
 
virtual ~TParameter ()
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
const char * GetName () const
 Returns name of object. More...
 
const AParamType & GetVal () const
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t IsConst () const
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *) const
 The ls function lists the contents of a class on stdout. More...
 
virtual Int_t Merge (TCollection *in)
 
Int_t Merge (TCollection *in)
 
virtual void Print (Option_t *) const
 This method must be overridden when a class wants to print itself. More...
 
void SetMergeMode (char mergemode='+')
 
void SetVal (const AParamType &val)
 
- 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 Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. 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 const char * GetTitle () const
 Returns title of object. More...
 
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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
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...
 

Private Member Functions

void Reset ()
 

Private Attributes

TString fName
 
AParamType fVal
 

Additional Inherited Members

- 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 TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
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

◆ Compare()

template<class AParamType >
virtual Int_t TParameter< AParamType >::Compare ( const TObject obj) const
inlinevirtual

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.

◆ GetName()

template<class AParamType >
const char* TParameter< AParamType >::GetName ( ) const
inlinevirtual

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 >
virtual ULong_t TParameter< AParamType >::Hash ( ) const
inlinevirtual

Return hash value for this object.

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

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.

Reimplemented from TObject.

Definition at line 92 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 >
virtual Bool_t TParameter< AParamType >::IsSortable ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 93 of file TParameter.h.

◆ ls()

template<class AParamType >
virtual void TParameter< AParamType >::ls ( Option_t option) const
inlinevirtual

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 102 of file TParameter.h.

◆ Merge() [1/2]

template<class AParamType >
Int_t TParameter< AParamType >::Merge ( TCollection in)
inlinevirtual

Reimplemented in TSelectorScalar.

Definition at line 120 of file TParameter.h.

◆ Merge() [2/2]

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

Definition at line 155 of file TParameter.h.

◆ Print()

template<class AParamType >
virtual void TParameter< AParamType >::Print ( Option_t option) const
inlinevirtual

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

Reimplemented from TObject.

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

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.


The documentation for this class was generated from the following file:
TObject::Error
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition: TObject.cxx:890
TROOT::RecursiveRemove
void RecursiveRemove(TObject *obj)
Recursively remove this object from the list of Cleanups.
Definition: TROOT.cxx:2454
TObject
Mother of all ROOT objects.
Definition: TObject.h:37
TParameter::Hash
virtual ULong_t Hash() const
Return hash value for this object.
Definition: TParameter.h:92
ROOT::CallRecursiveRemoveIfNeeded
void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition: TROOT.h:395