ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
TMVA::Configurable Class Reference

Definition at line 51 of file Configurable.h.

Public Member Functions

 Configurable (const TString &theOption="")
 
virtual ~Configurable ()
 default destructur More...
 
virtual void ParseOptions ()
 options parser More...
 
void PrintOptions () const
 prints out the options set in the options string and the defaults More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
const char * GetConfigName () const
 
const char * GetConfigDescription () const
 
void SetConfigName (const char *n)
 
void SetConfigDescription (const char *d)
 
template<class T >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
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 More...
 
const TStringGetOptions () const
 
void SetOptions (const TString &s)
 
void WriteOptionsToStream (std::ostream &o, const TString &prefix) const
 write options to output stream (e.g. in writing the MVA weight files More...
 
void ReadOptionsFromStream (std::istream &istr)
 read option back from the weight file More...
 
void AddOptionsXMLTo (void *parent) const
 write options to XML file More...
 
void ReadOptionsFromXML (void *node)
 
void SetMsgType (EMsgType t)
 
template<class T >
TMVA::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)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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 Int_t Compare (const TObject *obj) const
 Compare abstract method. 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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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 IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

Bool_t LooseOptionCheckingEnabled () const
 
void EnableLooseOptions (Bool_t b=kTRUE)
 
void WriteOptionsReferenceToFile ()
 write complete options to output stream More...
 
void ResetSetFlag ()
 resets the IsSet falg for all declare options to be called before options are read from stream More...
 
const TStringGetReferenceFile () const
 
MsgLoggerLog () const
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Private Member Functions

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

Private Attributes

TString fOptions
 
Bool_t fLooseOptionCheckingEnabled
 options string More...
 
OptionBasefLastDeclaredOption
 checker for option string More...
 
TList fListOfOptions
 last declared option More...
 
TString fConfigName
 option list More...
 
TString fConfigDescription
 
TString fReferenceFile
 
MsgLoggerfLogger
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TMVA/Configurable.h>

+ Inheritance diagram for TMVA::Configurable:
+ Collaboration diagram for TMVA::Configurable:

Constructor & Destructor Documentation

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

default destructur

Definition at line 87 of file Configurable.cxx.

Member Function Documentation

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

write options to XML file

Definition at line 342 of file Configurable.cxx.

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

Definition at line 177 of file Configurable.h.

Referenced by TMVA::SimulatedAnnealingFitter::DeclareOptions().

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

Definition at line 186 of file Configurable.h.

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

message logger

Definition at line 213 of file Configurable.h.

void TMVA::Configurable::CheckForUnusedOptions ( ) const

checks for unused options in option string

Definition at line 273 of file Configurable.cxx.

Referenced by TMVA::OptimizeConfigParameters::optimizeFit(), and TMVA::MethodCuts::Train().

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

Definition at line 156 of file Configurable.h.

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

Definition at line 166 of file Configurable.h.

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

Definition at line 103 of file Configurable.h.

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

Definition at line 69 of file Configurable.h.

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

Definition at line 68 of file Configurable.h.

Referenced by GetName().

virtual const char* TMVA::Configurable::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.

Reimplemented in TMVA::MethodBase, TMVA::Reader, TMVA::PDF, TMVA::Factory, and TMVA::FitterBase.

Definition at line 67 of file Configurable.h.

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

Definition at line 91 of file Configurable.h.

Referenced by TMVA::MethodCompositeBase::AddWeightsXMLTo().

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

Definition at line 109 of file Configurable.h.

MsgLogger& TMVA::Configurable::Log ( ) const
inlineprotected
Bool_t TMVA::Configurable::LooseOptionCheckingEnabled ( ) const
inlineprotected

Definition at line 102 of file Configurable.h.

void TMVA::Configurable::ParseOptions ( )
virtual
void TMVA::Configurable::PrintOptions ( ) const

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

Definition at line 302 of file Configurable.cxx.

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

read option back from the weight file

Definition at line 428 of file Configurable.cxx.

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

Definition at line 371 of file Configurable.cxx.

void TMVA::Configurable::ResetSetFlag ( )
protected

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

Definition at line 116 of file Configurable.cxx.

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

Definition at line 71 of file Configurable.h.

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

Definition at line 70 of file Configurable.h.

Referenced by TMVA::DataSetFactory::InitOptions(), and TMVA::Reader::Reader().

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

Definition at line 135 of file Configurable.h.

Referenced by TMVA::MethodCompositeBase::ReadWeightsFromXML().

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

Definition at line 92 of file Configurable.h.

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 95 of file Configurable.cxx.

void TMVA::Configurable::WriteOptionsReferenceToFile ( )
protected

write complete options to output stream

Definition at line 402 of file Configurable.cxx.

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 326 of file Configurable.cxx.

Referenced by TMVA::MethodLikelihood::WriteOptionsToStream().

Member Data Documentation

TString TMVA::Configurable::fConfigDescription
private

Definition at line 124 of file Configurable.h.

Referenced by GetConfigDescription(), and SetConfigDescription().

TString TMVA::Configurable::fConfigName
private

option list

Definition at line 123 of file Configurable.h.

Referenced by GetConfigName(), and SetConfigName().

OptionBase* TMVA::Configurable::fLastDeclaredOption
private

checker for option string

Definition at line 120 of file Configurable.h.

Referenced by DeclareOptionRef().

TList TMVA::Configurable::fListOfOptions
private

last declared option

Definition at line 121 of file Configurable.h.

Referenced by DeclareOptionRef().

MsgLogger* TMVA::Configurable::fLogger
mutableprivate

Definition at line 140 of file Configurable.h.

Referenced by Log(), SetMsgType(), and ~Configurable().

Bool_t TMVA::Configurable::fLooseOptionCheckingEnabled
private

options string

Definition at line 117 of file Configurable.h.

Referenced by EnableLooseOptions(), and LooseOptionCheckingEnabled().

TString TMVA::Configurable::fOptions
private

Definition at line 116 of file Configurable.h.

Referenced by GetOptions(), and SetOptions().

TString TMVA::Configurable::fReferenceFile
private

Definition at line 125 of file Configurable.h.

Referenced by GetReferenceFile().


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