Go4Analysis
Class TGo4AnalysisStepManager

class TGo4AnalysisStepManager

derived from TNamed

This object is responsible for the
organisation of analysis steps. Keeps lists of steps. Is aggregate of TGo4Analysis.

Author:

J. Adamczewski

Since: 07-May-2002

Constructor Summary

TGo4AnalysisStepManager()

TGo4AnalysisStepManager(const Text_t* name)

Destructor Summary

~TGo4AnalysisStepManager()

Method Summary
Bool_t	AddAnalysisStep(TGo4AnalysisStep* next)           Method for user analysis constructor to setup the list of analyisis steps.
void	AutoSave()           Save step specific parts.
void	CloseAnalysis()           Finish the analysis run and close all event sources/storages.
TGo4AnalysisStep*	GetAnalysisStep(const char * name)           Access to certain analysis step by name.
TGo4EventElement*	GetInputEvent(const char * stepname)           Returns the input event structure of analysis step.
TGo4EventElement*	GetInputEvent(Int_t stepindex)           Returns the input event structure of analysis step.
TGo4EventElement*	GetOutputEvent(const char * stepname)           Returns the output event (detector) structure of analysis step.
TGo4EventElement*	GetOutputEvent(Int_t stepindex)           Returns the output event (detector) structure of analysis step.
TGo4EventElement*	GetOutputEvent()           Returns the output event (detector) structure of analysis step.
virtual Bool_t	InitEventClasses()           Initialization of the event class plugins which are delivered from the user defined event factory.
Int_t	IsErrorStopEnabled()
Bool_t	IsStepChecking()
Bool_t	NewStepProcessor(const Text_t* name, TGo4EventProcessorParameter* par)           Shuts down the old analysis step processor and creates a new one specified by parameter par.
Bool_t	NewStepSource(const Text_t* name, TGo4EventSourceParameter* par)           Shuts down the old analysis step event source and creates a new one specified by parameter par.
Bool_t	NewStepStore(const Text_t* name, TGo4EventStoreParameter* par)           Shuts down the old analysis step storage and creates a new one specified by parameter par.
Int_t	ProcessAnalysisSteps()           Uses the chain of analysis steps to process the first input event into an output event which then is accessible at the output event member.
Bool_t	SetFirstStep(const Text_t* name)           Sets analysis step name as first one to be processed in the chain of steps.
Bool_t	SetLastStep(const Text_t* name)           Sets analysis step name as last one to be processed in the chain of steps.
void	SetOutputEvent(TGo4EventElement* event)
void	SetStatus(TGo4AnalysisStatus* state)           Set step specific part of analysis status object to steplist
void	SetStepChecking(Bool_t on)
Bool_t	SetStepStorage(const Text_t* name, Bool_t on)           Enables analysis step of name to write its output event into its event store.
Int_t	Store(const Text_t* name, TGo4Parameter* obj)           Write object obj into eventstore of the step specified by name.
Int_t	Store(const Text_t* name, TGo4Condition* con)           Write condition con into eventstore of the step specified by name.
Int_t	Store(const Text_t* name, TGo4Fitter* fit)           Write fitter fit into eventstore of the step specified by name.
Int_t	Store(const Text_t* name, TFolder* folder)           Write folder into eventstore of the step specified by name.
void	UpdateStatus(TGo4AnalysisStatus* state)           Update step specific part of analysis status object

Methods inherited from class TNamed

operator=, Clear, Clone, Compare, Copy, FillBuffer, GetName, GetTitle, Hash, IsSortable, SetName, SetNameTitle, SetTitle, ls, Print, Sizeof, Class, Class_Name, Class_Version, Dictionary, IsA, ShowMembers, Streamer, StreamerNVirtual, DeclFileName, ImplFileLine, ImplFileName, DeclFileLine

Field Detail

fbStepCheckingMode

private Bool_t fbStepCheckingMode

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.

private Int_t fiCurrentStepIndex

Index describing the current analysis step.
Used to check the first and last step to be processed.

private Int_t fiFirstStepIndex

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.

private Int_t fiLastStepIndex

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.

private TGo4AnalysisStep* fxCurrentStep

Points to the currently active analysis step.

supplierCardinality 1

private TGo4EventElement* fxOutputEvent

Link to the last output event produced by the event analysis steps.
Can be processed further by user event function and dynamic list.

private TIterator* fxStepIterator

Iterator used for analysis step list.

private TObjArray* fxStepList

Array containing all analysis steps. The steplist is iterated by
the maincycle from start to end index to process the active steps.

private TMutex* fxStepMutex

Mutex protecting the analysis step list.

public TGo4AnalysisStepManager()

public TGo4AnalysisStepManager(const Text_t* name)

public synchronized ~TGo4AnalysisStepManager()

public Bool_t AddAnalysisStep(TGo4AnalysisStep* next)

Method for user analysis constructor to setup the list
of analyisis steps. Each call of this method will add a new
analysis step at the end of the list. Caution: user has to take
care that output and input event types of subsequent steps
are matching! Analyisis steps cannot be removed, since the
steplist is not intended to be dynamic. This is a pure creational method.
Analysis steps are owned by the steplist once they have been added.

public void AutoSave()

Save step specific parts.

public void CloseAnalysis()

Finish the analysis run and close all event sources/storages.
The analysis instance and the setup of the analysis steps is not
deleted.

public TGo4AnalysisStep* GetAnalysisStep(const char * name)

Access to certain analysis step by name. For analysis internal usage.

public TGo4EventElement* GetInputEvent(const char * stepname)

Returns the input event structure of analysis step. Argument indicates
the step by name.
For internal usage in the user defined event function
UserEventFunc, and is used by analysis steps to get result of previous steps.

public TGo4EventElement* GetInputEvent(Int_t stepindex)

Returns the input event structure of analysis step. Argument number indicates
the step from 0 (first) to n (last) in subsequent
order.
For internal usage in the user defined event function
UserEventFunc, and is used by analysis steps to access event sources of previous steps.

public TGo4EventElement* GetOutputEvent(const char * stepname)

Returns the output event (detector) structure of analysis step. Argument indicates
the step by name.
For internal usage in the user defined event function
UserEventFunc, and is used by analysis steps to get result of previous steps.

public TGo4EventElement* GetOutputEvent(Int_t stepindex)

Returns the output event (detector) structure of analysis step. Argument number indicates
the step from 0 (first) to n (last) in subsequent
order. Default is the output event of the
currently processed step, which is set by
SetEvent method.
For internal usage in the user defined event function
UserEventFunc, and is used by analysis steps to get result of previous steps.

public TGo4EventElement* GetOutputEvent()

Returns the output event (detector) structure of analysis step. Is set by
SetOutputEvent method. For internal usage in the user defined event function
UserEventFunc, and is used by analysis steps to get result of previous steps.

public virtual Bool_t InitEventClasses()

Initialization of the event class plugins which are delivered from
the user defined event factory. The virtual standard base class method may be changed
by overriding; normally, this is not necessary.

public Int_t IsErrorStopEnabled()

public Bool_t IsStepChecking()

public Bool_t NewStepProcessor(const Text_t* name, TGo4EventProcessorParameter* par)

Shuts down the old analysis step processor and creates a new
one specified by parameter par. To be used in online mode to
switch event processing.

public Bool_t NewStepSource(const Text_t* name, TGo4EventSourceParameter* par)

Shuts down the old analysis step event source and creates a new
one specified by parameter par. To be used in online mode to
switch input.

public Bool_t NewStepStore(const Text_t* name, TGo4EventStoreParameter* par)

Shuts down the old analysis step storage and creates a new
one specified by parameter par. To be used in online mode to
switch output files.

public Int_t ProcessAnalysisSteps()

Uses the chain of analysis steps to process the first input
event into an output event which then is accessible at
the output event member. Returns number of
steps run. For internal usage in the MainCycle and
GetEvent methods; may also be called from UserEventFunc
directly.

public Bool_t SetFirstStep(const Text_t* name)

Sets analysis step name as first one to be processed in
the chain of steps. First step will read input event from its
event source. If name is nullpointer, takes first step in steplist.

public Bool_t SetLastStep(const Text_t* name)

Sets analysis step name as last one to be processed in
the chain of steps. Last step will write output event into its
event store by default, its output event is accessible in the user
analysis. If name is nullpointer, takes last step in steplist.

public void SetOutputEvent(TGo4EventElement* event)

public void SetStatus(TGo4AnalysisStatus* state)

Set step specific part of analysis status object to steplist

public void SetStepChecking(Bool_t on)

public Bool_t SetStepStorage(const Text_t* name, Bool_t on)

Enables analysis step of name to write its output event into
its event store. By default only the last analysis step
will keep the output event in the store, the intermediate
steps will only pass the output to the subsequent step.
This method lets also any intermediate step write the
result to its store, which can later be used to process from
this point of the analysis chain. However, you may also
switch off the storage of the last analysis step output
if you only want to use the histograms produced by the
final user event function.

public Int_t Store(const Text_t* name, TGo4Parameter* obj)

Write object obj into eventstore of the step specified by name.
Current event number will be added to object name in the file.
Returns -1 in case of not active eventstore. Returns +1 in case
of unknown step.

public Int_t Store(const Text_t* name, TGo4Condition* con)

Write condition con into eventstore of the step specified by name.
Current event number will be added to parameter name in the file.
Returns -1 in case of not active eventstore. Returns +1 in case
of unknown step.

public Int_t Store(const Text_t* name, TGo4Fitter* fit)

Write fitter fit into eventstore of the step specified by name.
Current event number will be added to parameter name in the file.
Returns -1 in case of not active eventstore. Returns +1 in case
of unknown step.

public Int_t Store(const Text_t* name, TFolder* folder)

Write folder into eventstore of the step specified by name.
Current event number will be added to parameter name in the file.
Returns -1 in case of not active eventstore. Returns +1 in case
of unknown step.

public void UpdateStatus(TGo4AnalysisStatus* state)

Update step specific part of analysis status object

Association Links

to Class TObjArray

Array containing all analysis steps. The steplist is iterated by
the maincycle from start to end index to process the active steps.

to Class TMutex

Mutex protecting the analysis step list.

to Class TIterator

Iterator used for analysis step list.

to Class TGo4AnalysisStep

Points to the currently active analysis step.

Supplier Cardinality 1

to Class TGo4EventElement

Link to the last output event produced by the event analysis steps.
Can be processed further by user event function and dynamic list.