Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TMVA::Configurable Class Reference

Definition at line 45 of file Configurable.h.

Public Member Functions

 Configurable (const TString &theOption="")
 constructor
 
virtual ~Configurable ()
 default destructor
 
void AddOptionsXMLTo (void *parent) const
 write options to XML file
 
template<class T >
void AddPreDefVal (const T &)
 
template<class T >
void AddPreDefVal (const TString &optname, const T &)
 
void CheckForUnusedOptions () const
 checks for unused options in option string
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc)
 
template<class T >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc)
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
const char * GetConfigDescription () const
 
const char * GetConfigName () const
 
const TStringGetOptions () const
 
virtual TClassIsA () const
 
MsgLoggerLog () const
 
virtual void ParseOptions ()
 options parser
 
void PrintOptions () const
 prints out the options set in the options string and the defaults
 
void ReadOptionsFromStream (std::istream &istr)
 read option back from the weight file
 
void ReadOptionsFromXML (void *node)
 
void SetConfigDescription (const char *d)
 
void SetConfigName (const char *n)
 
void SetMsgType (EMsgType t)
 
void SetOptions (const TString &s)
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void WriteOptionsToStream (std::ostream &o, const TString &prefix) const
 write options to output stream (e.g. in writing the MVA weight files
 
- 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 ("").
 
TObjectClone (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.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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)
 Operator delete [].
 
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)
 
TObjectoperator= (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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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.
 

Protected Member Functions

void EnableLooseOptions (Bool_t b=kTRUE)
 
const TStringGetReferenceFile () const
 
Bool_t LooseOptionCheckingEnabled () const
 
void ResetSetFlag ()
 resets the IsSet flag for all declare options to be called before options are read from stream
 
void WriteOptionsReferenceToFile ()
 write complete options to output stream
 
- 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

MsgLoggerfLogger
 ! message logger
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Private Member Functions

template<class T >
void AssignOpt (const TString &name, T &valAssign) const
 
void SplitOptions (const TString &theOpt, TList &loo) const
 splits the option string at ':' and fills the list 'loo' with the primitive strings
 

Private Attributes

TString fConfigDescription
 description of this configurable
 
OptionBasefLastDeclaredOption
 ! last declared option
 
TList fListOfOptions
 option list
 
Bool_t fLooseOptionCheckingEnabled
 checker for option string
 
TString fOptions
 options string
 
TString fReferenceFile
 reference file for options writing
 

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

#include <TMVA/Configurable.h>

Inheritance diagram for TMVA::Configurable:
[legend]

Constructor & Destructor Documentation

◆ Configurable()

TMVA::Configurable::Configurable ( const TString theOption = "")

constructor

Definition at line 66 of file Configurable.cxx.

◆ ~Configurable()

TMVA::Configurable::~Configurable ( )
virtual

default destructor

Definition at line 84 of file Configurable.cxx.

Member Function Documentation

◆ AddOptionsXMLTo()

void TMVA::Configurable::AddOptionsXMLTo ( void *  parent) const

write options to XML file

Definition at line 349 of file Configurable.cxx.

◆ AddPreDefVal() [1/2]

template<class T >
void TMVA::Configurable::AddPreDefVal ( const T &  val)

Definition at line 168 of file Configurable.h.

◆ AddPreDefVal() [2/2]

template<class T >
void TMVA::Configurable::AddPreDefVal ( const TString optname,
const T &  val 
)

Definition at line 177 of file Configurable.h.

◆ AssignOpt()

template<class T >
void TMVA::Configurable::AssignOpt ( const TString name,
T &  valAssign 
) const
private

Definition at line 204 of file Configurable.h.

◆ CheckForUnusedOptions()

void TMVA::Configurable::CheckForUnusedOptions ( ) const

checks for unused options in option string

Definition at line 270 of file Configurable.cxx.

◆ Class()

static TClass * TMVA::Configurable::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TMVA::Configurable::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::Configurable::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 138 of file Configurable.h.

◆ DeclareOptionRef() [1/4]

template<class T >
TMVA::OptionBase * TMVA::Configurable::DeclareOptionRef ( T &  ref,
const TString name,
const TString desc 
)

Definition at line 147 of file Configurable.h.

◆ DeclareOptionRef() [2/4]

template<class T >
OptionBase * TMVA::Configurable::DeclareOptionRef ( T &  ref,
const TString name,
const TString desc = "" 
)

◆ DeclareOptionRef() [3/4]

template<class T >
TMVA::OptionBase * TMVA::Configurable::DeclareOptionRef ( T *&  ref,
Int_t  size,
const TString name,
const TString desc 
)

Definition at line 157 of file Configurable.h.

◆ DeclareOptionRef() [4/4]

template<class T >
OptionBase * TMVA::Configurable::DeclareOptionRef ( T *&  ref,
Int_t  size,
const TString name,
const TString desc = "" 
)

◆ DeclFileName()

static const char * TMVA::Configurable::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 138 of file Configurable.h.

◆ EnableLooseOptions()

void TMVA::Configurable::EnableLooseOptions ( Bool_t  b = kTRUE)
inlineprotected

Definition at line 96 of file Configurable.h.

◆ GetConfigDescription()

const char * TMVA::Configurable::GetConfigDescription ( ) const
inline

Definition at line 62 of file Configurable.h.

◆ GetConfigName()

const char * TMVA::Configurable::GetConfigName ( ) const
inline

Definition at line 61 of file Configurable.h.

◆ GetOptions()

const TString & TMVA::Configurable::GetOptions ( ) const
inline

Definition at line 84 of file Configurable.h.

◆ GetReferenceFile()

const TString & TMVA::Configurable::GetReferenceFile ( ) const
inlineprotected

Definition at line 102 of file Configurable.h.

◆ IsA()

◆ Log()

MsgLogger & TMVA::Configurable::Log ( ) const
inline

Definition at line 122 of file Configurable.h.

◆ LooseOptionCheckingEnabled()

Bool_t TMVA::Configurable::LooseOptionCheckingEnabled ( ) const
inlineprotected

Definition at line 95 of file Configurable.h.

◆ ParseOptions()

void TMVA::Configurable::ParseOptions ( )
virtual

options parser

Reimplemented in TMVA::CrossValidation, and TMVA::Envelope.

Definition at line 124 of file Configurable.cxx.

◆ PrintOptions()

void TMVA::Configurable::PrintOptions ( ) const

prints out the options set in the options string and the defaults

Definition at line 299 of file Configurable.cxx.

◆ ReadOptionsFromStream()

void TMVA::Configurable::ReadOptionsFromStream ( std::istream &  istr)

read option back from the weight file

Definition at line 435 of file Configurable.cxx.

◆ ReadOptionsFromXML()

void TMVA::Configurable::ReadOptionsFromXML ( void *  node)

Definition at line 378 of file Configurable.cxx.

◆ ResetSetFlag()

void TMVA::Configurable::ResetSetFlag ( )
protected

resets the IsSet flag for all declare options to be called before options are read from stream

Definition at line 113 of file Configurable.cxx.

◆ SetConfigDescription()

void TMVA::Configurable::SetConfigDescription ( const char *  d)
inline

Definition at line 64 of file Configurable.h.

◆ SetConfigName()

void TMVA::Configurable::SetConfigName ( const char *  n)
inline

Definition at line 63 of file Configurable.h.

◆ SetMsgType()

void TMVA::Configurable::SetMsgType ( EMsgType  t)
inline

Definition at line 125 of file Configurable.h.

◆ SetOptions()

void TMVA::Configurable::SetOptions ( const TString s)
inline

Definition at line 85 of file Configurable.h.

◆ SplitOptions()

void TMVA::Configurable::SplitOptions ( const TString theOpt,
TList loo 
) const
private

splits the option string at ':' and fills the list 'loo' with the primitive strings

Definition at line 92 of file Configurable.cxx.

◆ Streamer()

◆ StreamerNVirtual()

void TMVA::Configurable::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 138 of file Configurable.h.

◆ WriteOptionsReferenceToFile()

void TMVA::Configurable::WriteOptionsReferenceToFile ( )
protected

write complete options to output stream

Definition at line 409 of file Configurable.cxx.

◆ WriteOptionsToStream()

void TMVA::Configurable::WriteOptionsToStream ( std::ostream &  o,
const TString prefix 
) const

write options to output stream (e.g. in writing the MVA weight files

Definition at line 333 of file Configurable.cxx.

Member Data Documentation

◆ fConfigDescription

TString TMVA::Configurable::fConfigDescription
private

description of this configurable

Definition at line 116 of file Configurable.h.

◆ fLastDeclaredOption

OptionBase* TMVA::Configurable::fLastDeclaredOption
private

! last declared option

Definition at line 113 of file Configurable.h.

◆ fListOfOptions

TList TMVA::Configurable::fListOfOptions
private

option list

Definition at line 114 of file Configurable.h.

◆ fLogger

MsgLogger* TMVA::Configurable::fLogger
mutableprotected

! message logger

Definition at line 128 of file Configurable.h.

◆ fLooseOptionCheckingEnabled

Bool_t TMVA::Configurable::fLooseOptionCheckingEnabled
private

checker for option string

Definition at line 110 of file Configurable.h.

◆ fOptions

TString TMVA::Configurable::fOptions
private

options string

Definition at line 109 of file Configurable.h.

◆ fReferenceFile

TString TMVA::Configurable::fReferenceFile
private

reference file for options writing

Definition at line 117 of file Configurable.h.

Libraries for TMVA::Configurable:

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