GanilRun Class Reference

#include <GanilRun.hh>

Inheritance diagram for GanilRun:

Public Member Functions
	GanilRun ()
virtual	~GanilRun ()
virtual int	Open ()
virtual int	Open (const string &f_name)
virtual int	Open (const u_int f_num)
virtual bool	IsOpen ()
virtual int	Close ()
virtual int	RunInit ()
virtual int	ReadEvent ()
virtual void	Reset ()
virtual void	BufferReset ()
virtual int	ReadHeaders ()
virtual int	ReadBuffer ()
void	SetOptionWarnEmptyBuffer (const bool b=true)
void	DumpGanilEvent (const bool all=false) const
void	DumpGanilEvent (const string &file_name, const bool all=false) const
void	DumpGanilEvent (ostream &os, const bool all=false) const
void	DumpUserEvent (const bool all=false) const
void	DumpUserEvent (const string &file_name, const bool all=false) const
void	DumpUserEvent (ostream &os, const bool all=false) const
virtual void	EndrunInfo (ostream &)
virtual void	StatInfo () const
virtual void	StatInfo (ostream &) const
u_int	GetScalerNumber () const
u_int	GetScalerAcqStatus () const
u_int	GetScalerLabel (const u_int n) const
u_int	GetScalerValue (const u_int n) const
u_int	GetScalerFreq (const u_int n) const
u_int	GetScalerTics (const u_int n) const
int	GetScalerStatus (const u_int n) const
u_int	GetRunNumber () const
u_int	GetEventNumber () const
u_int	GetBufferCount () const
u_int	GetTotalBufferCount () const
u_int	GetBufferStat (const u_int t) const
u_int	GetGanilParamNumber () const
u_int	GetUserParamNumber () const
bool	SetGanilParamMultihit (const string &par_name)
bool	SetGanilParamMultihit (const u_int par_num)
bool	SetGanilParamArray (const string &par_name, const int dim)
bool	SetGanilParamArray (const u_int par_num, const int dim)
bool	EndOfRun () const
bool	IsLSB () const
bool	IsMSB () const
int	AddParam (const Param &par)
template<class T >
const Data &	SetParam (const u_int num, const T &val)
template<class T >
const Data &	SetParam (const string &par_name, const T &val)
template<class T >
const Data &	SetParam (const u_int num, const u_int index, const T &val)
template<class T >
const Data &	SetParam (const string &par_name, const u_int index, const T &val)
	ClassDef (GanilRun, 0)
Public Member Functions inherited from RunBase
	RunBase ()
virtual	~RunBase ()
virtual int	Open (const u_int f_num, u_int f_sub=0)
virtual int	ClearEvent ()
virtual int	AnalyseEvent ()
virtual int	AnalyseEvents (const u_int n)
virtual int	Init ()
virtual void	Run ()
virtual void	FullReset ()
string	GetWorkDirectory () const
void	SetWorkDirectory (const string &wd)
virtual Int_t	GetTotalEventCount () const
virtual Int_t	GetEventCount () const
virtual Int_t	GetFileCount () const
virtual bool	IsRunInit () const
virtual bool	IsRunStarted () const
virtual bool	IsRunStopped () const
virtual void	SetFileMode (const Int_t mode)
virtual void	SetFileName (const string &f_name)
virtual void	SetFilePattern (const string &pattern)
virtual void	SetFilePatternLen (const u_int len)
virtual void	SetFileNumbers (const string &f_num)
virtual Int_t	SetFileListNames ()
virtual Int_t	GetFileMode () const
virtual string	GetFileName () const
virtual string	GetFilePattern () const
virtual Int_t	GetFilePatternLen () const
virtual string	GetFileNumbers () const
virtual Int_t	GetFileNumber () const
virtual Int_t	TapeRewind ()
virtual Int_t	TapeForward (const Int_t n=1)
virtual Int_t	TapeBackward (const Int_t n=1)
virtual int	UserEventDefine ()
virtual int	UserRunStart ()
virtual int	UserEvent ()
virtual int	UserUpdate ()
virtual int	UserRunStop ()
	ClassDef (RunBase, 0)
Public Member Functions inherited from EventManager
	EventManager ()
virtual	~EventManager ()
u_int	ParamNumber () const
u_int	SpecNumber () const
u_int	TreeNumber () const
u_int	ContourNumber () const
u_int	FilterNumber () const
const Event *	GetEventPtr () const
const TreeList *	GetTreeListPtr () const
const SpectrumList *	GetSpectrumListPtr () const
const FilterList *	GetFilterListPtr () const
const RContourList *	GetContourListPtr () const
Event *	GetEventPtr ()
TreeList *	GetTreeListPtr ()
SpectrumList *	GetSpectrumListPtr ()
FilterList *	GetFilterListPtr ()
RContourList *	GetContourListPtr ()
virtual const Param *	GetParamPtr (const u_int n) const
virtual const Param *	GetParamPtr (const string &par_name) const
virtual string	GetParamName (const u_int n) const
virtual int	GetParamIndex (const string &par_name) const
virtual int	GetParamDimension (const u_int n) const
virtual int	GetParamDimension (const string &par_name) const
virtual TreeInfo *	GetTreePtr (const u_int t_num) const
virtual TreeInfo *	GetTreePtr (const string &t_name) const
virtual int	GetTreeIndex (const string &t_name) const
virtual Spectrum *	GetSpectrumPtr (const u_int num) const
virtual Spectrum *	GetSpectrumPtr (const string &spec_name) const
virtual int	GetSpectrumIndex (const string &spec_name) const
virtual string	GetSpectrumName (const u_int spec_num) const
TH1 *	GetHistoPtr (const u_int num) const
TH1 *	GetHistoPtr (const string &spec_name) const
virtual RContour *	GetContourPtr (const string &cname) const
virtual RContour *	GetContourPtr (const u_int cnum) const
virtual int	GetContourIndex (const string &cname) const
virtual string	GetContourName (const u_int cnum) const
virtual Filter *	GetFilterPtr (const string &fname) const
virtual Filter *	GetFilterPtr (const u_int fnum) const
virtual int	GetFilterIndex (const string &fname) const
virtual string	GetFilterName (const u_int fnum) const
virtual int	AddParamSingle (const string &par_name, const Data &d=DataUI2(0))
virtual int	AddParamArray (const string &par_name, const u_int dim, const Data &d=DataUI2(0))
virtual int	AddParamMultihit (const string &par_name, const Data &d=DataUI2(0))
const Data &	GetParamDefaultValue (const u_int num)
const Data &	GetParamDefaultValue (const string &par_name)
bool	SetParamDefaultValue (const u_int num, const Data &d)
bool	SetParamDefaultValue (const string &par_name, const Data &d)
const Data &	GetParam (const u_int num)
const Data &	GetParam (const string &par_name)
const Data &	GetParam (const u_int num, const u_int index)
const Data &	GetParam (const string &par_name, const u_int index)
template<class T >
const Data &	SetParam (const u_int num, const T &val)
template<class T >
const Data &	SetParam (const string &par_name, const T &val)
template<class T >
const Data &	SetParam (const u_int num, const u_int index, const T &val)
template<class T >
const Data &	SetParam (const string &par_name, const u_int index, const T &val)
virtual int	AddTree (const string &t_name, const string &f_name="", const UInt_t n_max=0)
virtual int	InitTree (const string &t_name)
virtual int	InitTree (const int t_num=-1)
virtual bool	RemoveTree (const TreeInfo *t_ptr)
virtual bool	RemoveTree (const u_int t_num)
virtual bool	RemoveTree (const string &t_name)
virtual void	RemoveAllTrees ()
virtual Int_t	SetTreeFile (const int t_num, const string &f_name, const UInt_t n_max=0)
virtual string	GetTreeFile (const int t_num) const
virtual string	GetTreeFileName (const int t_num) const
virtual UInt_t	GetTreeFileMode (const int t_num) const
virtual Int_t	SetTreeFile (const string &t_name, const string &f_name, const UInt_t n_max=0)
virtual string	GetTreeFile (const string &t_name) const
virtual string	GetTreeFileName (const string &t_name) const
virtual UInt_t	GetTreeFileMode (const string &t_name) const
virtual Bool_t	AddTreeParam (const int t_num, const Param *p_ptr)
virtual Bool_t	AddTreeParam (const int t_num, const string &p_name)
virtual Bool_t	AddTreeParam (const int t_num, const Int_t p_num)
virtual Int_t	AddTreeParamRange (const int t_num, const Int_t p1, const Int_t p2)
virtual Int_t	AddTreeAllParam (const int t_num)
virtual Bool_t	AddTreeParam (const string &t_name, const Param *p_ptr)
virtual Bool_t	AddTreeParam (const string &t_name, const string &p_name)
virtual Bool_t	AddTreeParam (const string &t_name, const Int_t p_num)
virtual Int_t	AddTreeParamRange (const string &t_name, const Int_t p1, const Int_t p2)
virtual Int_t	AddTreeAllParam (const string &t_name)
virtual void	OpenTreeList (const Int_t m=-1) const
virtual void	CloseTreeList (const Int_t m=-1) const
virtual Bool_t	OpenTree (const int t_num) const
virtual Bool_t	OpenTree (const string &t_name) const
virtual Bool_t	CloseTree (const int t_num) const
virtual Bool_t	CloseTree (const string &t_name) const
virtual Bool_t	IsTreeOpen (const int t_num) const
virtual Bool_t	IsTreeOpen (const string &t_name) const
virtual Bool_t	IsTreeClosed (const int t_num) const
virtual Bool_t	IsTreeClosed (const string &t_name) const
bool	StartTree (const int t_num=-1) const
bool	StopTree (const int t_num=-1) const
bool	SuspendTree (const int t_num=-1) const
bool	StartTree (const string &t_name) const
bool	StopTree (const string &t_name) const
bool	SuspendTree (const string &t_name) const
virtual int	LoadTreeList (const string &filename, const bool append=true)
virtual int	SaveTreeList (const string &filename) const
int	AddSpecMono (const string &spec_name, const u_int par_num, const u_int nx, const double x1, const double x2, const string &family_name="")
int	AddSpecMono (const string &spec_name, const string &par_name, const u_int nx, const double x1, const double x2, const string &family_name="")
int	AddSpecBidim (const string &spec_name, const u_int par_num_x, const u_int nx, const double x1, const double x2, const u_int par_num_y, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecBidim (const string &spec_name, const string &par_name_x, const u_int nx, const double x1, const double x2, const string &par_name_y, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecTridim (const string &spec_name, const u_int par_num_x, const u_int nx, const double x1, const double x2, const u_int par_num_y, const u_int ny, const double y1, const double y2, const u_int par_num_z, const u_int nz, const double z1, const double z2, const string &family_name="")
int	AddSpecTridim (const string &spec_name, const string &par_name_x, const u_int nx, const double x1, const double x2, const string &par_name_y, const u_int ny, const double y1, const double y2, const string &par_name_z, const u_int nz, const double z1, const double z2, const string &family_name="")
int	AddSpecDistrib (const string &spec_name, const u_int par_num, const double x1, const double x2, const string &family_name="")
int	AddSpecDistrib (const string &spec_name, const string &par_name, const double x1, const double x2, const string &family_name="")
int	AddSpecTrace (const string &spec_name, const u_int par_num, const double x1, const double x2, const string &family_name="")
int	AddSpecTrace (const string &spec_name, const string &par_name, const double x1, const double x2, const string &family_name="")
int	AddSpecCumul (const string &spec_name, const u_int par_num_x, const double x1, const double x2, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecCumul (const string &spec_name, const string &par_name_x, const double x1, const double x2, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecHisto (TH1 &h, const string &family_name="")
int	AddSpecExtern (const string &h_name, const string &f_name, const string &s_name="", const string &family_name="")
int	AddSpecUser1D (const string &spec_name, const u_int nx, const double x1, const double x2, const string &family_name="")
int	AddSpecUser2D (const string &spec_name, const u_int nx, const double x1, const double x2, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecNorm (const string &spec_name, const string &oper_name, const double norm=1., const string &family_name="")
int	AddSpecSqrt (const string &spec_name, const string &oper_name, const double c0=1., const double c1=0., const string &family_name="")
int	AddSpecInv (const string &spec_name, const string &oper_name, const double c0=1., const double c1=0., const double c2=0., const string &family_name="")
int	AddSpecSum (const string &spec_name, const string &oper0_name, const string &oper1_name, const double c0=1., const double c1=1., const double c2=0., const string &family_name="")
int	AddSpecProd (const string &spec_name, const string &oper0_name, const string &oper1_name, const double c0=1., const double c1=1., const string &family_name="")
int	AddSpecDiv (const string &spec_name, const string &oper0_name, const string &oper1_name, const double c0=1., const double c1=1., const double c2=0., const string &family_name="")
int	AddSpecSumN (const string &spec_name, const Int_t oper_num, Spectrum **oper_tab, const string &family_name="")
int	AddSpecSumN (const string &spec_name, const string &oper_names, const string &family_name="")
int	AddSpecHSum (const string &spec_name, const string &src_name, const string &family_name="")
int	AddSpecHSum (const string &spec_name, const Int_t src_num, const string &family_name="")
int	AddSpecHSum (const string &spec_name, const TH1 *src_histo, const string &family_name="")
int	AddSpecHMean (const string &spec_name, const string &src_name, const string &family_name="")
int	AddSpecHMean (const string &spec_name, const Int_t src_num, const string &family_name="")
int	AddSpecHMean (const string &spec_name, const TH1 *src_histo, const string &family_name="")
int	AddSpecHCumul (const string &spec_name, const string &src_name, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecHCumul (const string &spec_name, const Int_t src_num, const u_int ny, const double y1, const double y2, const string &family_name="")
int	AddSpecHCumul (const string &spec_name, const TH1 *src_histo, const u_int ny, const double y1, const double y2, const string &family_name="")
virtual bool	User1DIncrement (const string &spec_name, const Double_t x, const Double_t incr=1.)
virtual bool	User1DSetValue (const string &spec_name, const Double_t x, const Double_t val)
virtual bool	User1DIncrement (const u_int spec_num, const Double_t x, const Double_t incr=1.)
virtual bool	User1DSetValue (const u_int spec_num, const Double_t x, const Double_t val)
virtual bool	User1DIncrement (const string &spec_name, const Int_t ix, const Double_t incr=1.)
virtual bool	User1DSetValue (const string &spec_name, const Int_t ix, const Double_t val)
virtual bool	User1DIncrement (const u_int spec_num, const Int_t ix, const Double_t incr=1.)
virtual bool	User1DSetValue (const u_int spec_num, const Int_t ix, const Double_t val)
virtual bool	User2DIncrement (const string &spec_name, const Double_t x, const Double_t y, const Double_t incr=1.)
virtual bool	User2DSetValue (const string &spec_name, const Double_t x, const Double_t y, const Double_t val)
virtual bool	User2DIncrement (const u_int spec_num, const Double_t x, const Double_t y, const Double_t incr=1.)
virtual bool	User2DSetValue (const u_int spec_num, const Double_t x, const Double_t y, const Double_t val)
virtual bool	User2DIncrement (const string &spec_name, const Int_t ix, const Int_t iy, const Double_t incr=1.)
virtual bool	User2DSetValue (const string &spec_name, const Int_t ix, const Int_t iy, const Double_t val)
virtual bool	User2DIncrement (const u_int spec_num, const Int_t ix, const Int_t iy, const Double_t incr=1.)
virtual bool	User2DSetValue (const u_int spec_num, const Int_t ix, const Int_t iy, const Double_t val)
virtual bool	RemoveSpectrum (const Spectrum *spec_ptr, const bool force=true)
virtual bool	RemoveSpectrum (const u_int spec_num, const bool force=true)
virtual bool	RemoveSpectrum (const string &spec_name, const bool force=true)
virtual void	RemoveAllSpectra (const bool force=false)
virtual bool	SetSpectrumSaveProtection (Spectrum *spec_ptr, const bool b=true)
virtual bool	SetSpectrumSaveProtection (const string &spec_name, const bool b=true)
virtual bool	SetSpectrumSaveProtection (const u_int spec_num, const bool b=true)
virtual bool	SetSpectrumDeleteProtection (Spectrum *spec_ptr, const bool b=true)
virtual bool	SetSpectrumDeleteProtection (const string &spec_name, const bool b=true)
virtual bool	SetSpectrumDeleteProtection (const u_int spec_num, const bool b=true)
virtual bool	RenameSpectrum (const u_int num, const string &name, const string &name_x="", const string &name_y="", const string &name_z="")
virtual bool	RenameSpectrum (const string &spec_name, const string &name, const string &name_x="", const string &name_y="", const string &name_z="")
bool	StartSpectrum (const int num=-1) const
bool	StopSpectrum (const int num=-1) const
bool	SuspendSpectrum (const int num=-1) const
bool	ResetSpectrum (const int num=-1) const
bool	StartSpectrum (const string &spec_name) const
bool	StopSpectrum (const string &spec_name) const
bool	SuspendSpectrum (const string &spec_name) const
bool	ResetSpectrum (const string &spec_name) const
virtual void	IncrementSpectra () const
bool	SetSpectrumFamily (const string &spec_name, const string &family_name)
bool	SetSpectrumFamily (const u_int spec_num, const string &family_name)
bool	ResetSpectrumFamily (const string &spec_name)
bool	ResetSpectrumFamily (const u_int spec_num)
bool	StartFamily (const string &family_name)
bool	StopFamily (const string &family_name)
bool	SuspendFamily (const string &family_name)
bool	ResetFamily (const string &family_name)
virtual void	DumpEvent (const bool all=false, const u_int pmin=0, const u_int pmax=0) const
virtual void	DumpEvent (const string &file_name, const bool all=false, const u_int pmin=0, const u_int pmax=0) const
virtual void	DumpEvent (ostream &os, const bool all=false, const u_int pmin=0, const u_int pmax=0) const
virtual void	PrintEvent () const
virtual void	PrintEvent (const string &file_name) const
virtual void	PrintEvent (ostream &os) const
virtual void	PrintSpecList () const
virtual void	PrintSpecList (const string &) const
virtual void	PrintSpecList (ostream &os) const
virtual void	PrintFamily (const string &family_name)
virtual void	PrintFamily (ostream &os, const string &family_name)
virtual void	PrintFamily (const string &file_name, const string &family_name)
virtual int	LoadSpectraList (const string &filename, const bool append=true)
virtual int	SaveSpectraList (const string &filename) const
virtual int	SaveSelectedSpectra (const string &filename) const
virtual int	SaveHistograms (const string &file_name) const
virtual int	SaveSelectedHistograms (const string &file_name) const
virtual int	SaveFamilyHistograms (const string &file_name, const string &family_name) const
virtual void	RejectEvent ()
virtual int	AddContour (const string &ct_name, RContourBase &ct)
virtual int	AddContour (RContour &ct)
virtual bool	RemoveContour (const string &ct_name, const bool force=true)
virtual bool	RemoveContour (const int ct_num, const bool force=true)
virtual bool	RemoveContour (const RContour *ct, const bool force=true)
virtual void	RemoveAllContours ()
virtual int	LoadContourList (const string &filename, const bool append=true)
virtual int	SaveContourList (const string &filename) const
virtual int	AddFilter (const string &f_name, FilterBase &f)
virtual int	AddFilter (Filter *f)
virtual bool	RemoveFilter (Filter *f, const bool force=true)
virtual bool	RemoveFilter (const string &f_name, const bool force=true)
virtual bool	RemoveFilter (const int f_num, const bool force=true)
virtual void	RemoveAllFilters ()
virtual int	AddFilterFalse (const char *f_name)
virtual int	AddFilterTrue (const char *f_name)
virtual int	AddFilterNot (const char *f_name, const char *fnot_name)
virtual int	AddFilterAnd (const char *f_name, const char *f1_name, const char *f2_name)
virtual int	AddFilterOr (const char *f_name, const char *f1_name, const char *f2_name)
virtual int	AddFilterXOr (const char *f_name, const char *f1_name, const char *f2_name)
virtual int	AddFilterMultiAnd (const char *f_name, const char *fl_names)
virtual int	AddFilterMultiOr (const char *f_name, const char *fl_names)
virtual int	AddFilterGate (const char *f_name, const char *p_name, const double pmin, const double pmax, const int mode=filterMultiParAnd)
virtual int	AddFilterContour (const char *f_name, const char *c_name, const char *x_name, const char *y_name, const bool inv=false, const int mode=filterMultiParAnd)
virtual int	AddFilterContour (const char *f_name, const char *c_name, const char *x_name, const bool inv=false, const int mode=filterMultiParAnd)
virtual int	LoadFilterList (const string &filename, const bool append=true)
virtual int	SaveFilterList (const string &filename) const
virtual bool	FilterSpectrum (const int sp_num, const string &f_name="")
virtual bool	FilterSpectrum (const string &sp_name, const string &f_name="")
virtual bool	FilterFamily (const string &family_name, const string &f_name="")
virtual bool	FilterTree (const int t_num, const string &f_name="")
virtual bool	FilterTree (const string &t_name, const string &f_name="")
virtual bool	CheckFilter (const string &f_name)
virtual bool	CheckFilter (const u_int f_num)
virtual bool	CheckFilter (const Filter *f)
	ClassDef (EventManager, 0)
Public Member Functions inherited from GanilInfo
	GanilInfo ()
	GanilInfo (const GanilInfo &)
virtual	~GanilInfo ()
	ClassDef (GanilInfo, 0)
Public Member Functions inherited from GanilFileInfo
	GanilFileInfo ()
	GanilFileInfo (const GanilFileInfo &)
virtual	~GanilFileInfo ()
GanilFileInfo &	operator= (const GanilFileInfo &)
bool	operator== (const GanilFileInfo &)
bool	operator!= (const GanilFileInfo &data)
void	FileInfo ()
void	FileInfo (ostream &)
	ClassDef (GanilFileInfo, 0)
Public Member Functions inherited from GanilEventInfo
	GanilEventInfo ()
	GanilEventInfo (const GanilEventInfo &)
virtual	~GanilEventInfo ()
GanilEventInfo &	operator= (const GanilEventInfo &)
bool	operator== (const GanilEventInfo &)
bool	operator!= (const GanilEventInfo &data)
void	EventInfo ()
void	EventInfo (ostream &)
	ClassDef (GanilEventInfo, 0)
Public Member Functions inherited from GanilCoderInfo
	GanilCoderInfo ()
	GanilCoderInfo (const GanilCoderInfo &)
virtual	~GanilCoderInfo ()
GanilCoderInfo &	operator= (const GanilCoderInfo &)
bool	operator== (const GanilCoderInfo &)
bool	operator!= (const GanilCoderInfo &data)
void	CoderInfo ()
void	CoderInfo (ostream &)
u_short	Number ()
u_short	TrigNum (const u_int b)
u_short	ParNum (const u_int b)
u_short	Trig (const u_int b, const u_int t)
u_short	Fix1 (const u_int b, const u_int t)
u_short	Fixn (const u_int b, const u_int t)
string	Coder (const u_int b)
void	Clear ()
	ClassDef (GanilCoderInfo, 0)
Public Member Functions inherited from GanilParamInfo
	GanilParamInfo ()
	GanilParamInfo (const GanilParamInfo &)
virtual	~GanilParamInfo ()
GanilParamInfo &	operator= (const GanilParamInfo &)
bool	operator== (const GanilParamInfo &)
bool	operator!= (const GanilParamInfo &data)
int	GetGanilParamNumber (const string &par_name)
GanilParam *	GetGanilParamPtr (const string &par_name)
GanilParam *	GetGanilParamPtr (const u_int par_num)
u_int	GetGanilParamMask (const string &par_name)
u_int	GetGanilParamMask (const u_int par_num)
bool	SetGanilParamMask (const string &par_name, const u_int m)
bool	SetGanilParamMask (const u_int par_num, const u_int m)
void	ParamInfo ()
void	ParamInfo (ostream &)
void	WriteParamList ()
void	WriteParamList (const string &)
void	WriteParamList (ostream &)
	ClassDef (GanilParamInfo, 0)
Public Member Functions inherited from GanilEndrunInfo
	GanilEndrunInfo ()
	GanilEndrunInfo (const GanilEndrunInfo &)
virtual	~GanilEndrunInfo ()
virtual void	EndrunInfo ()
	ClassDef (GanilEndrunInfo, 0)

Protected Member Functions
	GanilRun (const GanilRun &original)
virtual int	FileOpen ()
virtual void	FileClose ()
virtual int	CreateEvent ()
virtual int	UserBuffer ()
virtual int	UserScaler ()
Protected Member Functions inherited from RunBase
	RunBase (const RunBase &original)
virtual int	RunStart ()
virtual int	RunStop ()
virtual void	AnalysisStart ()
virtual void	AnalysisStop ()
virtual void	RunTape ()
virtual void	RunFile ()
virtual void	RunList ()
virtual void	IncrementEventCount ()
virtual void	IncrementFileCount ()
Protected Member Functions inherited from EventManager
	EventManager (const EventManager &)
Protected Member Functions inherited from GanilFileInfo
int	SetFileInfo (GanilBuffer &)
Protected Member Functions inherited from GanilEventInfo
int	SetEventInfo (GanilBuffer &)
Protected Member Functions inherited from GanilCoderInfo
int	SetCoderInfo (GanilBuffer &)
Protected Member Functions inherited from GanilParamInfo
int	SetParamInfo (GanilBuffer &buffer)
int	SetParamInfo (GanilBuffer &buffer, const GanilCoderInfo *coder)
Protected Member Functions inherited from GanilEndrunInfo
int	SetEndrunInfo (GanilBuffer &)
void	ClearEndrunInfo ()

Protected Attributes
u_int	status
	bits d'état de l'analyse
u_int	format
	format binaire
bool	opt_warn_empty_buffer
	alerte en cas de buffer vide
FILE *	file_ptr
	pointeur sur le fichier de runs
GanilBuffer	buffer_data
	données du buffer courant de fichier
u_int	buffer_count
	compteur des buffers
u_int	total_buffer_count
	compteur des buffers
GanilScaler	scaler_data
	information des buffers d'échelles
Protected Attributes inherited from RunBase
string	work_dir
	répertoire de base du programme
bool	run_init
	test si l'initialisation est effectuée
bool	run_started
	test si un run est en cours
Int_t	file_mode
	mode de sélection des fichiers
string	file_name
	nom effectif du fichier d'entrée
string	file_pattern
	format de recherche des fichiers runs par leur numéro
u_int	file_pattern_len
	longueur du format de numéro de run
string	file_numbers
	numéro des fichiers de runs
Int_t	file_num
	numéro du fichier traité
Int_t	file_sub_num
	numéro secondaire du fichier traité
GStringList	file_list
	liste des fichiers validant le format
bool	file_list_changed
	indique s'il faut redéterminer la liste de fichiers
Int_t	file_count
	nombre de fichiers lus
Int_t	event_count
	nombre d'événements lus dans le fichier
Int_t	total_event_count
	nombre d'événements lus total
Protected Attributes inherited from EventManager
Event	event
	Structure physique de l'événement.
TreeList	tree_list
	Liste des arbres de l'analyse.
SpectrumList	spec_list
	Liste des spectres de l'analyse.
FilterList	filter_list
	Liste des filtres de l'analyse.
Protected Attributes inherited from GanilFileInfo
string	norme
	Norme du fichier d'acquisition.
string	version
	Version de l'acquisition.
string	labo
	Laboratoire de l'acquisition.
string	machine
	Machine d'acquisition.
string	application
	Programme d'acquisition.
u_int	buffer_size
	Taille des buffers.
string	format
	Format de la machine.
string	date
	Date du fichier.
Protected Attributes inherited from GanilEventInfo
string	event_type
	Type d'événement (WORDC ou FFFF)
string	data_format
	Format des données
string	wc_format
	Format du compteur de mots.
string	date
	Date du run.
string	run_name
	Nom du run.
u_int	run_number
	Numéro du run.
string	struct_type
	Type de structure.
Protected Attributes inherited from GanilParamInfo
GListT< GanilParam >	param_list
	Liste des paramètres GANIL.
u_int	number_table [16384]
	Table de conversion label -> numéro de paramètre (mode EBYEDAT)
u_short	mask_table [16384]
	Table des masques binaires.

Private Types
enum	GanilFormat { fmtMSB = 0, fmtLSB = 1 }
	Format des données binaires.
enum	GanilStatus {   statusFileh = 0x00010000, statusEventh = 0x00020000, statusComment = 0x00040000, statusParam = 0x00080000,   statusEndrun = 0x00100000, statusHeader = 0x000F0000, statusEventCreated = 0x00200000, statusEndOfFile = 0x00400000 }
	Bits d'état des runs GANIL.

Private Member Functions
	GObject (GanilRun)

Friends
class	GanilBuffer

Additional Inherited Members
Public Attributes inherited from GanilCoderInfo
u_short	number
	Nombre de branches de codeurs.
u_short *	trignum
	Table des numéros de triggers des branches.
u_short *	parnum
	Table des nombres de paramètres par branche.
u_short **	trig
	Table des valeurs de trigger pour chaque branche.
u_short **	fix1
	Table du premier paramètre fixe pour chaque branche.
u_short **	fixn
	Table du nombre de paramètres fixes pour chaque branche.
string *	coder
	Table des noms de branches.

Detailed Description

C'est la classe principale pour l'analyse des runs de l'acquisition GANIL. Elle dérive des classes suivantes:

• GanilInfo, qui fournit les informations des buffers d'entête
• RunBase, classe de base des analyses

C'est une classe abstraite: elle doit être dérivée. Les fonctions utilisateur sont celles définies dans la classe de base RunBase.

Deux nouvelles fonctions utilisateurs sont définies.

• la fonction UserBuffer, qui est appelée à la lecture de chaque buffer de données.
• la fonction UserScaler, qui est appelée lorsqu'un buffer d'échelles a été lu.

Constructor & Destructor Documentation

GanilRun::GanilRun

(

)

Constructeur par défaut.

References BufferReset(), file_ptr, opt_warn_empty_buffer, and status.

GanilRun::~GanilRun ( )

virtual

Destructeur.

GanilRun::GanilRun ( const GanilRun &  original )

protected

Constructeur de recopie: il ne recopie pas...

Parameters

original

instance à recopier

Member Function Documentation

GanilRun::GObject ( GanilRun  )

private

Macro from GCpp library that defines the following functions:

• ClassName(): return the real class name of the object
• StaticClassName(): return the used class name of the object (that may be a base class of the real object).
• IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
• Clone(): return an allocated copy of the object.

int GanilRun::Open ( )

virtual

Fonction de base pour l'ouverture du fichier de run (dont le nom est dans le champ file_name). Si le fichier est ouvert, on procède à la lecture des buffers d'entête. Cette fonction est également appelée par RunInit(), et dans le cas où l'initialisation n'est pas faite, on la fait. Si tout se passe bien, la fonction RunStart de la classe RunBase est appelée.

Implements RunBase.

References buffer_count, RunBase::file_name, file_ptr, FileOpen(), GANIL_DEVICE_NOT_OPEN, GANIL_INIT_ERROR, ReadHeaders(), and status.

int GanilRun::Open ( const string &  f_name )

inlinevirtual

Surcharge de la fonction de la classe RunBase. La fonction ne fait qu'appeler celle de RunBase.

Parameters

f_name

nom du fichier

Reimplemented from RunBase.

References RunBase::Open().

int GanilRun::Open ( const u_int  f_num )

inlinevirtual

Surcharge de la fonction de la classe RunBase. La fonction ne fait qu'appeler celle de RunBase.

Parameters

f_num

numéro du fichier

References RunBase::Open().

bool GanilRun::IsOpen ( )

virtual

Test de l'ouverture d'un fichier.

Implements RunBase.

References file_ptr.

Referenced by ReadEvent(), and ReadHeaders().

int GanilRun::Close ( )

virtual

Fermeture d'un fichier de run.

Implements RunBase.

References file_ptr, FileClose(), GANIL_DEVICE_NOT_OPEN, GANIL_USER_ERROR, and RunBase::RunStop().

int GanilRun::RunInit ( )

virtual

Fonction d'initialisation de l'analyse. La fonction doit ouvrir un fichier pour aller lire les buffers d'entête, et créer la structure d'événement:

• préparation de la structure d'événement selon le type d'expérience
• appel à la fonction utilisateur d'extension de l'événement Le fichier ouvert est refermé.

Implements RunBase.

References RunBase::file_mode, RunBase::file_name, RunBase::file_numbers, RunBase::file_pattern, RunBase::Open(), Reset(), and RunBase::run_init.

int GanilRun::ReadEvent ( )

virtual

Fonction de lecture d'un événement: elle retourne 0 si l'événement est lu sans problème, -1 en cas de fin de fichier, et une autre valeur en cas de problème. Cette fonction boucle sur les buffers jusqu'à trouver un buffer d'événements.

Implements RunBase.

References buffer_data, RunBase::ClearEvent(), GanilBuffer::EndOfBuffer(), EventManager::event, GANIL_EMPTY_BUFFER, GANIL_END_OF_FILE, GANIL_EVENT_ERROR, GanilBuffer::GetId(), GanilBuffer::GetType(), IsOpen(), ReadBuffer(), GanilBuffer::ReadEvent(), RunBase::run_init, scaler_data, GanilEndrunInfo::SetEndrunInfo(), GanilScaler::SetScalers(), status, and UserScaler().

void GanilRun::Reset ( )

virtual

Remise à zéro de l'analyse: compteurs et spectres.

Reimplemented from RunBase.

Reimplemented in GuiGanilRun.

References BufferReset(), and RunBase::Reset().

Referenced by GuiGanilRun::Reset(), and RunInit().

void GanilRun::BufferReset ( )

virtual

Remise à zéro des statistiques. Cette méthode est appelée à chaque début de run (fichier).

References buffer_count, buffer_data, GanilEndrunInfo::ClearEndrunInfo(), GANIL_BUFFER_TYPE_NUMBER, GanilBuffer::stat, and total_buffer_count.

Referenced by GanilRun(), and Reset().

int GanilRun::ReadHeaders ( )

virtual

Fonction de lecture de l'ensemble des buffers d'entête. Les bits d'état concernant les buffers d'entête sont remis à zéro. Le bit d'initialisation n'est pas remis à zéro par cette méthode, mais il l'est à l'ouverture d'un nouveau fichier. La compatibilité des buffers d'entête avec des fichiers lus précédemment est vérifiée.

References buffer_data, GanilEndrunInfo::ClearEndrunInfo(), GanilFileInfo::format, format, GANIL_INIT_ERROR, GanilBufferId, GanilBuffer::GetType(), IsOpen(), GanilCoderInfo::number, GanilFileInfo::operator=(), GanilParamInfo::operator=(), GanilEventInfo::operator=(), GanilCoderInfo::operator=(), GanilParamInfo::param_list, GanilCoderInfo::parnum, ReadBuffer(), GanilCoderInfo::SetCoderInfo(), GanilEventInfo::SetEventInfo(), GanilFileInfo::SetFileInfo(), GanilParamInfo::SetParamInfo(), and status.

Referenced by Open().

int GanilRun::ReadBuffer ( )

virtual

Fonction de base de lecture d'un buffer.

References buffer_count, buffer_data, file_ptr, GanilBuffer::Read(), status, total_buffer_count, and UserBuffer().

Referenced by ReadEvent(), and ReadHeaders().

int GanilRun::FileOpen ( )

protectedvirtual

Fonction appelée par Open, qui initialise la structure si ce n'est pas fait (phase d'initialisation), sinon qui démarre un nouveau run (phase d'analyse).

References CreateEvent(), FileClose(), GANIL_INIT_ERROR, GANIL_USER_ERROR, RunBase::run_init, and RunBase::RunStart().

Referenced by Open().

void GanilRun::FileClose ( )

protectedvirtual

Fonction de base pour la fermeture d'un fichier de run.

References file_ptr.

Referenced by Close(), and FileOpen().

void GanilRun::SetOptionWarnEmptyBuffer ( const bool  b = true )

inline

Définit l'option d'affichage des alertes en cas de buffers d'événements vides.

Parameters

b	état de l'otion

References opt_warn_empty_buffer.

void GanilRun::DumpGanilEvent ( const bool  all = false ) const

inline

Ecriture des paramètres GANIL de l'événement courant sur la sortie standard: seuls les paramètres bruts de l'acquisition GANIL sont écris.

Parameters

all	indique s'il faut écrire tout l'événement, y compris les paramètres non affectés

References EventManager::DumpEvent(), and GetGanilParamNumber().

void GanilRun::DumpGanilEvent ( const string &  file_name, const bool  all = false  ) const

inline

Ecriture des paramètres GANIL de l'événement courant dans un fichier: seuls les paramètres bruts de l'acquisition GANIL sont écris.

Parameters

file_name	nom du fichier de sortie
all	indique s'il faut écrire tout l'événement, y compris les paramètres non affectés

References EventManager::DumpEvent(), and GetGanilParamNumber().

void GanilRun::DumpGanilEvent ( ostream &  os, const bool  all = false  ) const

inline

Ecriture des paramètres GANIL de l'événement courant dans un flux de sortie: seuls les paramètres bruts de l'acquisition GANIL sont écris.

Parameters

os	flux de sortie
all	indique s'il faut écrire tout l'événement, y compris les paramètres non affectés

References EventManager::DumpEvent(), and GetGanilParamNumber().

void GanilRun::DumpUserEvent ( const bool  all = false ) const

inline

Ecriture des paramètres utilisateurs de l'événement courant sur la sortie standard.

Parameters

all	indique s'il faut écrire tout l'événement, y compris les paramètres non affectés

References EventManager::DumpEvent(), GetGanilParamNumber(), and GanilParamInfo::param_list.

void GanilRun::DumpUserEvent ( const string &  file_name, const bool  all = false  ) const

inline

Ecriture des paramètres utilisateurs de l'événement courant dans un fichier.

Parameters

file_name	nom du fichier de sortie
all	indique s'il faut écrire tout l'événement, y compris les paramètres non affectés

References EventManager::DumpEvent(), GetGanilParamNumber(), and GanilParamInfo::param_list.

void GanilRun::DumpUserEvent ( ostream &  os, const bool  all = false  ) const

inline

Ecriture des paramètres utilisateurs de l'événement courant dans un flux de sortie.

Parameters

os	flux de sortie
all	indique s'il faut écrire tout l'événement, y compris les paramètres non affectés

References EventManager::DumpEvent(), GetGanilParamNumber(), and GanilParamInfo::param_list.

void GanilRun::EndrunInfo ( ostream &  os )

virtual

Ecriture des informations du buffer de fin de run sur flux de sortie.

Parameters

os	flux vers lequel son envoyées les informations

Reimplemented from GanilEndrunInfo.

References GanilEndrunInfo::EndrunInfo(), and status.

void GanilRun::StatInfo ( ) const

inlinevirtual

Ecriture des informations concernant la statistique du run sur la sortie standard.

void GanilRun::StatInfo ( ostream &  os ) const

virtual

Ecriture des informations concernant la statistique du run sur un flux de sortie.

Parameters

os	flux vers lequel son envoyées les informations

References buffer_data, GANIL_BUFFER_TYPE_NUMBER, GanilBufferId, and GanilBuffer::stat.

u_int GanilRun::GetScalerNumber ( ) const

inline

Retourne le nombre de voies d'échelles.

References GanilScaler::GetNumber(), and scaler_data.

u_int GanilRun::GetScalerAcqStatus ( ) const

inline

Retourne l'état de l'acquisition: 1 = marche, 0 = arrêt.

References GanilScaler::GetAcqStatus(), and scaler_data.

u_int GanilRun::GetScalerLabel ( const u_int  n ) const

inline

Retourne le label (numéro) d'une échelle, et 0xFFFFFFFF si elle n'est pas définie.

Parameters

n	numéro de l'échelle

References GanilScaler::GetLabel(), and scaler_data.

u_int GanilRun::GetScalerValue ( const u_int  n ) const

inline

Retourne la valeur d'une échelle, et 0xFFFFFFFF si elle n'est pas définie.

Parameters

n	numéro de l'échelle

References GanilScaler::GetValue(), and scaler_data.

u_int GanilRun::GetScalerFreq ( const u_int  n ) const

inline

Retourne la fréquence d'une échelle, et 0xFFFFFFFF si elle n'est pas définie.

Parameters

n	numéro de l'échelle

References GanilScaler::GetFreq(), and scaler_data.

u_int GanilRun::GetScalerTics ( const u_int  n ) const

inline

Retourne le délai (x10ms) d'une échelle, et 0xFFFFFFFF si elle n'est pas définie.

Parameters

n	numéro de l'échelle

References GanilScaler::GetTics(), and scaler_data.

int GanilRun::GetScalerStatus ( const u_int  n ) const

inline

Retourne l'état d'une échelle: 1 = marche, 0 = arrêt, -1 = offline, -2 = non définie.

Parameters

n	numéro de l'échelle

References GanilScaler::GetStatus(), and scaler_data.

u_int GanilRun::GetRunNumber ( ) const

inline

Retourne le numéro de run en cours.

References GanilEventInfo::run_number.

Referenced by GuiGanilRun::UpdateDisplay().

u_int GanilRun::GetEventNumber ( ) const

inline

Retourne le nombre d'événement lus (en fin de run).

References GanilEndrunInfo::event_number.

u_int GanilRun::GetBufferCount ( ) const

inline

Retourne le nombre de buffers lus dans le fichier en cours.

References buffer_count.

u_int GanilRun::GetTotalBufferCount ( ) const

inline

Retourne le nombre total de buffers lus.

References total_buffer_count.

u_int GanilRun::GetBufferStat ( const u_int  t ) const

inline

Retourne le nombre de buffers d'un type donné.

Parameters

t	type de buffers

References buffer_data, and GanilBuffer::GetBufferStat().

u_int GanilRun::GetGanilParamNumber ( ) const

inline

Retourne le nombre de paramètres GANIL (paramètres bruts) de la structure d'événement.

References GanilParamInfo::param_list.

Referenced by DumpGanilEvent(), and DumpUserEvent().

u_int GanilRun::GetUserParamNumber ( ) const

inline

Retourne le nombre de paramètres utilisateur de la structure d'événement.

References EventManager::event, and GanilParamInfo::param_list.

bool GanilRun::SetGanilParamMultihit

(

const string &

par_name

)

Modifie un paramètre pour en faire un paramètre de type ParamMultihit.

Parameters

par_name

nom du paramètre

References GanilParamInfo::param_list.

bool GanilRun::SetGanilParamMultihit

(

const u_int

par_num

)

Modifie un paramètre pour en faire un paramètre de type ParamMultihit.

Parameters

par_num

numéro du paramètre

References GanilParamInfo::param_list.

bool GanilRun::SetGanilParamArray	(	const string &	par_name,
		const int	dim
	)

Modifie un paramètre pour en faire un paramètre de type ParamArray.

Parameters

par_name	nom du paramètre
dim	dimension du tableau

References GanilParamInfo::param_list.

bool GanilRun::SetGanilParamArray	(	const u_int	par_num,
		const int	dim
	)

Modifie un paramètre pour en faire un paramètre de type ParamArray.

Parameters

par_num	numéro du paramètre
dim	dimension du tableau

References GanilParamInfo::param_list.

bool GanilRun::EndOfRun ( ) const

inline

Retourne vrai si la fin de run est atteinte.

References status.

bool GanilRun::IsLSB ( ) const

inline

Retourne vrai si le run est au format LSB.

References format.

Referenced by GanilBuffer::ExtractInt2(), GanilBuffer::ExtractInt4(), GanilBuffer::ExtractUInt2(), GanilBuffer::ExtractUInt4(), and GanilBuffer::SetEventDBInfo().

bool GanilRun::IsMSB ( ) const

inline

Retourne vrai si le run est au format MSB.

References format.

int GanilRun::AddParam ( const Param &  par )

virtual

Ajout d'un paramètre utilisateur à la structure de l'événement. L'ajout n'est autorisé que si l'événement brut a déjà été défini, donc si le run est initialisé (surcharge de EventManager). La fonction retourne le numéro du paramètre ajouté, ou -1 en cas d'erreur;

Parameters

par	instance du paramètre à ajouter (il est duppliqué)

Reimplemented from EventManager.

References EventManager::AddParam(), and status.

template<class T >

const Data & GanilRun::SetParam	(	const u_int	num,
		const T &	val
	)

Méthode patron qui sert à l'affectation d'un paramètre utilisateur à partir d'une valeur donnée par un type de base ou une instance de type Data. Dans le cas d'un paramètre de type ParamArray, c'est la donnée courante du tableau qui est affectée. Dans le cas d'un paramètre de type ParamMultihit, une nouvelle donnée est ajoutée en fin de liste. Le type en retour est une référence sur l'instance Data associée au paramètre (après affectation), avec le qualificatif const car la donnée en retour (par référence) ne doit pas être modifiée directement.

Parameters

num	numéro de paramètre
val	valeur à affecter (Data ou type de base)

References bad_data, EventManager::event, GanilParamInfo::param_list, and EventManager::SetParam().

Referenced by SetParam().

template<class T >

const Data & GanilRun::SetParam	(	const string &	par_name,
		const T &	val
	)

Méthode patron qui sert à l'affectation d'un paramètre utilisateur à partir d'une valeur donnée par un type de base ou une instance de type Data. Dans le cas d'un paramètre de type ParamArray, c'est la donnée courante du tableau qui est affectée. Dans le cas d'un paramètre de type ParamMultihit, une nouvelle donnée est ajoutée en fin de liste. Le type en retour est une référence sur l'instance Data associée au paramètre (après affectation), avec le qualificatif const car la donnée en retour (par référence) ne doit pas être modifiée directement.

Parameters

par_name	nom du paramètre
val	valeur à affecter (Data ou type de base)

References bad_data, EventManager::event, and SetParam().

template<class T >

const Data & GanilRun::SetParam	(	const u_int	num,
		const u_int	index,
		const T &	val
	)

Méthode patron qui sert à l'affectation d'un paramètre utilisateur à partir d'une valeur donnée par un type de base ou une instance de type Data. Le type en retour est une référence sur l'instance Data associée au paramètre (après affectation), avec le qualificatif const car la donnée en retour (par référence) ne doit pas être modifiée directement. Dans le cas d'un paramètre de type ParamMultihit, cette méthode ne doit être appelée que pour modifier une donnée déjà dans la liste. Pour ajouter une nouvelle donnée à la liste il faut appeler la méthode sans spécification d'index.

Parameters

num	numéro de paramètre
index	index de la valeur à affecter dans le paramètre
val	valeur à affecter (Data ou type de base)

References bad_data, EventManager::event, GanilParamInfo::param_list, and EventManager::SetParam().

template<class T >

const Data & GanilRun::SetParam	(	const string &	par_name,
		const u_int	index,
		const T &	val
	)

Méthode patron qui sert à l'affectation d'un paramètre utilisateur à partir d'une valeur donnée par un type de base ou une instance de type Data. Le type en retour est une référence sur l'instance Data associée au paramètre (après affectation), avec le qualificatif const car la donnée en retour (par référence) ne doit pas être modifiée directement. Dans le cas d'un paramètre de type ParamMultihit, cette méthode ne doit être appelée que pour modifier une donnée déjà dans la liste. Pour ajouter une nouvelle donnée à la liste il faut appeler la méthode sans spécification d'index.

Parameters

par_name	nom du paramètre
index	index de la valeur à affecter dans le paramètre
val	valeur à affecter (Data ou type de base)

References bad_data, EventManager::event, and SetParam().

int GanilRun::CreateEvent ( )

protectedvirtual

Création de la structure d'événement physique pour la saisie des données (appelée par RunInit()).

References Event::AddParam(), EventManager::event, GANIL_EVENT_ERROR, GanilParamInfo::param_list, and status.

Referenced by FileOpen().

int GanilRun::UserBuffer ( )

inlineprotectedvirtual

Fonction utilisateur par défaut appelée après la lecture d'un buffer. Cette fonction est appelée chaque fois qu'un buffer est lu, après l'initialisation.

Reimplemented in RGuiGanilRun.

Referenced by ReadBuffer().

int GanilRun::UserScaler ( )

inlineprotectedvirtual

Fonction utilisateur par défaut de traitement des buffers d'échelles.

Reimplemented in RGuiGanilRun.

Referenced by ReadEvent().

GanilRun::ClassDef	(	GanilRun	,
		0
	)

Définition à usage de ROOT...

---

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

• GanilRun.hh
• GanilRun.cpp