Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

(UNKNOWN PRODUCT) » MBSSETUP » TMbsSetup

class TMbsSetup: public TMrbEnv

__________________________________________________[C++ CLASS IMPLEMENTATION]

 Name:           mbssetup/src/TMbsSetup.cxx
 Purpose:        MBS setup
 Description:    Implements class methods to define a MBS setup
 Keywords:
 Author:         R. Lutter
 Mailto:         <a href=mailto:rudi.lutter@physik.uni-muenchen.de>R. Lutter</a>
 Revision:       $Id: TMbsSetup.cxx,v 1.70 2011-03-08 10:31:22 Marabou Exp $
 Date:           $Date: 2011-03-08 10:31:22 $

 Class TMbsSetup refers to a resource file in user's working directory
 named ".mbssetup" (if not defined otherwise).

Function Members (Methods)

public:

	TMbsSetup(const Char_t* SetupFile = ".mbssetup")
virtual	~TMbsSetup()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
Bool_t	CheckSetup()
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
Int_t	TMrbEnv::CopyDefaults(const TRegexp& Regexp, Bool_t OverWrite = kFALSE, TMrbLofNamedX* LofSubstitutions = 0)
Int_t	TMrbEnv::CopyDefaults(const Char_t* Resource, Bool_t ExactMatch = kTRUE, Bool_t OverWrite = kFALSE, TMrbLofNamedX* LofSubstitutions = 0)
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
const Char_t*	EncodeArray(TArrayI& Data, Int_t NofEntries, Int_t Base = 10)
const Char_t*	EncodeArray(Int_t Data, Int_t Index, Int_t NofEntries, Int_t Base = 10)
virtual void	TObject::Error(const char* method, const char* msgfmt) const
TMbsEvtBuilder*	EvtBuilder()
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
Int_t	TMrbEnv::Find(const Char_t* LofPrefixes, const Char_t* Resource, Int_t Default)
const Char_t*	TMrbEnv::Find(TString& Result, const Char_t* LofPrefixes, const Char_t* Resource, const Char_t* Default = "")
const Char_t*	TMrbEnv::Find(TMrbNamedX& Result, const Char_t* LofPrefixes, const Char_t* Resource, const Char_t* Default = "")
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
TMbsReadoutProc*	FirstReadout()
Int_t	TMrbEnv::Get(const Char_t* Resource, Int_t Default)
Double_t	TMrbEnv::Get(const Char_t* Resource, Double_t Default)
const Char_t*	TMrbEnv::Get(TString& Result, const Char_t* Resource, const Char_t* Default = "")
const Char_t*	TMrbEnv::Get(TMrbNamedX& Result, const Char_t* Resource, const Char_t* Default = "")
Int_t	TMrbEnv::GetDefault(const Char_t* Resource, Int_t Default)
const Char_t*	TMrbEnv::GetDefault(TString& Result, const Char_t* Resource, const Char_t* Default = "")
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
TEnv*	TMrbEnv::GetEnv()
const Char_t*	GetHomeDir()
virtual const char*	TObject::GetIconName() const
TMrbNamedX*	GetMode()
virtual const char*	TObject::GetName() const
Int_t	GetNofReadouts()
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
const Char_t*	GetPath()
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
Bool_t	TMrbEnv::HasDefaults() const
virtual ULong_t	TObject::Hash() const
void	Help()
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TMrbEnv::IsModified() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	IsVerbose()
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
Bool_t	MakeSetupFiles()
void	TObject::MayNotUse(const char* method) const
TMbsReadoutProc*	NextReadout(TMbsReadoutProc* Readout)
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
Bool_t	TMrbEnv::Open(const Char_t* ResourceFile)
Bool_t	TMrbEnv::OpenDefaults(const Char_t* DefaultsFile)
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::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)
TMrbEnv&	TMrbEnv::operator=(const TMrbEnv&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
void	TMrbEnv::Print() const
virtual void	TMrbEnv::Print(Option_t* Option) const
void	TMrbEnv::PrintDefaults() const
void	TMrbEnv::PrintInfo()
Int_t	TMrbEnv::Purge(Bool_t Verbose = kFALSE)
virtual Int_t	TObject::Read(const char* name)
TMbsReadoutProc*	ReadoutProc(Int_t ReadoutId)
virtual void	TObject::RecursiveRemove(TObject* obj)
const Char_t*	RemoteHomeDir()
Int_t	TMrbEnv::Remove(const TRegexp& Regexp)
Int_t	TMrbEnv::Remove(const Char_t* Resource, Bool_t ExactMatch = kTRUE)
void	RemoveSetup()
void	Reset()
void	TObject::ResetBit(UInt_t f)
const Char_t*	TMrbEnv::Resource(TString& R, const Char_t* F1, Int_t X1 = -1, const Char_t* F2 = "", Int_t X2 = -1, const Char_t* F3 = "") const
void	TMrbEnv::Save(Bool_t Verbose = kTRUE)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
Bool_t	TMrbEnv::Set(const Char_t* Resource, const Char_t* StrVal)
Bool_t	TMrbEnv::Set(const Char_t* Resource, Int_t IntVal, Int_t Base = 10)
Bool_t	TMrbEnv::Set(const Char_t* Resource, Double_t DblVal, Int_t Precision = 4)
Bool_t	TMrbEnv::Set(const Char_t* Resource, TMrbNamedX* NamedVal, Int_t Base = 10)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
Bool_t	SetHomeDir(const Char_t* HomeDir)
Bool_t	SetHomeDirFromRemote()
Bool_t	SetMode(const Char_t* Mode)
Bool_t	SetMode(EMbsSetupMode Mode)
Bool_t	SetNofReadouts(Int_t NofReadouts)
static void	TObject::SetObjectStat(Bool_t stat)
Bool_t	SetPath(const Char_t* Path, Bool_t Create = kFALSE)
void	TMrbEnv::SetPrefix(const Char_t* Prefix)
Int_t	TMrbEnv::SetUndef(const TRegexp& Regexp)
Int_t	TMrbEnv::SetUndef(const Char_t* Resource, Bool_t ExactMatch = kTRUE)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector&)
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

Bool_t	CreateNodeList(TString& NodeListFile)
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
Bool_t	ExpandFile(Int_t ProcID, TString& TemplatePath, TString& SetupFile, TString& DestPath, TString& DestFile)
Bool_t	GetRcVal(UInt_t& RcValue, const Char_t* Resource, const Char_t* ContrlType = "", const Char_t ProcType = "", const Char_t Mode = "", const Char_t MbsVersion = "", const Char_t LynxVersion = "*")
void	TObject::MakeZombie()
Bool_t	WriteRhostsFile(TString& RhostsFile)

Data Members

public:

enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

public:

TMrbLofNamedX	fLofControllers	... crate controllers
TMrbLofNamedX	fLofProcs	... processors
TMrbLofNamedX	fLofSetupModes	... setup modes
TMrbLofNamedX	fLofSetupTags	... setup tags
TMrbLofNamedX	fLofTriggerModes	... trigger modes
TMrbLofNamedX	fLofTriggerModules	... trigger modules

protected:

TString	fArrayString	temp storage method EncodeArray()
TEnv*	TMrbEnv::fCurEnv	current resource data base
TString	TMrbEnv::fCurFile	path to current resource file
TEnv*	TMrbEnv::fDefaultsEnv	defaults data base
TString	TMrbEnv::fDefaultsFile	path to default resource file
TMbsEvtBuilder*	fEvtBuilder	! event builder (master)
TString	fHomeDir	temp storage: home dir
Bool_t	TMrbEnv::fIsModified	kTRUE, if at least 1 entry modified
Bool_t	TMrbEnv::fIsSystemEnv	if mapped to gEnv
TObjArray	fLofReadouts	readout processors (slaves)
TString	fPath	... path
TString	TMrbEnv::fPrefix	prefix
TMbsReadoutProc*	fReadoutError	! ... error
TString	fRemoteHome	... remote home dir
TString	fRemoteMbsHome	... as seen from mbs
TString	TMrbEnv::fResourceName	resource name
TEnv*	fSettings	! settings depending on lynx, mbs, cpu etc.
TString	fTemplatePath	where to find template files
Bool_t	fVerbose	verbose mode

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TMbsSetup(const Char_t* SetupFile = ".mbssetup")

__________________________________________________________________[C++ CTOR]

 Name:           TMbsSetup
 Purpose:        Define a MBS setup
 Arguments:      Char_t * SetupFile -- name of setup file
 Results:        --
 Exceptions:
 Description:    Class constructor
 Keywords:

~TMbsSetup()

__________________________________________________________________[C++ DTOR]

 Name:           TMbsSetup
 Purpose:        Delete a MBS setup
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Class destructor
 Keywords:

Bool_t GetRcVal(UInt_t& RcValue, const Char_t* Resource, const Char_t* ContrlType = "*", const Char_t* ProcType = "*", const Char_t* Mode = "*", const Char_t* MbsVersion = "*", const Char_t* LynxVersion = "*")

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::GetRcVal
 Purpose:        Get value from settings file
 Arguments:      UInt_t & RcValue        -- resulting settings value
                 Char_t * Resource       -- resource name
                 Char_t * ContrlType     -- type of controller
                 Char_t * ProcType       -- type of processor
                 Char_t * Mode           -- mode: single/multi proc, multi branch
                 Char_t * MbsVersion     -- MBS' version
                 Char_t * LynxVersion    -- version of lynxOs
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Reads settings from file mbssetup.rc
                 Format:
                 <LynxVersion>.<MbsVersion>.<CpuType>.<ContrType>.<Resource>:	<Value>
 Keywords:

void RemoveSetup()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::RemoveSetup
 Purpose:        Remove entries from setup data base
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Remove resources "TMbsSetup.*".
 Keywords:

void Reset()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::Reset
 Purpose:        Reset resources to default values
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Resets resources "TMbsSetup.*".
 Keywords:

TMbsReadoutProc * ReadoutProc(Int_t ReadoutId)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::ReadoutProc
 Purpose:        Return addr of readout process
 Arguments:      Int_t ReadoutId         -- proc id
 Results:        TMbsReadoutProc * Proc  -- process
 Exceptions:
 Description:    Returns addr of readout proc defined by its id.
                 Legal ids start with 1.
 Keywords:

Bool_t SetHomeDir(const Char_t* HomeDir)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::SetHomeDir
 Purpose:        Define user's home dir
 Arguments:      Char_t * HomeDir    -- home directory
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sets resource "TMbsSetup.HomeDir".
                 HomeDir is user's home directory as seen from MBS.
 Keywords:

const Char_t * GetHomeDir()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::GetHomeDir
 Purpose:        Read user's home dir
 Arguments:      --
 Results:        Char_t * HomeDir       -- home directory
 Exceptions:
 Description:    Gets resource "TMbsSetup.HomeDir".
                 HomeDir is user's home directory as seen from MBS.
 Keywords:

Bool_t SetPath(const Char_t* Path, Bool_t Create = kFALSE)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::SetPath
 Purpose:        Define path where to write setup files
 Arguments:      Char_t * Path       -- path name
                 Bool_t Create       -- kTRUE if path is to be created
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sets resource "TMbsSetup.Path".
 Keywords:

const Char_t * GetPath()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::GetPath
 Purpose:        Read path where to write setup files
 Arguments:      --
 Results:        Char_t * Path       -- path name
 Exceptions:
 Description:    Gets resource "TMbsSetup.Path".
 Keywords:

Bool_t SetNofReadouts(Int_t NofReadouts)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::SetNofReadouts
 Purpose:        Define number of readout procs
 Arguments:      Int_t NofReadouts    -- number of readout procs
 Results:        --
 Exceptions:
 Description:    Sets resource "TMbsSetup.NofReadouts".
 Keywords:

Int_t GetNofReadouts()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::GetNofReadouts
 Purpose:        Return number of readout procs
 Arguments:      --
 Results:        Int_t NofReadouts    -- number of readout procs
 Exceptions:
 Description:    Reads resource "TMbsSetup.NofReadouts".
 Keywords:

Bool_t MakeSetupFiles()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::MakeSetupFiles
 Purpose:        Install setup files
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Generates setup files from templates.
 Keywords:

Bool_t WriteRhostsFile(TString& RhostsFile)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::WriteRhostsFile
 Purpose:        Rewrite .rhosts in home dir
 Arguments:      TString RhostsFile   -- path to .rhosts
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Creates a new .rhosts file containing all Lynx and Marabou
                 hosts.
 Keywords:

Bool_t CreateNodeList(TString& NodeListFile)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::CreateNodeList
 Purpose:        Rewrite node list for MBS
 Arguments:      TString NodeListFile   -- path to node_list.txt
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Creates file node_list.txt
 Keywords:

Bool_t ExpandFile(Int_t ProcID, TString& TemplatePath, TString& SetupFile, TString& DestPath, TString& DestFile)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::ExpandFile
 Purpose:        Expand setup file
 Arguments:      Int_t ProcID                 -- readout proc id
                 TString & TemplatePath       -- where templates reside
                 TString & SrcFile            -- template source
                 TString & DestPath           -- destination
                 TString & DestFile           -- where to write expanded code
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Opens a template file and expands it.
 Keywords:

const Char_t * EncodeArray(TArrayI& Data, Int_t NofEntries, Int_t Base = 10)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::EncodeArray
 Purpose:        Fill array data in a string
 Arguments:      TArray & Data         -- data to be encoded
                 Int_t NofEntries      -- number of data entries
                 Int_t Base            -- base
 Results:        Char_t * ArrayString  -- string representing array data
 Exceptions:
 Description:    Produces a string "(d1, d2, ..., dN)".
 Keywords:

const Char_t * EncodeArray(Int_t Data, Int_t Index, Int_t NofEntries, Int_t Base = 10)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::EncodeArray
 Purpose:        Fill array data in a string
 Arguments:      Int_t Data            -- data to be encoded
                 Int_t Index           -- array index
                 Int_t NofEntries      -- number of data points
                 Int_t Base            -- base
 Results:        Char_t * ArrayString  -- string representing array data
 Exceptions:
 Description:    Produces a string "(0, ..., d, ..., 0)".
 Keywords:

Bool_t CheckSetup()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::CheckSetup
 Purpose:        Consistency check
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Checks resource data base for its consistency.
 Keywords:

const Char_t * RemoteHomeDir()

________________________________________________________________[C++ METHOD]

 Name:           TMbsEvtBuilder::RemoteHomeDir
 Purpose:        Get user's home directory as seen from MBS
 Arguments:      --
 Results:        Char_t * HomeDir    -- home directory
 Exceptions:
 Description:    Tries a "rsh <proc> pwd".
 Keywords:

Bool_t SetHomeDirFromRemote()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::SetHomeDirFromRemote
 Purpose:        Set user's home directory as seen from MBS
 Arguments:
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Defines resource "TMbsSetup.HomeDir".
 Keywords:

Bool_t SetMode(const Char_t* Mode)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::SetMode
 Purpose:        Define setup mode
 Arguments:      Char_t * Mode    -- setup mode
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Defines resource "TMbsSetup.Mode".
 Keywords:

Bool_t SetMode(EMbsSetupMode Mode)

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::SetMode
 Purpose:        Define setup mode
 Arguments:      EMbsSetupMode Mode    -- setup mode
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Defines resource "TMbsSetup.Mode".
 Keywords:

TMrbNamedX * GetMode()

________________________________________________________________[C++ METHOD]

 Name:           TMbsSetup::GetMode
 Purpose:        Read setup mode
 Arguments:      --
 Results:        TMrbNamedX * Mode
 Exceptions:
 Description:    Reads resource "TMbsSetup.Mode".
 Keywords:

TMbsReadoutProc * FirstReadout()

{ return((TMbsReadoutProc *) fLofReadouts.First()); }

TMbsReadoutProc * NextReadout(TMbsReadoutProc* Readout)

Bool_t IsVerbose()

{ return(fVerbose); }

void Help()

{ gSystem->Exec(Form("mrbHelp %s", this->ClassName())); }