TGo4AnalysisStatus Class Reference

#include <TGo4AnalysisStatus.h>

Inheritance diagram for TGo4AnalysisStatus:

Public Member Functions
	TGo4AnalysisStatus ()
	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 char *name)
Bool_t	AddStepStatus (TGo4AnalysisStepStatus *next)
void	ClearStepStatus ()
void	ResetStepIterator ()
TGo4AnalysisStepStatus *	NextStepStatus ()
Int_t	GetNumberOfSteps () const
TGo4AnalysisStepStatus *	GetStepStatus (Int_t indx) const
void	Print (Option_t *opt="") const override
Public Member Functions inherited from TGo4Status
	TGo4Status ()
	TGo4Status (const char *name)
	TGo4Status (const char *name, const char *title)
virtual	~TGo4Status ()
virtual Int_t	PrintStatus (Text_t *buffer=nullptr, Int_t buflen=0)
void	Print (Option_t *opt="") const override

Protected Attributes
TObjArray *	fxStepArray {nullptr}
TMutex *	fxStepMutex {nullptr}
TIterator *	fxStepIterator {nullptr}
Int_t	fbStepCheckingMode {1}
Int_t	fiFirstStepIndex {0}
Int_t	fiLastStepIndex {0}
Int_t	fiAutoSaveInterval {0}
Int_t	fiAutoSaveCompression {5}
Int_t	fbAutoSaveOverwrite {0}
Int_t	fbAutoSaveOn {1}
TString	fxAutoFileName
TString	fxConfigFileName

Friends
class	TGo4Analysis

Additional Inherited Members
Public Types inherited from TGo4Status
enum	{ kGo4NoReset = BIT(20), kGo4CanDelete = BIT(21), kGo4BackStoreReset = BIT(22) }
Static Public Member Functions inherited from TGo4Status
static Text_t *	PrintIndent (Text_t *buffer, Int_t &buflen)
static Text_t *	PrintBuffer (char *buffer, Int_t &buflen, const char *text,...)
static void	PrintLine (const char *text,...)

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 30 of file TGo4AnalysisStatus.h.

Constructor & Destructor Documentation

TGo4AnalysisStatus() [1/2]

TGo4AnalysisStatus::TGo4AnalysisStatus

(

)

default ctor for streamer.

Definition at line 24 of file TGo4AnalysisStatus.cxx.

TGo4AnalysisStatus() [2/2]

TGo4AnalysisStatus::TGo4AnalysisStatus

(

const char *

name

)

Definition at line 30 of file TGo4AnalysisStatus.cxx.

References fxStepArray, fxStepIterator, and fxStepMutex.

~TGo4AnalysisStatus()

TGo4AnalysisStatus::~TGo4AnalysisStatus ( )

virtual

Definition at line 38 of file TGo4AnalysisStatus.cxx.

References fxStepArray, fxStepIterator, and fxStepMutex.

Member Function Documentation

AddStepStatus()

Bool_t TGo4AnalysisStatus::AddStepStatus

(

TGo4AnalysisStepStatus *

next

)

Add new step status object to analysis status.

Definition at line 96 of file TGo4AnalysisStatus.cxx.

References fxStepArray, and fxStepMutex.

Referenced by IsAutoSaveOn(), and TGo4AnalysisStepManager::UpdateStatus().

ClearStepStatus()

void TGo4AnalysisStatus::ClearStepStatus

(

)

Clear all existing step status objects. For remote http control

Definition at line 107 of file TGo4AnalysisStatus.cxx.

References fxStepArray, and fxStepMutex.

Referenced by IsAutoSaveOn(), and TGo4AnalysisStepManager::UpdateStatus().

GetAutoFileName()

const char* TGo4AnalysisStatus::GetAutoFileName ( ) const

inline

Definition at line 62 of file TGo4AnalysisStatus.h.

References fxAutoFileName.

Referenced by Print(), and TGo4Analysis::SetStatus().

GetAutoSaveCompression()

Int_t TGo4AnalysisStatus::GetAutoSaveCompression ( ) const

inline

Definition at line 56 of file TGo4AnalysisStatus.h.

References fiAutoSaveCompression.

Referenced by Print(), and TGo4Analysis::SetStatus().

GetAutoSaveInterval()

Int_t TGo4AnalysisStatus::GetAutoSaveInterval ( ) const

inline

Definition at line 53 of file TGo4AnalysisStatus.h.

References fiAutoSaveInterval.

Referenced by Print(), and TGo4Analysis::SetStatus().

GetConfigFileName()

const char* TGo4AnalysisStatus::GetConfigFileName ( ) const

inline

Definition at line 65 of file TGo4AnalysisStatus.h.

References fxConfigFileName.

GetFirstStepIndex()

Int_t TGo4AnalysisStatus::GetFirstStepIndex ( ) const

inline

Definition at line 47 of file TGo4AnalysisStatus.h.

References fiFirstStepIndex.

Referenced by Print(), and TGo4AnalysisStepManager::SetStatus().

GetLastStepIndex()

Int_t TGo4AnalysisStatus::GetLastStepIndex ( ) const

inline

Definition at line 50 of file TGo4AnalysisStatus.h.

References fiLastStepIndex.

Referenced by Print(), and TGo4AnalysisStepManager::SetStatus().

GetNumberOfSteps()

Int_t TGo4AnalysisStatus::GetNumberOfSteps

(

)

const

Gives number of steps.

Definition at line 114 of file TGo4AnalysisStatus.cxx.

References fxStepArray.

Referenced by GetStepStatus(), IsAutoSaveOn(), and Print().

GetStepStatus() [1/2]

TGo4AnalysisStepStatus * TGo4AnalysisStatus::GetStepStatus

(

const char *

name

)

Access to certain analysis step status by name.

Definition at line 70 of file TGo4AnalysisStatus.cxx.

References fxStepArray, and fxStepMutex.

Referenced by TGo4Interface::GetStepStatus(), IsAutoSaveOn(), Print(), and TGo4AnalysisStepManager::SetStatus().

GetStepStatus() [2/2]

TGo4AnalysisStepStatus * TGo4AnalysisStatus::GetStepStatus

(

Int_t

indx

)

const

Gives analysis step status with provided index.

Definition at line 120 of file TGo4AnalysisStatus.cxx.

References fxStepArray, and GetNumberOfSteps().

IsAutoSaveOn()

Int_t TGo4AnalysisStatus::IsAutoSaveOn ( ) const

inline

Definition at line 68 of file TGo4AnalysisStatus.h.

References AddStepStatus(), ClearStepStatus(), fbAutoSaveOn, GetNumberOfSteps(), GetStepStatus(), NextStepStatus(), Print(), and ResetStepIterator().

Referenced by Print(), and TGo4Analysis::SetStatus().

IsAutoSaveOverwrite()

Int_t TGo4AnalysisStatus::IsAutoSaveOverwrite ( ) const

inline

Definition at line 59 of file TGo4AnalysisStatus.h.

References fbAutoSaveOverwrite.

Referenced by Print(), and TGo4Analysis::SetStatus().

IsStepChecking()

Int_t TGo4AnalysisStatus::IsStepChecking ( ) const

inline

Definition at line 44 of file TGo4AnalysisStatus.h.

References fbStepCheckingMode.

Referenced by TGo4AnalysisStepManager::SetStatus().

NextStepStatus()

TGo4AnalysisStepStatus * TGo4AnalysisStatus::NextStepStatus

(

)

Gives next analysis step status.

Definition at line 78 of file TGo4AnalysisStatus.cxx.

References fxStepIterator, and fxStepMutex.

Referenced by IsAutoSaveOn(), and TGo4AnalysisWebStatus::UpdateFromUrl().

Print()

void TGo4AnalysisStatus::Print ( Option_t *  opt = "" ) const

override

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

Definition at line 46 of file TGo4AnalysisStatus.cxx.

References GetAutoFileName(), GetAutoSaveCompression(), GetAutoSaveInterval(), GetFirstStepIndex(), GetLastStepIndex(), GetNumberOfSteps(), GetStepStatus(), IsAutoSaveOn(), IsAutoSaveOverwrite(), and TGo4Status::PrintLine().

Referenced by IsAutoSaveOn(), and TGo4Analysis::Print().

ResetStepIterator()

void TGo4AnalysisStatus::ResetStepIterator

(

)

Definition at line 85 of file TGo4AnalysisStatus.cxx.

References fxStepArray, fxStepIterator, and fxStepMutex.

Referenced by IsAutoSaveOn(), and TGo4AnalysisWebStatus::UpdateFromUrl().

SetAutoFileName()

void TGo4AnalysisStatus::SetAutoFileName ( const char *  name )

inline

Definition at line 61 of file TGo4AnalysisStatus.h.

References fxAutoFileName.

Referenced by TGo4Interface::AnalysisAutoSave(), TGo4AnalysisWebStatus::UpdateFromUrl(), and TGo4Analysis::UpdateStatus().

SetAutoSaveCompression()

void TGo4AnalysisStatus::SetAutoSaveCompression ( Int_t  i = 5 )

inline

Definition at line 55 of file TGo4AnalysisStatus.h.

References fiAutoSaveCompression.

Referenced by TGo4Interface::AnalysisAutoSave(), TGo4AnalysisWebStatus::UpdateFromUrl(), and TGo4Analysis::UpdateStatus().

SetAutoSaveInterval()

void TGo4AnalysisStatus::SetAutoSaveInterval ( Int_t  i )

inline

Definition at line 52 of file TGo4AnalysisStatus.h.

References fiAutoSaveInterval.

Referenced by TGo4Interface::AnalysisAutoSave(), TGo4AnalysisWebStatus::UpdateFromUrl(), and TGo4Analysis::UpdateStatus().

SetAutoSaveOn()

void TGo4AnalysisStatus::SetAutoSaveOn ( Bool_t  on = kTRUE )

inline

Definition at line 67 of file TGo4AnalysisStatus.h.

References fbAutoSaveOn.

Referenced by TGo4Interface::AnalysisAutoSave(), TGo4AnalysisWebStatus::UpdateFromUrl(), and TGo4Analysis::UpdateStatus().

SetAutoSaveOverwrite()

void TGo4AnalysisStatus::SetAutoSaveOverwrite ( Bool_t  over = kTRUE )

inline

Definition at line 58 of file TGo4AnalysisStatus.h.

References fbAutoSaveOverwrite.

Referenced by TGo4Interface::AnalysisAutoSave(), TGo4AnalysisWebStatus::UpdateFromUrl(), and TGo4Analysis::UpdateStatus().

SetConfigFileName()

void TGo4AnalysisStatus::SetConfigFileName ( const char *  name )

inline

Definition at line 64 of file TGo4AnalysisStatus.h.

References fxConfigFileName.

Referenced by TGo4Interface::AnalysisConfigName(), TGo4AnalysisWebStatus::UpdateFromUrl(), and TGo4Analysis::UpdateStatus().

SetFirstStepIndex()

void TGo4AnalysisStatus::SetFirstStepIndex ( Int_t  i )

inline

Definition at line 46 of file TGo4AnalysisStatus.h.

References fiFirstStepIndex.

Referenced by TGo4AnalysisStepManager::UpdateStatus().

SetLastStepIndex()

void TGo4AnalysisStatus::SetLastStepIndex ( Int_t  i )

inline

Definition at line 49 of file TGo4AnalysisStatus.h.

References fiLastStepIndex.

Referenced by TGo4AnalysisStepManager::UpdateStatus().

SetStepChecking()

void TGo4AnalysisStatus::SetStepChecking ( Int_t  on )

inline

Definition at line 43 of file TGo4AnalysisStatus.h.

References fbStepCheckingMode.

Referenced by TGo4AnalysisStepManager::UpdateStatus().

Friends And Related Function Documentation

TGo4Analysis

friend class TGo4Analysis

friend

Definition at line 32 of file TGo4AnalysisStatus.h.

Member Data Documentation

fbAutoSaveOn

Int_t TGo4AnalysisStatus::fbAutoSaveOn {1}

protected

True if Autosaving is enabled (default). If false, calling AutoSave() will have no effect.

Definition at line 137 of file TGo4AnalysisStatus.h.

Referenced by IsAutoSaveOn(), and SetAutoSaveOn().

fbAutoSaveOverwrite

Int_t TGo4AnalysisStatus::fbAutoSaveOverwrite {0}

protected

overwrite mode for autosave yes or no. Internally, we use Int_t for correct streamer!

Definition at line 133 of file TGo4AnalysisStatus.h.

Referenced by IsAutoSaveOverwrite(), SetAutoSaveOverwrite(), and TGo4AnalysisWebStatus::UpdateFromUrl().

fbStepCheckingMode

Int_t TGo4AnalysisStatus::fbStepCheckingMode {1}

protected

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 110 of file TGo4AnalysisStatus.h.

Referenced by IsStepChecking(), and SetStepChecking().

fiAutoSaveCompression

Int_t TGo4AnalysisStatus::fiAutoSaveCompression {5}

protected

compression level for autosave file

Definition at line 129 of file TGo4AnalysisStatus.h.

Referenced by GetAutoSaveCompression(), SetAutoSaveCompression(), and TGo4AnalysisWebStatus::UpdateFromUrl().

fiAutoSaveInterval

Int_t TGo4AnalysisStatus::fiAutoSaveInterval {0}

protected

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 126 of file TGo4AnalysisStatus.h.

Referenced by GetAutoSaveInterval(), and SetAutoSaveInterval().

fiFirstStepIndex

Int_t TGo4AnalysisStatus::fiFirstStepIndex {0}

protected

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 115 of file TGo4AnalysisStatus.h.

Referenced by GetFirstStepIndex(), and SetFirstStepIndex().

fiLastStepIndex

Int_t TGo4AnalysisStatus::fiLastStepIndex {0}

protected

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 121 of file TGo4AnalysisStatus.h.

Referenced by GetLastStepIndex(), and SetLastStepIndex().

fxAutoFileName

TString TGo4AnalysisStatus::fxAutoFileName

protected

Name of the autosave file.

Definition at line 140 of file TGo4AnalysisStatus.h.

Referenced by GetAutoFileName(), and SetAutoFileName().

fxConfigFileName

TString TGo4AnalysisStatus::fxConfigFileName

protected

Name of the last configuration file.

Definition at line 143 of file TGo4AnalysisStatus.h.

Referenced by GetConfigFileName(), and SetConfigFileName().

fxStepArray

TObjArray* TGo4AnalysisStatus::fxStepArray {nullptr}

protected

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 98 of file TGo4AnalysisStatus.h.

Referenced by AddStepStatus(), ClearStepStatus(), GetNumberOfSteps(), GetStepStatus(), ResetStepIterator(), TGo4AnalysisStatus(), and ~TGo4AnalysisStatus().

fxStepIterator

TIterator* TGo4AnalysisStatus::fxStepIterator {nullptr}

protected

Iterator used for analysis step list.

Definition at line 104 of file TGo4AnalysisStatus.h.

Referenced by NextStepStatus(), ResetStepIterator(), TGo4AnalysisStatus(), and ~TGo4AnalysisStatus().

fxStepMutex

TMutex* TGo4AnalysisStatus::fxStepMutex {nullptr}

protected

Mutex protecting the analysis step list.

Definition at line 101 of file TGo4AnalysisStatus.h.

Referenced by AddStepStatus(), ClearStepStatus(), GetStepStatus(), NextStepStatus(), ResetStepIterator(), TGo4AnalysisStatus(), and ~TGo4AnalysisStatus().

---

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

• Go4StatusAnalysis/TGo4AnalysisStatus.h
• Go4StatusAnalysis/TGo4AnalysisStatus.cxx