class HParSet: public TNamed

_HADES_CLASS_DESCRIPTION

  HParSet

  Base class for all parameter containers

  Parameter containers are typically created via the container factories (library
  specific classes derived from HContFact) and stored in the runtime database HRuntimeDb
  for initialization. Each parameter container is directly derived from HParSet or from
  HParCond (derived itself from HParSet).

  Data members:
    name, title     name and title of the parameter container and set in the constructor
    context         String to define a special flavor for the parameters
                    For classes directly derived from HParSet, the context in not
                    mandatory. The context defined in the constructor is the default
                    context. Others may be set via the container factory.
    detName         name of the corresponding detector
                    It is mandatory for all parameter containers which might initialize
                    only a subset of the modules or want to check if all modules in the
                    setup are initialized from one or two inputs
    versions[3]     version[0]   actually not used
                    version[1] = version of the parameters taken from the first input
                    version[2] = version of the parameters taken from the second input
    status          By default this flag is kFALSE and the parameters are initialized
                    for each run. Once set kTRUE, the containers is skipped in the
                    automatic initialization in the runtime database.
                    Set function:  void setStatic(Bool_t flag=kTRUE)
                    Get function:  Bool_t isStatic()
    changed         By default this flag is kFALSE and set kTRUE after each initialization,
                    which signals, that the container must be written to the output before
                    the data are overwritten by the next initialization or before the
                    container is deleted. The write function then again resets the flag.
                    Set function:  void setChanged(Bool_t flag=kTRUE)
                    Get function:  Bool_t hasChanged()
    author, description    comments for the parameters in Oracle

  Virtual functions which must be implemented in the derived class:
    Bool_t init(HParIo*,Int_t*)
        This function initializes the container from an input using the detector specific
        interface class of type HDetParIo.
        Eventually the integer array is used to read only a subset of data.
    Int_t write(HParIo*)
        This function writes the container to an output using the detector specific
        interface class of type HDetParIo.
    void clear()
        This functions clears the container and resets the input/output versions


Function Members (Methods)

public:
HParSet(const HParSet&)
HParSet(const Char_t* name = "", const Char_t* title = "", const Char_t* context = "")
virtual~HParSet()
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidclear()
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
voidcopyComment(HParSet& r)
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
const Char_t*getAuthor() const
const Char_t*getDescription() const
const Text_t*getDetectorName()
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
Int_tgetInputVersion(Int_t i)
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
const Char_t*getParamContext() const
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
Bool_thasChanged()
virtual ULong_tTNamed::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual Bool_tinit()
virtual Bool_tinit(HParIo* io)
virtual Bool_tinit(HParIo*, Int_t*)
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTNamed::IsSortable() const
Bool_tisStatic()
Bool_tTObject::IsZombie() const
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
HParSet&operator=(const HParSet&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidprint()
virtual voidTNamed::Print(Option_t* option = "") const
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
voidresetInputVersions()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
voidsetAuthor(const Char_t* s)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
voidsetChanged(Bool_t flag = kTRUE)
voidsetDescription(const Char_t* s)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
voidsetInputVersion(Int_t v = -1, Int_t i = 0)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
voidsetParamContext(const Char_t*)
voidsetStatic(Bool_t flag = kTRUE)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_twrite()
virtual Int_twrite(HParIo*)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()

Data Members

public:
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TStringauthorAuthor of parameters
Bool_tchanged! flag is kTRUE if parameters have changed
TStringdescriptionDescription of parameters
Text_tdetName[10]! name of the detector the container belongs to
TStringTNamed::fNameobject identifier
TStringTNamed::fTitleobject title
TStringparamContextContext/purpose for parameters and conditions
Bool_tstatus! static flag
Int_tversions[3]! versions of container in the 2 possible inputs

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

HParSet(const Char_t* name = "", const Char_t* title = "", const Char_t* context = "")
 constructor sets the name, title, context and default values for the other data elements
Bool_t init(HParIo* io)
 Tries to initializes the container from the first input in the runtime database.
 If this is not successful, it is initialized from the second input.
 If this fails too, it returns an error.
 (calls internally the init(HParIo*,Int_t*) function in the derived class)
 If the detector name is defined, a setup array is temporarily created to initialize
 only the modules in the detector setup and to check at the end, if all modules in
 the setup are initialized.
Int_t write()
 writes the container to the output defined in the runtime database
 returns the output version in the ROOT file
 returns -1 if an error occured
 (calls internally the write function in the derived class)
void print()
 prints information about the container (context,author,description,versions,status,changed...)
void resetInputVersions()
 resets the input versions if the container is not static
void setParamContext(const Char_t* )
 Sets the context (normally done via the constructor)
void Streamer(TBuffer& b)
 Streams an object of class HParSet.
HParSet(const Char_t* name = "", const Char_t* title = "", const Char_t* context = "")
virtual ~HParSet()
{}
Bool_t init(HParIo* io)
{ return init(0); }
Bool_t init(HParIo* io)
Int_t write()
void clear()
{;}
const Text_t* getDetectorName()
{return detName;}
void setInputVersion(Int_t v = -1, Int_t i = 0)
Int_t getInputVersion(Int_t i)
void setStatic(Bool_t flag = kTRUE)
{status=flag;}
Bool_t isStatic()
{return status;}
void setChanged(Bool_t flag = kTRUE)
{changed=flag;}
Bool_t hasChanged()
{return changed;}
const Char_t* getParamContext() const
{ return paramContext.Data(); }
void setAuthor(const Char_t* s)
{author=s;}
const Char_t* getAuthor() const
{ return author.Data(); }
void setDescription(const Char_t* s)
{description=s;}
const Char_t* getDescription() const
{ return description.Data(); }
void copyComment(HParSet& r)

Last change: Sat May 22 13:06:29 2010
Last generated: 2010-05-22 13:06

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.