Class StRTSBaseMaker - is an abstract StMaker to define the interface to access the DAQ data from the STAR production chain. More...

#include <StRTSBaseMaker.h>

Inheritance diagram for StRTSBaseMaker:

Public Member Functions
	StRTSBaseMaker (const char detectorName, const char makerName="")
	StRTSBaseMaker( const char detectorName,TVirtualPad pad) ctor. More...

virtual	~StRTSBaseMaker ()
	StRTSBaseMaker class dtor.

Int_t	Sector () const

Int_t	Pad () const

Int_t	Rdo () const

Int_t	Row () const

UInt_t	Detectors () const
	detectors present bit mask according to DAQ!

const TString &	DetectorName () const

virtual Int_t	Make ()=0

virtual const char *	GetCVS () const

Public Member Functions inherited from StMaker
	StMaker (const char name="", const char dummy=0)
	Constructor & Destructor.

virtual Int_t	IsChain () const

virtual void	Clear (Option_t *option="")
	User defined functions.

virtual Int_t	InitRun (Int_t runumber)

virtual Int_t	Init ()

virtual void	StartMaker ()

virtual Int_t	IMake (Int_t number)

virtual void	EndMaker (Int_t ierr)

virtual Int_t	Finish ()

virtual Int_t	FinishRun (Int_t oldrunumber)

virtual void	FatalErr (Int_t Ierr, const char *Com)

virtual void	PrintInfo ()

virtual void	NotifyMe (const char , const void )

virtual void	AddMaker (StMaker *mk)

virtual void	MakeDoc (const TString &, const TString &, Bool_t)

virtual void	AddData (TDataSet data, const char dir=".data")
	User methods.

virtual TDataSet *	AddObj (TObject obj, const char dir, int owner=1)

virtual TDataSet *	ToWhiteBoard (const char name, void dat)

virtual TDataSet *	ToWhiteBoard (const char name, void dat, void *del)

virtual TDataSet *	ToWhiteBoard (const char name, TObject dat, Int_t owner)

virtual TDataSet *	ToWhiteConst (const char name, TObject dat)

virtual TDataSet *	ToWhiteConst (const char name, void dat)

virtual TDataSet *	WhiteBoard (const char name, void v=0) const

virtual Int_t	Skip (Int_t nskip)

virtual void	AddConst (TDataSet *data=0)

virtual void	AddHist (TH1 h, const char dir=0)

virtual void	AddGarb (TDataSet *data=0)

virtual void	AddRunco (TDataSet *data=0)

virtual void	AddRunco (Double_t par, const char name, const char comment)

void	AddRunCont (TDataSet *data=0)

virtual TList *	GetHistList () const

virtual TH1 *	GetHist (const char *histName) const

virtual StMaker *	cd ()

virtual StMaker *	Cd ()

virtual Int_t	GetNumber () const
	STAR methods.

virtual void	SetNumber (Int_t number)

virtual StMaker *	GetParentChain () const

virtual Int_t	GetIventNumber () const
	Returns the current event number.

virtual void	SetIventNumber (Int_t iv)

virtual Int_t	GetEventNumber () const

virtual Int_t	GetRunNumber () const
	Returns the current RunNumber.

virtual const TDatime &	GetDateTime () const

virtual const TDatime &	GetDBTime () const

virtual void	SetDateTime (Int_t idat, Int_t itim)

virtual StEvtHddr *	GetEvtHddr () const

virtual Int_t	GetDate () const

virtual Int_t	GetTime () const

virtual const char *	GetEventType () const

virtual TDataSet *	GetData (const char name, const char dir=".data") const

virtual TDataSet *	GetData () const

virtual TDataSet *	GetConst () const

virtual TDataSet *	GetDataSet (const char *logInput) const

virtual TDataSet *	DataSet (const char *logInput) const

virtual TDataSet *	GetInputDS (const char *logInput) const

virtual TDataSet *	GetDataBase (const char logInput, const TDatime td=0)

virtual TDataSet *	GetInputDB (const char *logInput)

virtual Int_t	GetDebug () const

virtual Int_t	Debug () const

virtual Int_t	GetMakeReturn () const

virtual TList *	Histograms () const

virtual TString	GetAlias (const char log, const char dir=".aliases") const

virtual TString	GetInput (const char *log) const

virtual TString	GetOutput (const char *log) const

virtual TList *	GetMakeList () const

virtual StMaker *	GetParentMaker () const

virtual StMaker *	GetMaker (const char *mkname)

virtual StMaker *	GetMakerInheritsFrom (const char *mktype) const

virtual Bool_t	IsActive ()

virtual StMaker *	Maker (const char *mkname)

virtual void	SetBIT (EMakerStatus k)
	Maker Status Bits.

virtual void	ResetBIT (EMakerStatus k)

virtual Bool_t	TestBIT (EMakerStatus k)

virtual void	SetActive (Bool_t k=kTRUE)
	Setters for flags and switches.

virtual void	SetDebug (Int_t l=1)

virtual void	SetDEBUG (Int_t l=1)

virtual void	SetFlavor (const char flav, const char tabname)

virtual void	SetMakeReturn (Int_t ret)

virtual void	SetAlias (const char log, const char act, const char *dir=".aliases")

virtual void	AddAlias (const char log, const char act, const char *dir=".aliases")

virtual void	SetInput (const char log, const char act)

virtual void	SetOutput (const char log, const char act)

virtual void	SetOutput (const char log, TDataSet ds)

virtual void	SetOutput (TDataSet *ds)

virtual void	SetOutputAll (TDataSet *ds, Int_t level=1)

virtual void	SetMode (Int_t mode=0)

virtual void	SetNotify (const char about, StMaker mk)

virtual Int_t	GetMode ()

virtual Int_t	GetDebug ()

virtual const StChainOpt *	GetChainOpt () const

virtual TFile *	GetTFile () const

virtual void	NotifyEm (const char about, const void ptr)

virtual Double_t	RealTime ()

virtual Double_t	CpuTime ()

virtual void	StartTimer (Bool_t reset=kFALSE)

virtual void	StopTimer ()

virtual void	PrintTimer (Option_t *option="")

virtual void	PrintTotalTime ()

virtual const char *	GetName () const
	special overload

TObject *	GetDirObj (const char *dir) const

void	SetDirObj (TObject obj, const char dir)

Int_t	SetAttr (const char key, const char val, const char *to=".")

Int_t	SetAttr (const char key, Int_t val, const char to=".")

Int_t	SetAttr (const char key, UInt_t val, const char to=".")

Int_t	SetAttr (const char key, Double_t val, const char to=".")

Int_t	SetAttr (const StMaker *mk)

Int_t	RemAttr (const char key, const char to=".")

const TAttr *	GetAttr () const

Int_t	IAttr (const char *key) const

UInt_t	UAttr (const char *key) const

Double_t	DAttr (const char *key) const

const char *	SAttr (const char *key) const

void	PrintAttr () const

Public Member Functions inherited from TDataSet
	TDataSet (const char name="", TDataSet parent=0, Bool_t arrayFlag=kFALSE)

	TDataSet (const TDataSet &src, EDataSetPass iopt=kAll)

	TDataSet (TNode &src)
	This copy ctor has been depricated (left for thwe sake of the backweard compatibility)

virtual	~TDataSet ()
	std::cout << "Default destructor for " << GetName() << " - " << GetTitle() << std::endl;

virtual void	Add (TDataSet *dataset)

virtual void	AddAt (TDataSet *dataset, Int_t idx=0)

virtual void	AddAtAndExpand (TDataSet *dataset, Int_t idx=0)

virtual void	AddFirst (TDataSet *dataset)
	Add TDataSet object at the beginning of the dataset list of this dataset.

virtual void	AddLast (TDataSet *dataset)
	Add TDataSet object at the end of the dataset list of this dataset.

TDataSet *	At (Int_t idx) const

virtual void	Browse (TBrowser *b)
	Browse this dataset (called by TBrowser).

virtual TObject *	Clone (const char *newname="") const
	the custom implementation fo the TObject::Clone

virtual void	Delete (Option_t *opt="")

virtual TDataSet *	Find (const char *path) const

virtual TDataSet *	FindByName (const char name, const char path="", Option_t *opt="") const

virtual TDataSet *	FindByPath (const char *path) const
	Aliase for TDataSet::Find(const Char_t *path) method.

virtual TDataSet *	FindByTitle (const char title, const char path="", Option_t *opt="") const

TObject *	FindObject (const char *name) const

TObject *	FindObject (const TObject *o) const

virtual TDataSet *	First () const
	Return the first object in the list. Returns 0 when list is empty.

TObjArray *	GetObjArray () const

virtual TSeqCollection *	GetCollection () const

TList *	GetList () const

virtual Int_t	GetListSize () const

TObject *	GetMother () const

virtual TObject *	GetObject () const
	The depricated method (left here for the sake of the backward compatibility)

virtual TDataSet *	GetParent () const

virtual Long_t	HasData () const

virtual TDataSet *	Instance () const

virtual TString	Path () const
	return the full path of this data set

virtual EDataSetPass	Pass (EDataSetPass(callback)(TDataSet ), Int_t depth=0)

virtual EDataSetPass	Pass (EDataSetPass(callback)(TDataSet , void ), void user, Int_t depth=0)

virtual void	PrintContents (Option_t *opt="") const

virtual Int_t	Purge (Option_t *opt="")

virtual void	Remove (TDataSet *set)
	Remiove the "set" from this TDataSet.

virtual TDataSet *	RemoveAt (Int_t idx)

virtual void	SetMother (TDataSet *parent=0)

virtual void	SetObject (TObject *obj)
	The depricated method (left here for the sake of the backward compatibility)

virtual void	SetParent (TDataSet *parent=0)

virtual void	SetWrite ()

virtual void	Shunt (TDataSet *newParent=0)

virtual void	Sort ()
	Sort recursively all members of the TDataSet with TList::Sort method.

virtual Bool_t	IsEmpty () const
	return kTRUE if the "internal" collection has no member

virtual Bool_t	IsFolder () const

virtual Bool_t	IsMarked () const

virtual Bool_t	IsThisDir (const char *dirname, int len=-1, int ignorecase=0) const

virtual TDataSet *	Last () const
	Return the last object in the list. Returns 0 when list is empty.

virtual void	ls (Option_t *option="") const

virtual void	ls (Int_t depth) const

void	Mark ()

void	UnMark ()

void	MarkAll ()
	Mark all members of this dataset.

void	UnMarkAll ()
	UnMark all members of this dataset.

void	InvertAllMarks ()
	Invert mark bit for all members of this dataset.

void	Mark (UInt_t flag, EBitOpt reset=kSet)

virtual TDataSet *	Next () const

virtual TDataSet *	Prev () const

virtual void	Update ()

virtual void	Update (TDataSet *set, UInt_t opt=0)

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const

Static Public Member Functions
static UInt_t	Token ()
	current token

static UInt_t	Trgcmd ()
	current trigger command

static UInt_t	Daqcmd ()
	current DAQ command

static UInt_t	Trgword ()
	the Trigger Word

static UInt_t	Phyword ()
	the Physics Word

static UInt_t	Daqbits ()
	"offline" bits aka L3 summary...

static UInt_t	Daqbits_l1 ()
	triggers satisfying l1

static UInt_t	Daqbits_l2 ()
	triggers satisfying l2

static UInt_t	Evpgroups ()
	evp groups aka L3 summary[2]

Static Public Member Functions inherited from StMaker
static StMaker *	New (const char classname, const char name="", void *title=0)

static StMaker *	GetTopChain ()

static StMaker *	GetChain ()

static StMaker *	GetFailedMaker ()

static StMaker *	GetMaker (const TDataSet *ds)
	Static functions.

static EDataSetPass	ClearDS (TDataSet ds, void user)

static const char *	RetCodeAsString (Int_t kode)

static Int_t	AliasDate (const char *alias)

static Int_t	AliasTime (const char *alias)

static const char *	AliasGeometry (const char *alias)

static const DbAlias_t *	GetDbAliases ()

static void	SetTestMaker (StTestMaker *mk)

static Int_t	Cleanup (TDataSet *&ds)

static void	lsMakers (const StMaker *top)

Static Public Member Functions inherited from TDataSet
static TDataSet *	GetMainSet ()
	return pointer to the main dataset

static TDataSet *	instance ()

Protected Member Functions
StRtsTable *	GetNextDaqElement (const char *elementPath)
	Query the STAR production chain for the DAQ data. More...

StRtsTable *	DaqDta ()
	Return the current DAQ data block. This member function is provided for convenience. More...

StRtsTable *	GetNext (const char *bank)
	This is an overloaded member function, provided for convenience. More...

virtual StRtsTable *	GetNextRaw ()
	This is an overloaded member function, provided for convenience. More...

virtual StRtsTable *	GetNextRaw (int sec)
	This is an overloaded member function, provided for convenience. More...

virtual StRtsTable *	GetNextAdc ()
	This is an overloaded member function, provided for convenience. More...

virtual StRtsTable *	GetNextAdc (int sec)
	This is an overloaded member function, provided for convenience. More...

virtual StRtsTable *	GetNextLegacy ()
	This is an overloaded member function, provided for convenience. More...

virtual StRtsTable *	GetNextLegacy (int sec)
	This is an overloaded member function, provided for convenience. More...

Protected Member Functions inherited from StMaker
StMessMgr *	GetLogger () const

virtual TDataSet *	FindDataSet (const char logInput, const StMaker uppMk=0, const StMaker *dowMk=0) const

Protected Member Functions inherited from TDataSet
virtual void	SetMother (TObject *mother)

	TDataSet (const char name, const char title)

void	AddMain (TDataSet *set)
	add data set to main data set

TDataSet *	GetRealParent ()
	return real parent

void	MakeCollection ()
	Create the internal container at once if any.

Additional Inherited Members
Public Types inherited from StMaker
enum	EDebugLevel { kNormal, kDebug }

enum	{ kSTAFCV_BAD, kSTAFCV_OK, kSTAFCV_ERR =2, kSTAFCV_FATAL =3 }

enum	EMakerStatus { kInitBeg = 1, kInitEnd = 2, kMakeBeg = 3, kCleaBeg = 4, kFiniBeg = 5, kFiniEnd = 6, kActive = 7 }

Public Types inherited from TDataSet
enum	EDataSetPass { kContinue, kPrune, kStop, kUp, kStruct, kAll, kRefs, kMarked }

enum	ESetBits { kMark = BIT(22), kArray = BIT(20) }

enum	EBitOpt { kSet = kTRUE, kReset = kFALSE }

Public Attributes inherited from StMaker
enum StMaker:: { ... }	EModule_return_Status

Static Protected Member Functions inherited from TDataSet
static EDataSetPass	SortIt (TDataSet *ds)

static EDataSetPass	SortIt (TDataSet ds, void user)

Protected Attributes inherited from StMaker
TDataSet *	m_DataSet

TDataSet *	m_ConstSet

TDataSet *	m_GarbSet

TDataSet *	m_Inputs

TDataSet *	m_Ouputs
	list of logInput:ActualInput

TDataSet *	m_Runco
	list of logOuput:ActualOuput

TList *	m_Histograms
	Run Control parameters.

Int_t	fTallyMaker [kStFatal+1]
	counters

Int_t	m_Mode
	counters

Int_t	m_Number
	Integer mode of maker.

Int_t	m_LastRun
	Serial event number.

Int_t	m_DebugLevel
	Last Run number.

Int_t	m_MakeReturn
	Debug level.

TStopwatch	m_Timer
	Make() return flag.

StMemStat *	fMemStatMake
	Timer object.

StMemStat *	fMemStatClear
	StMemStat for Make.

Int_t	fStatus
	StMemStat for Clear.

StMessMgr *	fLogger
	Maker status.

StTurnLogger *	fLoggerHold

Protected Attributes inherited from TDataSet
TDataSet *	fParent

TSeqCollection *	fList

Static Protected Attributes inherited from StMaker
static StMaker *	fgTopChain = 0
	list of Histograms

static StMaker *	fgStChain = 0
	pointer to top StChain

static StMaker *	fgFailedMaker = 0
	current pointer to StChain

static StTestMaker *	fgTestMaker = 0
	current pointer to failed maker

static Int_t	fgTallyMaker [kStFatal+1] = {0,0,0,0,0}

Static Protected Attributes inherited from TDataSet
static TDataSet *	fgMainSet = &mainSet

Detailed Description

Class StRTSBaseMaker - is an abstract StMaker to define the interface to access the DAQ data from the STAR production chain.

Author: Valery Fine(fine@.nosp@m.bnl..nosp@m.gov)

Date: 27/04/2008

See Also: StRtsReaderMaker.h

Class provides the interface and the default implementation to access the DAQ data defined by "A DAQ_READER Cookbook". The user has to subclass it to re-implement the pure virtual function StRTSBaseMaker::Make() StRTSBaseMaker is a base class to implement the concrete StMaker::Make() method accessing and parsing the concrete detector subsystem DAQ information and make it available and suitable for the offline production.

See Also: "Virtual function"; "A DAQ_READER Cookbook"

Definition at line 35 of file StRTSBaseMaker.h.

Constructor & Destructor Documentation

StRTSBaseMaker::StRTSBaseMaker	(	const char *	detectorName,
		const char *	makerName = `""`
	)

StRTSBaseMaker( const char *detectorName,TVirtualPad *pad) ctor.

Parameters

detectorName	- the DAQ name of the detector as defined by the column detector FROM THE "Table 1" of the "A DAQ_READER Cookbook"
makerName	- The object name. It is adviced to provide each object instance with its own name

Definition at line 89 of file StRTSBaseMaker.cxx.

Member Function Documentation

StRtsTable* StRTSBaseMaker::DaqDta ( )

inlineprotected

Return the current DAQ data block. This member function is provided for convenience.

One of the suitable method such as GetNextRaw, GetNextAdc, GetNextLegacy, GetNext, has to be called first to assign this pointer

Definition at line 50 of file StRTSBaseMaker.h.

Referenced by StTofHitMaker::GetNextRaw(), StBTofHitMaker::GetNextRaw(), StMtdHitMaker::GetNextRaw(), StDAQMaker::Make(), and StTpcHitMaker::Make().

StRtsTable * StRTSBaseMaker::GetNext ( const char * bank )

protected

This is an overloaded member function, provided for convenience.

Parameters

bank	- the name of the bank. The format is `bank`[d], where `bank` is the name of the bank as defined by the "DAQ_READER bank name" column from the "A DAQ_READER Cookbook" Table 1. [d] - is an optional component which is a comma separated list of the indexis surrounding by the square brackets.

Returns: the DAQ data for the bank "bank" if exists

See Also: "A DAQ_READER Cookbook"

Definition at line 153 of file StRTSBaseMaker.cxx.

References GetNextDaqElement().

Referenced by GetNextAdc(), GetNextLegacy(), GetNextRaw(), and StFttRawHitMaker::Make().

StRtsTable * StRTSBaseMaker::GetNextAdc ( )

protectedvirtual

This is an overloaded member function, provided for convenience.

Returns: the DAQ data for the bank "adc" if exists

See Also: "A DAQ_READER Cookbook"

Definition at line 209 of file StRTSBaseMaker.cxx.

References GetNext().

StRtsTable * StRTSBaseMaker::GetNextAdc ( int sec )

protectedvirtual

This is an overloaded member function, provided for convenience.

Returns: the DAQ data for the bank "adc" from sector sec if exists

See Also: "A DAQ_READER Cookbook"

Definition at line 224 of file StRTSBaseMaker.cxx.

References GetNext().

StRtsTable * StRTSBaseMaker::GetNextDaqElement ( const char * elementPath )

protected

Query the STAR production chain for the DAQ data.

Use the syntax defined by A DAQ_READER Cookbook" to query the DAQ data for the current event. It generates the text query using the format RTS/detector/bank[d]
where

"RTS" is a text constant
detector is the name of the detector defined by the class ctor
See Also
StRTSBaseMaker::StRTSBaseMaker
bank is the name of the bank as defined by the "DAQ_READER bank name" column from the "A DAQ_READER Cookbook" "Table 1"
See Also
A DAQ_READER Cookbook"
[d] - is an optional component which is a comma separated list of the indexis surrounding by the square brackets.

For example the text "RTS/tpx/cld[1]" is to query the DAQ cluster data for the first sector of TPX detector

Returns: the pointer the StRtsTable object filled with the query data
=0; no data for the "elementPath" was found

Note: the methgod is designed to be called from the StMaker::Make implementation indirectly. Normally one does not need to invoke this method from the end-user code.

Definition at line 126 of file StRTSBaseMaker.cxx.

Referenced by StFgtRawMaker::fillHits(), GetNext(), StFcsRawHitMaker::Make(), StFpsRawHitMaker::Make(), StIstRawHitMaker::Make(), StPxlRawHitMaker::Make(), StSstDaqMaker::Make(), and StTpcHitMaker::Make().

StRtsTable * StRTSBaseMaker::GetNextLegacy ( )

protectedvirtual

This is an overloaded member function, provided for convenience.

Returns: the DAQ data for the bank "legacy" if exists

See Also: "A DAQ_READER Cookbook"

Definition at line 240 of file StRTSBaseMaker.cxx.

References GetNext().

Referenced by StTofHitMaker::GetNextRaw(), StBTofHitMaker::GetNextRaw(), StMtdHitMaker::GetNextRaw(), and StDAQMaker::Make().

StRtsTable * StRTSBaseMaker::GetNextLegacy ( int sec )

protectedvirtual

This is an overloaded member function, provided for convenience.

Returns: the DAQ data for the bank "legacy" from sector sec if exists

See Also: "A DAQ_READER Cookbook"

Definition at line 256 of file StRTSBaseMaker.cxx.

References GetNext().

StRtsTable * StRTSBaseMaker::GetNextRaw ( )

protectedvirtual

This is an overloaded member function, provided for convenience.

Returns: the DAQ data for the bank "raw" if exists

See Also: "A DAQ_READER Cookbook"

Reimplemented in StMtdHitMaker, StBTofHitMaker, and StTofHitMaker.

Definition at line 177 of file StRTSBaseMaker.cxx.

References GetNext().

Referenced by StTriggerDataMaker::Make(), StRHICfRawHitMaker::Make(), and StETofDigiMaker::Make().

StRtsTable * StRTSBaseMaker::GetNextRaw ( int sec )

protectedvirtual

This is an overloaded member function, provided for convenience.

Returns: the DAQ data for the bank "raw" from sector sec if exists

See Also: "A DAQ_READER Cookbook"

Reimplemented in StMtdHitMaker, and StBTofHitMaker.

Definition at line 193 of file StRTSBaseMaker.cxx.

References GetNext().

virtual Int_t StRTSBaseMaker::Make ( )

pure virtual

One has to implement this method to access the concrete detector subsystem DAQ information via the suitable method such as GetNextRaw, GetNextAdc, GetNextLegacy, GetNext, parse it and make it available for the STAR production chain

Reimplemented from StMaker.

Implemented in StMtdHitMaker, StMuDstMaker, StTpcHitMaker, St_pp2pp_Maker, StSstDaqMaker, StBTofHitMaker, StHltMaker, StEmcRawMaker, StTofHitMaker, StFgtRawMaker, StETofDigiMaker, StTreeMaker, StPxlRawHitMaker, StMuIOMaker, StFstRawHitMaker, StIstRawHitMaker, StFttRawHitMaker, StDAQMaker, StRHICfRawHitMaker, StFpsRawHitMaker, StIOInterFace, StFcsRawHitMaker, StIOMaker, and StTriggerDataMaker.

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

StChain/StRTSBaseMaker.h
StChain/StRTSBaseMaker.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation