TGo4AnalysisStatus Class Reference

Status of the analysis instance. More...

#include <TGo4AnalysisStatus.h>

Inheritance diagram for TGo4AnalysisStatus:

List of all members.


Public Member Functions
	TGo4AnalysisStatus ()
	default ctor for streamer.
	TGo4AnalysisStatus (const char *name)
virtual	~TGo4AnalysisStatus ()
void	SetStepChecking (Int_t on)
Int_t	IsStepChecking () const
void	SetFirstStepIndex (Int_t i)
Int_t	GetFirstStepIndex () const
void	SetLastStepIndex (Int_t i)
Int_t	GetLastStepIndex () const
void	SetAutoSaveInterval (Int_t i)
Int_t	GetAutoSaveInterval () const
void	SetAutoSaveCompression (Int_t i=5)
Int_t	GetAutoSaveCompression () const
void	SetAutoSaveOverwrite (Bool_t over=kTRUE)
Int_t	IsAutoSaveOverwrite () const
void	SetAutoFileName (const char *name)
const char *	GetAutoFileName () const
void	SetConfigFileName (const char *name)
const char *	GetConfigFileName () const
void	SetAutoSaveOn (Bool_t on=kTRUE)
Int_t	IsAutoSaveOn () const
TGo4AnalysisStepStatus *	GetStepStatus (const Text_t *name)
	Access to certain analysis step status by name.
Bool_t	AddStepStatus (TGo4AnalysisStepStatus *next)
	Add new step status object to analysis status.
void	ResetStepIterator ()
TGo4AnalysisStepStatus *	NextStepStatus ()
	Gives next analysis step status.
Int_t	GetNumberOfSteps ()
	Gives number of steps.
TGo4AnalysisStepStatus *	GetStepStatus (Int_t indx)
	Gives analysis step status with provided index.
virtual Int_t	PrintStatus (Text_t *buffer=0, Int_t buflen=0)
	basic method to printout status information on stdout; to be overridden by specific subclass
Private Attributes
TObjArray *	fxStepArray
	Array containing all analysis steps.
TMutex *	fxStepMutex
	Mutex protecting the analysis step list.
TIterator *	fxStepIterator
	Iterator used for analysis step list.
Int_t	fbStepCheckingMode
	True if chain of steps is checked for consistency of input and output events.
Int_t	fiFirstStepIndex
	Index describing the first analysis step from the steplist to be processed.
Int_t	fiLastStepIndex
	Index describing the last analysis step from the steplist to be processed.
Int_t	fiAutoSaveInterval
	Implicit Loop cycles in between two autosave actions.
Int_t	fiAutoSaveCompression
	compression level for autosave file
Int_t	fbAutoSaveOverwrite
	overwrite mode for autosave yes or no.
Int_t	fbAutoSaveOn
	True if Autosaving is enabled (default).
TString	fxAutoFileName
	Name of the autosave file.
TString	fxConfigFileName
	Name of the last configuration file.
Friends
class	TGo4Analysis

Detailed Description

Status of the analysis instance.

Can be sent to the display or controlling server to check the things.

Since:: 1/2001

Definition at line 32 of file TGo4AnalysisStatus.h.

Constructor & Destructor Documentation

TGo4AnalysisStatus::TGo4AnalysisStatus ( )

default ctor for streamer.

Definition at line 28 of file TGo4AnalysisStatus.cxx.
References TRACE.

TGo4AnalysisStatus::TGo4AnalysisStatus ( const char * name )

Definition at line 47 of file TGo4AnalysisStatus.cxx.
References fxStepArray, fxStepIterator, fxStepMutex, and TRACE.

TGo4AnalysisStatus::~TGo4AnalysisStatus ( ) [virtual]

Definition at line 68 of file TGo4AnalysisStatus.cxx.
References fxStepArray, fxStepIterator, fxStepMutex, and TRACE.

Member Function Documentation

void TGo4AnalysisStatus::SetStepChecking ( Int_t on ) [inline]

Definition at line 45 of file TGo4AnalysisStatus.h.
References fbStepCheckingMode.
Referenced by TGo4AnalysisStepManager::UpdateStatus().

Int_t TGo4AnalysisStatus::IsStepChecking ( ) const [inline]

Definition at line 46 of file TGo4AnalysisStatus.h.
References fbStepCheckingMode.

void TGo4AnalysisStatus::SetFirstStepIndex ( Int_t i ) [inline]

Definition at line 48 of file TGo4AnalysisStatus.h.
References fiFirstStepIndex.
Referenced by TGo4AnalysisStepManager::UpdateStatus().

Int_t TGo4AnalysisStatus::GetFirstStepIndex ( ) const [inline]

Definition at line 49 of file TGo4AnalysisStatus.h.
References fiFirstStepIndex.
Referenced by PrintStatus().

void TGo4AnalysisStatus::SetLastStepIndex ( Int_t i ) [inline]

Definition at line 51 of file TGo4AnalysisStatus.h.
References fiLastStepIndex.
Referenced by TGo4AnalysisStepManager::UpdateStatus().

Int_t TGo4AnalysisStatus::GetLastStepIndex ( ) const [inline]

Definition at line 52 of file TGo4AnalysisStatus.h.
References fiLastStepIndex.
Referenced by PrintStatus().

void TGo4AnalysisStatus::SetAutoSaveInterval ( Int_t i ) [inline]

Definition at line 54 of file TGo4AnalysisStatus.h.
References fiAutoSaveInterval.
Referenced by TGo4Interface::AnalysisAutoSave(), and TGo4Analysis::UpdateStatus().

Int_t TGo4AnalysisStatus::GetAutoSaveInterval ( ) const [inline]

Definition at line 55 of file TGo4AnalysisStatus.h.
References fiAutoSaveInterval.
Referenced by PrintStatus().

void TGo4AnalysisStatus::SetAutoSaveCompression ( Int_t i = 5 ) [inline]

Definition at line 57 of file TGo4AnalysisStatus.h.
References fiAutoSaveCompression.
Referenced by TGo4Interface::AnalysisAutoSave(), and TGo4Analysis::UpdateStatus().

Int_t TGo4AnalysisStatus::GetAutoSaveCompression ( ) const [inline]

Definition at line 58 of file TGo4AnalysisStatus.h.
References fiAutoSaveCompression.
Referenced by PrintStatus().

void TGo4AnalysisStatus::SetAutoSaveOverwrite ( Bool_t over = kTRUE ) [inline]

Definition at line 60 of file TGo4AnalysisStatus.h.
References fbAutoSaveOverwrite.
Referenced by TGo4Interface::AnalysisAutoSave(), and TGo4Analysis::UpdateStatus().

Int_t TGo4AnalysisStatus::IsAutoSaveOverwrite ( ) const [inline]

Definition at line 61 of file TGo4AnalysisStatus.h.
References fbAutoSaveOverwrite.
Referenced by PrintStatus().

void TGo4AnalysisStatus::SetAutoFileName ( const char * name ) [inline]

Definition at line 63 of file TGo4AnalysisStatus.h.
References fxAutoFileName.
Referenced by TGo4Interface::AnalysisAutoSave(), and TGo4Analysis::UpdateStatus().

const char* TGo4AnalysisStatus::GetAutoFileName ( ) const [inline]

Definition at line 64 of file TGo4AnalysisStatus.h.
References fxAutoFileName.
Referenced by PrintStatus().

void TGo4AnalysisStatus::SetConfigFileName ( const char * name ) [inline]

Definition at line 66 of file TGo4AnalysisStatus.h.
References fxConfigFileName.
Referenced by TGo4Interface::AnalysisConfigName(), and TGo4Analysis::UpdateStatus().

const char* TGo4AnalysisStatus::GetConfigFileName ( ) const [inline]

Definition at line 67 of file TGo4AnalysisStatus.h.
References fxConfigFileName.

void TGo4AnalysisStatus::SetAutoSaveOn ( Bool_t on = kTRUE ) [inline]

Definition at line 69 of file TGo4AnalysisStatus.h.
References fbAutoSaveOn.
Referenced by TGo4Interface::AnalysisAutoSave(), and TGo4Analysis::UpdateStatus().

Int_t TGo4AnalysisStatus::IsAutoSaveOn ( ) const [inline]

Definition at line 70 of file TGo4AnalysisStatus.h.
References fbAutoSaveOn.

TGo4AnalysisStepStatus * TGo4AnalysisStatus::GetStepStatus ( const Text_t * name )

Access to certain analysis step status by name.

Definition at line 124 of file TGo4AnalysisStatus.cxx.
References fxStepArray, fxStepMutex, and TRACE.
Referenced by TGo4Interface::GetStepStatus().

Bool_t TGo4AnalysisStatus::AddStepStatus ( TGo4AnalysisStepStatus * next )

Add new step status object to analysis status.

Definition at line 160 of file TGo4AnalysisStatus.cxx.
References fxStepArray, fxStepMutex, and TRACE.
Referenced by TGo4AnalysisStepManager::UpdateStatus().

void TGo4AnalysisStatus::ResetStepIterator ( )

Definition at line 148 of file TGo4AnalysisStatus.cxx.
References fxStepArray, fxStepIterator, and fxStepMutex.
Referenced by PrintStatus().

TGo4AnalysisStepStatus * TGo4AnalysisStatus::NextStepStatus ( )

Gives next analysis step status.

Definition at line 136 of file TGo4AnalysisStatus.cxx.
References fxStepIterator, fxStepMutex, and TRACE.
Referenced by PrintStatus().

Int_t TGo4AnalysisStatus::GetNumberOfSteps ( )

Gives number of steps.

Definition at line 180 of file TGo4AnalysisStatus.cxx.
References fxStepArray.
Referenced by GetStepStatus().

TGo4AnalysisStepStatus * TGo4AnalysisStatus::GetStepStatus ( Int_t indx )

Gives analysis step status with provided index.

Definition at line 186 of file TGo4AnalysisStatus.cxx.
References fxStepArray, and GetNumberOfSteps().

Int_t TGo4AnalysisStatus::PrintStatus ( Text_t * buffer = 0,

Int_t buflen = 0

) [virtual]

basic method to printout status information on stdout; to be overridden by specific subclass

Reimplemented from TGo4Status.
Definition at line 77 of file TGo4AnalysisStatus.cxx.
References GetAutoFileName(), GetAutoSaveCompression(), GetAutoSaveInterval(), GetFirstStepIndex(), GetLastStepIndex(), IsAutoSaveOverwrite(), NextStepStatus(), TGo4Status::PrintBuffer(), TGo4AnalysisStepStatus::PrintStatus(), ResetStepIterator(), and TRACE.
Referenced by TGo4Analysis::Print().

Friends And Related Function Documentation

friend class TGo4Analysis [friend]

Definition at line 34 of file TGo4AnalysisStatus.h.

Member Data Documentation

TObjArray* TGo4AnalysisStatus::fxStepArray [private]

Array containing all analysis steps.
The steplist is iterated by the maincycle from start to end index to process the active steps.
Definition at line 97 of file TGo4AnalysisStatus.h.
Referenced by AddStepStatus(), GetNumberOfSteps(), GetStepStatus(), ResetStepIterator(), TGo4AnalysisStatus(), and ~TGo4AnalysisStatus().

TMutex* TGo4AnalysisStatus::fxStepMutex [private]

Mutex protecting the analysis step list.

Definition at line 100 of file TGo4AnalysisStatus.h.
Referenced by AddStepStatus(), GetStepStatus(), NextStepStatus(), ResetStepIterator(), TGo4AnalysisStatus(), and ~TGo4AnalysisStatus().

TIterator* TGo4AnalysisStatus::fxStepIterator [private]

Iterator used for analysis step list.

Definition at line 103 of file TGo4AnalysisStatus.h.
Referenced by NextStepStatus(), ResetStepIterator(), TGo4AnalysisStatus(), and ~TGo4AnalysisStatus().

Int_t TGo4AnalysisStatus::fbStepCheckingMode [private]

True if chain of steps is checked for consistency of input and output events.
Default is true. Can be disabled for steps working in non-subsequent manner. i.e. intermediate steps may be disabled, event structures of subsequent steps need not match.
Definition at line 109 of file TGo4AnalysisStatus.h.
Referenced by IsStepChecking(), and SetStepChecking().

Int_t TGo4AnalysisStatus::fiFirstStepIndex [private]

Index describing the first analysis step from the steplist to be processed.
The first analysis step will use its own event source to get input events.
Definition at line 114 of file TGo4AnalysisStatus.h.
Referenced by GetFirstStepIndex(), and SetFirstStepIndex().

Int_t TGo4AnalysisStatus::fiLastStepIndex [private]

Index describing the last analysis step from the steplist to be processed.
Output event of the last analysis step is accessible by GetEvent method and is used for user event function and dynamic list.
Definition at line 120 of file TGo4AnalysisStatus.h.
Referenced by GetLastStepIndex(), and SetLastStepIndex().

Int_t TGo4AnalysisStatus::fiAutoSaveInterval [private]

Implicit Loop cycles in between two autosave actions.
Autosave will write calibration objects of steps into event file and will save all histograms into an default root file.
Definition at line 125 of file TGo4AnalysisStatus.h.
Referenced by GetAutoSaveInterval(), and SetAutoSaveInterval().

Int_t TGo4AnalysisStatus::fiAutoSaveCompression [private]

compression level for autosave file

Definition at line 128 of file TGo4AnalysisStatus.h.
Referenced by GetAutoSaveCompression(), and SetAutoSaveCompression().

Int_t TGo4AnalysisStatus::fbAutoSaveOverwrite [private]

overwrite mode for autosave yes or no.
Internally, we use Int_t for correct streamer!
Definition at line 132 of file TGo4AnalysisStatus.h.
Referenced by IsAutoSaveOverwrite(), and SetAutoSaveOverwrite().

Int_t TGo4AnalysisStatus::fbAutoSaveOn [private]

True if Autosaving is enabled (default).
If false, calling AutoSave() will have no effect.
Definition at line 136 of file TGo4AnalysisStatus.h.
Referenced by IsAutoSaveOn(), and SetAutoSaveOn().

TString TGo4AnalysisStatus::fxAutoFileName [private]

Name of the autosave file.

Definition at line 139 of file TGo4AnalysisStatus.h.
Referenced by GetAutoFileName(), and SetAutoFileName().

TString TGo4AnalysisStatus::fxConfigFileName [private]

Name of the last configuration file.

Definition at line 142 of file TGo4AnalysisStatus.h.
Referenced by GetConfigFileName(), and SetConfigFileName().

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

Go4StatusAnalysis/TGo4AnalysisStatus.h
Go4StatusAnalysis/TGo4AnalysisStatus.cxx

Generated on Fri Nov 28 13:00:24 2008 for Go4-v3.04-1 by

1.4.2

TGo4AnalysisStatus Class Reference

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation