Logo ROOT  
Reference Guide
TParameter.h
Go to the documentation of this file.
1// @(#)root/base:$Id$
2// Author: Maarten Ballintijn 21/06/2004
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TParameter
13#define ROOT_TParameter
14
15
16//////////////////////////////////////////////////////////////////////////
17// //
18// TParameter<AParamType> //
19// //
20// Named parameter, streamable and storable. //
21// //
22//////////////////////////////////////////////////////////////////////////
23
24#include "Riostream.h"
25
26#include "TClass.h"
27
28#include "TObject.h"
29
30#include "TCollection.h"
31
32#include "TString.h"
33
34#include "TROOT.h"
35
36template <class AParamType>
37class TParameter : public TObject {
38
39public:
40 // Defines options / status while merging:
41 enum EStatusBits { kMultiply = BIT(16), // Use multiplication
42 kMax = BIT(17), // Take max value
43 kMin = BIT(18), // Take min value
44 kFirst = BIT(19), // Take the first value
45 kLast = BIT(20), // Take the last value
46 kIsConst = BIT(21) // Set if all values are equal
47 };
48
49private:
51 AParamType fVal;
52
55
56public:
58 TParameter(const char *name, const AParamType &val)
59 : fName(name), fVal(val) { Reset(); SetBit(kIsConst);}
60 TParameter(const char *name, const AParamType &val, char mergemode)
61 : fName(name), fVal(val) { SetMergeMode(mergemode); SetBit(kIsConst);}
62 virtual ~TParameter()
63 {
64 // Required since we overload TObject::Hash.
66 }
67
68 const char *GetName() const { return fName; }
69 const AParamType &GetVal() const { return fVal; }
70 Bool_t IsConst() const { return (TestBit(kIsConst) ? kTRUE : kFALSE); }
71 void SetVal(const AParamType &val) { fVal = val; }
72
73 // Merging modes:
74 // '+' addition ('OR' for booleans) [default]
75 // '*' multiplication ('AND' for booleans)
76 // 'M' maximum ('OR' for booleans)
77 // 'm' minimum ('AND' for booleans)
78 // 'f' first value
79 // 'l' last value
80 void SetMergeMode(char mergemode = '+') {
81 Reset();
82 if (mergemode == '*') {
84 } else if (mergemode == 'M') {
85 SetBit(kMax);
86 } else if (mergemode == 'm') {
87 SetBit(kMin);
88 } else if (mergemode == 'f') {
90 } else if (mergemode == 'l') {
92 }
93 }
94 virtual ULong_t Hash() const { return fName.Hash(); }
95 virtual Bool_t IsSortable() const { return kTRUE; }
96 virtual Int_t Compare(const TObject *obj) const {
97 // Compare two TParameter objects. Returns 0 when equal, -1 when this is
98 // smaller and +1 when bigger (like strcmp).
99
100 if (this == obj) return 0;
101 return fName.CompareTo(obj->GetName());
102 }
103
104 virtual void ls(Option_t *) const {
105 // Print this parameter content
107 std::cout << "OBJ: " << IsA()->GetName() << "\t" << fName << " = " << fVal << std::endl;
108 }
109
110 virtual void Print(Option_t *) const {
111 // Print this parameter content
113 std::cout << IsA()->GetName() << "\t" << fName << " = " << fVal << std::endl;
114 }
115
116 virtual Int_t Merge(TCollection *in);
117
118 ClassDef(TParameter,2) //Named templated parameter type
119};
120
121template <class AParamType>
123 // Merge objects in the list.
124 // Returns the number of objects that were in the list.
125 TIter nxo(in);
126 Int_t n = 0;
127 while (TObject *o = nxo()) {
128 TParameter<AParamType> *c = dynamic_cast<TParameter<AParamType> *>(o);
129 if (c) {
130 // Check if constant
131 if (fVal != c->GetVal()) ResetBit(kIsConst);
132 if (TestBit(kMultiply)) {
133 // Multiply
134 fVal *= c->GetVal();
135 } else if (TestBit(kMax)) {
136 // Take max
137 if (c->GetVal() > fVal) fVal = c->GetVal();
138 } else if (TestBit(kMin)) {
139 // Take min
140 if (c->GetVal() < fVal) fVal = c->GetVal();
141 } else if (TestBit(kLast)) {
142 // Take the last
143 fVal = c->GetVal();
144 } else if (!TestBit(kFirst)) {
145 // Add, if not asked to take the first
146 fVal += c->GetVal();
147 }
148 n++;
149 }
150 }
151
152 return n;
153}
154
155// Specialization of Merge for Bool_t
156template <>
158{
159 // Merge bool objects in the list.
160 // Returns the number of objects that were in the list.
161 TIter nxo(in);
162 Int_t n = 0;
163 while (TObject *o = nxo()) {
164 TParameter<Bool_t> *c = dynamic_cast<TParameter<Bool_t> *>(o);
165 if (c) {
166 // Check if constant
167 if (fVal != (Bool_t) c->GetVal()) ResetBit(kIsConst);
168 if (TestBit(TParameter::kMultiply) || TestBit(kMin)) {
169 // And
170 fVal &= (Bool_t) c->GetVal();
171 } else if (TestBit(kLast)) {
172 // Take the last
173 fVal = (Bool_t) c->GetVal();
174 } else if (!TestBit(kFirst) || TestBit(kMax)) {
175 // Or
176 fVal |= (Bool_t) c->GetVal();
177 }
178 n++;
179 }
180 }
181
182 return n;
183}
184
185// FIXME: Remove once we implement https://sft.its.cern.ch/jira/browse/ROOT-6284
186// When building with -fmodules, it instantiates all pending instantiations,
187// instead of delaying them until the end of the translation unit.
188// We 'got away with' probably because the use and the definition of the
189// explicit specialization do not occur in the same TU.
190//
191// In case we are building with -fmodules, we need to forward declare the
192// specialization in order to compile the dictionary G__Core.cxx.
193template <> void TParameter<Long64_t>::Streamer(TBuffer &R__b);
195
196#endif
void Class()
Definition: Class.C:29
#define c(i)
Definition: RSha256.hxx:101
int Int_t
Definition: RtypesCore.h:43
const Bool_t kFALSE
Definition: RtypesCore.h:90
unsigned long ULong_t
Definition: RtypesCore.h:53
bool Bool_t
Definition: RtypesCore.h:61
const Bool_t kTRUE
Definition: RtypesCore.h:89
const char Option_t
Definition: RtypesCore.h:64
#define ClassDef(name, id)
Definition: Rtypes.h:322
#define BIT(n)
Definition: Rtypes.h:83
@ kMultiply
Definition: TAttMarker.h:49
char name[80]
Definition: TGX11.cxx:109
Buffer base class used for serializing objects.
Definition: TBuffer.h:42
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:80
Collection abstract base class.
Definition: TCollection.h:63
Mother of all ROOT objects.
Definition: TObject.h:37
virtual const char * GetName() const
Returns name of object.
Definition: TObject.cxx:357
R__ALWAYS_INLINE Bool_t TestBit(UInt_t f) const
Definition: TObject.h:187
void SetBit(UInt_t f, Bool_t set)
Set or unset the user status bits as specified in f.
Definition: TObject.cxx:694
void ResetBit(UInt_t f)
Definition: TObject.h:186
EStatusBits
Definition: TObject.h:57
Named parameter, streamable and storable.
Definition: TParameter.h:37
virtual ~TParameter()
Definition: TParameter.h:62
virtual Bool_t IsSortable() const
Definition: TParameter.h:95
TParameter(const char *name, const AParamType &val, char mergemode)
Definition: TParameter.h:60
virtual Int_t Merge(TCollection *in)
Definition: TParameter.h:122
Bool_t IsConst() const
Definition: TParameter.h:70
virtual void Print(Option_t *) const
This method must be overridden when a class wants to print itself.
Definition: TParameter.h:110
AParamType fVal
Definition: TParameter.h:51
void SetMergeMode(char mergemode='+')
Definition: TParameter.h:80
TString fName
Definition: TParameter.h:50
virtual Int_t Compare(const TObject *obj) const
Compare abstract method.
Definition: TParameter.h:96
void SetVal(const AParamType &val)
Definition: TParameter.h:71
const AParamType & GetVal() const
Definition: TParameter.h:69
const char * GetName() const
Returns name of object.
Definition: TParameter.h:68
virtual void ls(Option_t *) const
The ls function lists the contents of a class on stdout.
Definition: TParameter.h:104
void Reset()
Definition: TParameter.h:53
TParameter(const char *name, const AParamType &val)
Definition: TParameter.h:58
virtual ULong_t Hash() const
Return hash value for this object.
Definition: TParameter.h:94
static void IndentLevel()
Functions used by ls() to indent an object hierarchy.
Definition: TROOT.cxx:2781
Basic string class.
Definition: TString.h:131
int CompareTo(const char *cs, ECaseCompare cmp=kExact) const
Compare a string to char *cs2.
Definition: TString.cxx:418
UInt_t Hash(ECaseCompare cmp=kExact) const
Return hash value.
Definition: TString.cxx:638
const Int_t n
Definition: legend1.C:16
void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition: TROOT.h:395