/usr/include/root/TMVA/Configurable.h is in libroot-tmva-dev 5.34.19+dfsg-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | // @(#)root/tmva $Id$
// Author: Andreas Hoecker, Joerg Stelzer, Helge Voss
/**********************************************************************************
* Project: TMVA - a Root-integrated toolkit for multivariate data analysis *
* Package: TMVA *
* Class : Configurable *
* Web : http://tmva.sourceforge.net *
* *
* Description: *
* Base class for all classes with option parsing *
* *
* Authors (alphabetical): *
* Andreas Hoecker <Andreas.Hocker@cern.ch> - CERN, Switzerland *
* Joerg Stelzer <Joerg.Stelzer@cern.ch> - CERN, Switzerland *
* Helge Voss <Helge.Voss@cern.ch> - MPI-K Heidelberg, Germany *
* *
* Copyright (c) 2005: *
* CERN, Switzerland *
* MPI-K Heidelberg, Germany *
* *
* Redistribution and use in source and binary forms, with or without *
* modification, are permitted according to the terms listed in LICENSE *
* (http://tmva.sourceforge.net/LICENSE) *
**********************************************************************************/
#ifndef ROOT_TMVA_Configurable
#define ROOT_TMVA_Configurable
//////////////////////////////////////////////////////////////////////////
// //
// Configurable //
// //
// Base class for all classes with option parsing //
// //
//////////////////////////////////////////////////////////////////////////
#ifndef ROOT_TObject
#include "TObject.h"
#endif
#ifndef ROOT_TList
#include "TList.h"
#endif
#ifndef ROOT_TMVA_Option
#include "TMVA/Option.h"
#endif
namespace TMVA {
class Configurable : public TObject {
public:
// constructur
Configurable( const TString& theOption = "" );
// default destructur
virtual ~Configurable();
// parse the internal option string
virtual void ParseOptions();
// print list of defined options
void PrintOptions() const;
virtual const char* GetName() const { return GetConfigName(); }
const char* GetConfigName() const { return fConfigName; }
const char* GetConfigDescription() const { return fConfigDescription; }
void SetConfigName ( const char* n ) { fConfigName = TString(n); }
void SetConfigDescription( const char* d ) { fConfigDescription = TString(d); }
// Declare option and bind it to a variable
template<class T>
OptionBase* DeclareOptionRef( T& ref, const TString& name, const TString& desc = "" );
template<class T>
OptionBase* DeclareOptionRef( T*& ref, Int_t size, const TString& name, const TString& desc = "" );
// Add a predefined value to the last declared option
template<class T>
void AddPreDefVal(const T&);
// Add a predefined value to the option named optname
template<class T>
void AddPreDefVal(const TString&optname ,const T&);
void CheckForUnusedOptions() const;
const TString& GetOptions() const { return fOptions; }
void SetOptions(const TString& s) { fOptions = s; }
void WriteOptionsToStream ( std::ostream& o, const TString& prefix ) const;
void ReadOptionsFromStream( std::istream& istr );
void AddOptionsXMLTo( void* parent ) const;
void ReadOptionsFromXML( void* node );
protected:
Bool_t LooseOptionCheckingEnabled() const { return fLooseOptionCheckingEnabled; }
void EnableLooseOptions( Bool_t b = kTRUE ) { fLooseOptionCheckingEnabled = b; }
void WriteOptionsReferenceToFile();
void ResetSetFlag();
const TString& GetReferenceFile() const { return fReferenceFile; }
private:
// splits the option string at ':' and fills the list 'loo' with the primitive strings
void SplitOptions(const TString& theOpt, TList& loo) const;
TString fOptions; //! options string
Bool_t fLooseOptionCheckingEnabled; //! checker for option string
// classes and method related to easy and flexible option parsing
OptionBase* fLastDeclaredOption; //! last declared option
TList fListOfOptions; //! option list
TString fConfigName; // the name of this configurable
TString fConfigDescription; // description of this configurable
TString fReferenceFile; // reference file for options writing
protected:
// the mutable declaration is needed to use the logger in const methods
MsgLogger& Log() const { return *fLogger; }
public:
// set message type
void SetMsgType( EMsgType t ) { fLogger->SetMinType(t); }
private:
mutable MsgLogger* fLogger; //! message logger
template <class T>
void AssignOpt( const TString& name, T& valAssign ) const;
public:
ClassDef(Configurable,0) // Virtual base class for all TMVA method
};
} // namespace TMVA
// Template Declarations go here
//______________________________________________________________________
template <class T>
TMVA::OptionBase* TMVA::Configurable::DeclareOptionRef( T& ref, const TString& name, const TString& desc)
{
// set the reference for an option
OptionBase* o = new Option<T>(ref, name, desc);
fListOfOptions.Add(o);
fLastDeclaredOption = o;
return o;
}
template <class T>
TMVA::OptionBase* TMVA::Configurable::DeclareOptionRef( T*& ref, Int_t size, const TString& name, const TString& desc)
{
// set the reference for an option
OptionBase* o = new Option<T*>(ref, size, name, desc);
fListOfOptions.Add(o);
fLastDeclaredOption = o;
return o;
}
//______________________________________________________________________
template<class T>
void TMVA::Configurable::AddPreDefVal(const T& val)
{
// add predefined option value to the last declared option
Option<T>* oc = dynamic_cast<Option<T>*>(fLastDeclaredOption);
if(oc!=0) oc->AddPreDefVal(val);
}
//______________________________________________________________________
template<class T>
void TMVA::Configurable::AddPreDefVal(const TString &optname, const T& val)
{
// add predefined option value to the option named optname
TListIter optIt( &fListOfOptions );
while (OptionBase * op = (OptionBase *) optIt()) {
if (optname == TString(op->TheName())){
Option<T>* oc = dynamic_cast<Option<T>*>(op);
if(oc!=0){
oc->AddPreDefVal(val);
return;
}
else{
Log() << kFATAL << "Option \"" << optname
<< "\" was found, but somehow I could not convert the pointer propperly.. please check the syntax of your option declaration" << Endl;
return;
}
}
}
Log() << kFATAL << "Option \"" << optname
<< "\" is not declared, hence cannot add predefined value, please check the syntax of your option declaration" << Endl;
}
//______________________________________________________________________
template <class T>
void TMVA::Configurable::AssignOpt(const TString& name, T& valAssign) const
{
// assign an option
TObject* opt = fListOfOptions.FindObject(name);
if (opt!=0) valAssign = ((Option<T>*)opt)->Value();
else
Log() << kFATAL << "Option \"" << name
<< "\" not declared, please check the syntax of your option string" << Endl;
}
#endif
|