Quick Links: ROOT Homepage Class Index Class Hierarchy

Sections: class description function members data members class charts

(UNKNOWN PRODUCT) » INCLUDE » TMrbModule

class TMrbModule: public TNamed

_________________________________________________[C++ CLASS DEFINITION FILE]

 Name:           expconf/inc/TMrbModule.h
 Purpose:        Define experimental configuration for MARaBOU
 Class:          TMrbModule           -- base class for camac & vme modules
 Description:    Class definitions to implement a configuration front-end for MARaBOU
 Author:         R. Lutter
 Revision:       $Id: TMrbModule.h,v 1.24 2011-05-18 11:04:49 Marabou Exp $
 Date:
 Keywords:

Function Members (Methods)

public:

	TMrbModule()
	TMrbModule(const Char_t* ModuleName, const Char_t* ModuleID, Int_t NofChannels, Int_t Range)
virtual	~TMrbModule()
void	TObject::AbstractMethod(const char* method) const
Bool_t	AllocateHistograms(Bool_t Flag = kTRUE)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
Bool_t	CheckID(TMrbConfig::EMrbModuleID ModuleID) const
Bool_t	CheckIfPatternIsContiguous() const
virtual Bool_t	CheckProcType()
virtual Bool_t	CheckSubeventType(TMrbSubevent* Subevent) const
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
Bool_t	ConvertToInt() const
virtual void	TNamed::Copy(TObject& named) const
void	CreateHistoArray(const Char_t* ArrayName = 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
virtual void	TObject::Error(const char* method, const char* msgfmt) const
void	ExcludeFromReadout(Bool_t ExcludeFlag = kTRUE)
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
virtual void	TNamed::FillBuffer(char*& buffer)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
TMrbNamedX*	FindRegister(const Char_t* RegName) const
TMrbNamedX*	FindRegister(Int_t RegIndex) const
Int_t	Get(const Char_t* RegName, Int_t Channel = -1) const
Int_t	Get(Int_t RegIndex, Int_t Channel = -1) const
Int_t	GetBinning() const
Int_t	GetBinRange() const
TMrbModuleChannel*	GetChannel(Int_t) const
virtual const Char_t*	GetCommonCodeFile()
Int_t	GetCrate() const
TMrbNamedX*	GetDataType() const
virtual Char_t*	GetDeviceStruct()
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
const Char_t*	GetHistoArrayName()
virtual const char*	TObject::GetIconName() const
TObjArray*	GetLofChannels()
const Char_t*	GetLofChannelsAsString(TString& LofChannels) const
TMrbLofNamedX*	GetLofRegisters()
TMrbNamedX*	GetMbsBranch()
Int_t	GetMbsBranchNo()
const Char_t*	GetMbsFctName(TString& FctName, TMrbConfig::EMrbModuleFunction Fct)
virtual const Char_t*	GetMnemonic() const
TMrbNamedX*	GetModuleID()
virtual const char*	TNamed::GetName() const
Int_t	GetNofChannels() const
Int_t	GetNofChannelsUsed() const
Int_t	GetNofDataBits() const
Int_t	GetNofShortsPerChannel() const
Int_t	GetNofShortsPerDatum() const
virtual Int_t	GetNofSubDevices() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
UInt_t	GetPatternOfChannelsUsed() const
const Char_t*	GetPosition() const
virtual const Char_t*	GetPrivateCodeFile() const
Int_t	GetRange()
Int_t	GetSerial() const
Int_t	GetSubDevice() const
Int_t	GetTimeOffset() const
virtual const char*	TNamed::GetTitle() const
TMrbNamedX*	GetType()
virtual UInt_t	TObject::GetUniqueID() const
Int_t	GetXmax()
Int_t	GetXmin()
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
Bool_t	HasBlockReadout() const
virtual ULong_t	TNamed::Hash() const
virtual Bool_t	HasPrivateCode() const
virtual Bool_t	HasRandomReadout() const
Bool_t	HasRegisters() const
void	Help()
Bool_t	HistoArrayToBeCreated()
Bool_t	HistosToBeAllocated() const
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
Bool_t	IsActive() const
Bool_t	IsAssignedToBranch()
Bool_t	IsCamac() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	IsRaw() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	IsVME() const
Bool_t	TObject::IsZombie() const
Bool_t	LoadCodeTemplates(const Char_t* TemplateFile)
virtual void	TNamed::ls(Option_t* option = "") const
virtual Bool_t	MakeAnalyzeCode(ofstream& AnaStrm, TMrbConfig::EMrbAnalyzeTag TagIndex, const Char_t* Extension)
virtual Bool_t	MakeRcFile(ofstream& RcStrm, TMrbConfig::EMrbRcFileTag TagIndex, const Char_t* ResourceName)
virtual Bool_t	MakeReadoutCode(ofstream& RdoStrm, TMrbConfig::EMrbModuleTag TagIndex)
virtual Bool_t	MakeReadoutCode(ofstream& RdoStrm, TMrbConfig::EMrbReadoutTag TagIndex, TMrbTemplate& Template, const Char_t* Prefix = 0)
virtual Bool_t	MakeReadoutCode(ofstream& RdoStrm, TMrbConfig::EMrbModuleTag TagIndex, TMrbModuleChannel* Channel, Int_t Value = 0)
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
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)
TNamed&	TNamed::operator=(const TNamed& rhs)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	Print() const
virtual void	Print(Option_t* Option) const
void	Print(ostream& OutStrm, const Char_t* Prefix = "") const
void	PrintRegister(const Char_t* RegName) const
void	PrintRegister(ostream& OutStrm, const Char_t* RegName, const Char_t* Prefix = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
Bool_t	Set(const Char_t* RegName, Int_t Value, Int_t Channel = -1)
Bool_t	Set(Int_t RegIndex, Int_t Value, Int_t Channel = -1)
Bool_t	Set(const Char_t* RegName, const Char_t* Value, Int_t Channel = -1)
Bool_t	Set(Int_t RegIndex, const Char_t* Value, Int_t Channel = -1)
void	SetActive(Bool_t ActiveFlag = kTRUE)
void	SetBinning(Int_t ChansPerBin = 1)
void	SetBinRange(Int_t BinRange)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
Bool_t	SetBlockReadout(Bool_t Flag = kTRUE)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
Bool_t	SetMbsBranch(TMrbNamedX* MbsBranch)
Bool_t	SetMbsBranch(Int_t MbsBranchNo, const Char_t* MbsBranchName = 0)
Bool_t	SetMbsFctName(const Char_t* FctName, TMrbConfig::EMrbModuleFunction Fct)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
void	SetTimeOffset(Int_t TimeOffset)
virtual void	TNamed::SetTitle(const char* title = "")MENU
void	SetType(UInt_t ModuleType, Bool_t OrFlag = kTRUE)
virtual void	TObject::SetUniqueID(UInt_t uid)
Bool_t	SetXmax(Int_t Xmax = 0)
Bool_t	SetXmin(Int_t Xmin = 0)
virtual void	ShowMembers(TMemberInspector&)
virtual Int_t	TNamed::Sizeof() const
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
Bool_t	ToBeExcludedFromReadout() 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:

virtual void	DefineRegisters()
void	DeleteRegisters()
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::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:

Bool_t	UtilitiesLoaded	kTRUE if some utility procedures already loaded
Int_t	fBinRange	number of bins
Bool_t	fBlockReadout	kTRUE if block readout;
TObjArray	fChannelSpec	channel specifications (type TMrbModuleChannel *)
Int_t	fChansPerBin	channels per bin
TMrbTemplate	fCodeTemplates	store template code
Int_t	fCrate	crate number
Bool_t	fCreateHistoArray	kTRUE if histo array / .histlist file is to be created
TMrbNamedX*	fDataType	data type
Bool_t	fExcludeFromReadout	kTRUE if to be EXcluded from readout
TString	fHistoArrayName	name of histo array / .histlist file
Bool_t	fHistosToBeAllocated	kTRUE if histograms to be allocated for each channel
Bool_t	fIsActive	kTRUE if module active
TObjArray	fLofMbsFctNames	define indiviual function names to be used with MBS
TMrbLofNamedX	fLofRegisters	list of registers
TMrbNamedX	fMbsBranch	branch within MBS
TMrbNamedX	fModuleID	module id
TMrbNamedX	fModuleType	module type
TString	TNamed::fName	object identifier
Int_t	fNofChannels	number of channels available
Int_t	fNofDataBits	length of data
Int_t	fNofShortsPerChannel	number of 16 bit words per channel
Int_t	fNofShortsPerDatum	number of 16 bit words per datum
TString	fPosition	crate & addr
Int_t	fRange	number of data points
Int_t	fSerial	unique serial number
Int_t	fSubDevice	subdevice
Int_t	fTimeOffset	time offset
TString	TNamed::fTitle	object title
Int_t	fXmax
Int_t	fXmin	xmin / xmax

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TMrbModule()

{}

TMrbModule(const Char_t* ModuleName, const Char_t* ModuleID, Int_t NofChannels, Int_t Range)

 explicit ctor:	name, id, nofchannels, range

~TMrbModule()

			fChannelSpec.Delete();

DeleteRegisters()

Bool_t Set(const Char_t* RegName, Int_t Value, Int_t Channel = -1)

Bool_t Set(Int_t RegIndex, Int_t Value, Int_t Channel = -1)

Int_t Get(const Char_t* RegName, Int_t Channel = -1) const

Int_t Get(Int_t RegIndex, Int_t Channel = -1) const

Bool_t Set(const Char_t* RegName, const Char_t* Value, Int_t Channel = -1)

Bool_t Set(Int_t RegIndex, const Char_t* Value, Int_t Channel = -1)

TMrbNamedX * FindRegister(const Char_t* RegName) const

TMrbNamedX * FindRegister(Int_t RegIndex) const

 find register by index

{ return(fLofRegisters.FindByIndex(RegIndex)); }

Bool_t HasRegisters() const

{ return(fLofRegisters.GetEntriesFast() > 0); }

Bool_t AllocateHistograms(Bool_t Flag = kTRUE)

{ fHistosToBeAllocated = Flag; return(kTRUE); }

Bool_t HistosToBeAllocated() const

{ return(fHistosToBeAllocated); }

Bool_t ConvertToInt() const

{ return(kTRUE); }

void SetActive(Bool_t ActiveFlag = kTRUE)

{ fIsActive = ActiveFlag; }

Bool_t IsActive() const

{ return(fIsActive); }

void ExcludeFromReadout(Bool_t ExcludeFlag = kTRUE)

{ fExcludeFromReadout = ExcludeFlag; }

Bool_t ToBeExcludedFromReadout() const

{ return(fExcludeFromReadout); }

Bool_t SetBlockReadout(Bool_t Flag = kTRUE)

Bool_t HasBlockReadout() const

{ return(fBlockReadout); }

TMrbLofNamedX * GetLofRegisters()

{ return(&fLofRegisters); }

Int_t GetRange()

{ return(fRange); }

TMrbNamedX * GetDataType() const

{ return(fDataType); }

void SetBinning(Int_t ChansPerBin = 1)

Int_t GetBinning() const

{ return(fChansPerBin); }

void SetBinRange(Int_t BinRange)

{ fBinRange = BinRange; }

Int_t GetBinRange() const

{ return(fBinRange); }

Bool_t SetXmin(Int_t Xmin = 0)

Bool_t SetXmax(Int_t Xmax = 0)

Int_t GetXmin()

{ return(fXmin); }

Int_t GetXmax()

{ return(fXmax); }

Int_t GetSubDevice() const

{ return(fSubDevice); }

void SetType(UInt_t ModuleType, Bool_t OrFlag = kTRUE)

TMrbNamedX * GetType()

{ return(&fModuleType); }

TMrbNamedX * GetModuleID()

{ return(&fModuleID); }

const Char_t * GetMnemonic() const

{ return("unknown"); }

const Char_t * GetPosition() const

{ return(fPosition.Data()); }

Int_t GetCrate() const

{ return(fCrate); }

Int_t GetSerial() const

{ return(fSerial); }

Bool_t SetMbsBranch(Int_t MbsBranchNo, const Char_t* MbsBranchName = 0)

Bool_t SetMbsBranch(TMrbNamedX* MbsBranch)

{ return(this->SetMbsBranch(MbsBranch->GetIndex(), MbsBranch->GetName())); }

TMrbNamedX * GetMbsBranch()

{ return(&fMbsBranch); }

Int_t GetMbsBranchNo()

{ return(fMbsBranch.GetIndex()); }

Bool_t IsAssignedToBranch()

{ return (fMbsBranch.GetIndex() != -1); }

void SetTimeOffset(Int_t TimeOffset)

{ fTimeOffset = TimeOffset; }

Int_t GetTimeOffset() const

{ return(fTimeOffset); }

Bool_t CheckID(TMrbConfig::EMrbModuleID ModuleID) const

{ return(fModuleID.GetIndex() == ModuleID); }

Int_t GetNofShortsPerChannel() const

{ return(fNofShortsPerChannel); }

Int_t GetNofShortsPerDatum() const

{ return(fNofShortsPerDatum); }

Int_t GetNofDataBits() const

{ return(fNofDataBits); }

Int_t GetNofChannels() const

{ return(fNofChannels); }

Int_t GetNofChannelsUsed() const

UInt_t GetPatternOfChannelsUsed() const

Bool_t CheckIfPatternIsContiguous() const

TObjArray * GetLofChannels()

{ return(&fChannelSpec); }

const Char_t * GetLofChannelsAsString(TString& LofChannels) const

TMrbModuleChannel * GetChannel(Int_t ) const

Bool_t LoadCodeTemplates(const Char_t* TemplateFile)

Bool_t MakeReadoutCode(ofstream& RdoStrm, TMrbConfig::EMrbReadoutTag TagIndex, TMrbTemplate& Template, const Char_t* Prefix = 0)

{ return(kFALSE); }

Bool_t MakeReadoutCode(ofstream& RdoStrm, TMrbConfig::EMrbModuleTag TagIndex)

{ return(kFALSE); }

Bool_t MakeReadoutCode(ofstream& RdoStrm, TMrbConfig::EMrbModuleTag TagIndex, TMrbModuleChannel* Channel, Int_t Value = 0)

{ return(kFALSE); }

Bool_t MakeAnalyzeCode(ofstream& AnaStrm, TMrbConfig::EMrbAnalyzeTag TagIndex, const Char_t* Extension)

Bool_t MakeRcFile(ofstream& RcStrm, TMrbConfig::EMrbRcFileTag TagIndex, const Char_t* ResourceName)

{ return(kFALSE); }

Bool_t IsCamac() const

{ return((fModuleType.GetIndex() & TMrbConfig::kModuleCamac) != 0); }

Bool_t IsVME() const

{ return((fModuleType.GetIndex() & TMrbConfig::kModuleVME) != 0); }

void PrintRegister(ostream& OutStrm, const Char_t* RegName, const Char_t* Prefix = "") const

void PrintRegister(const Char_t* RegName) const

{ PrintRegister(cout, RegName, ""); }

void Print(Option_t* Option) const

{ TObject::Print(Option); }

void Print(ostream& OutStrm, const Char_t* Prefix = "") const

{}

void Print() const

{ Print(cout, ""); }

Int_t GetNofSubDevices() const

{ return(1); }

Bool_t HasRandomReadout() const

{ return(kTRUE); }

Bool_t IsRaw() const

{ return(kFALSE); }

Bool_t CheckSubeventType(TMrbSubevent* Subevent) const

{ return(kTRUE); }

Bool_t CheckProcType()

{ return(kTRUE); }

Bool_t HasPrivateCode() const

{ return(kFALSE); }

const Char_t * GetPrivateCodeFile() const

{ return(NULL); }

const Char_t * GetCommonCodeFile()

{ return(NULL); }

void CreateHistoArray(const Char_t* ArrayName = 0)

Bool_t HistoArrayToBeCreated()

{ return(fCreateHistoArray); }

const Char_t * GetHistoArrayName()

{ return(fHistoArrayName.Data()); }

Char_t * GetDeviceStruct()

{ return(NULL); }

Bool_t SetMbsFctName(const Char_t* FctName, TMrbConfig::EMrbModuleFunction Fct)

const Char_t * GetMbsFctName(TString& FctName, TMrbConfig::EMrbModuleFunction Fct)

void Help()

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

void DefineRegisters()

{}