GSI Object Oriented Online Offline (Go4)  GO4-6.1.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
TGo4AnalysisStepManager Class Reference

#include <TGo4AnalysisStepManager.h>

+ Inheritance diagram for TGo4AnalysisStepManager:

Public Member Functions

 TGo4AnalysisStepManager (const char *name)
 
virtual ~TGo4AnalysisStepManager ()
 
Int_t ProcessAnalysisSteps ()
 
TGo4AnalysisStepGetAnalysisStep (const char *name)
 
Int_t GetNumberOfAnalysisSteps ()
 
TGo4AnalysisStepGetAnalysisStepNum (Int_t number)
 
Bool_t AddAnalysisStep (TGo4AnalysisStep *next)
 
void CloseAnalysis ()
 
virtual Bool_t InitEventClasses ()
 
void UpdateStatus (TGo4AnalysisStatus *state)
 
void SetStatus (TGo4AnalysisStatus *state)
 
void AutoSave ()
 
Bool_t SetFirstStep (const char *name)
 
Bool_t SetLastStep (const char *name)
 
Bool_t SetStepStorage (const char *name, Bool_t on)
 
Bool_t NewStepStore (const char *name, TGo4EventStoreParameter *par)
 
Bool_t NewStepSource (const char *name, TGo4EventSourceParameter *par)
 
Bool_t NewStepProcessor (const char *name, TGo4EventProcessorParameter *par)
 
Int_t Store (const char *name, TGo4Parameter *obj)
 
Int_t Store (const char *name, TGo4Condition *con)
 
Int_t Store (const char *name, TGo4Fitter *fit)
 
Int_t Store (const char *name, TFolder *folder)
 
TGo4EventElementGetInputEvent (const char *stepname)
 
TGo4EventElementGetInputEvent (Int_t stepindex)
 
TGo4EventElementGetOutputEvent (const char *stepname)
 
TGo4EventElementGetOutputEvent (Int_t stepindex)
 
TGo4EventElementGetOutputEvent ()
 
void SetOutputEvent (TGo4EventElement *event)
 
Int_t IsErrorStopEnabled ()
 
void SetStepChecking (Bool_t on=kTRUE)
 
Bool_t IsStepChecking ()
 

Private Attributes

TObjArray * fxStepList
 
TIterator * fxStepIterator
 
Int_t fiFirstStepIndex
 
Int_t fiLastStepIndex
 
Int_t fiCurrentStepIndex
 
Bool_t fbStepCheckingMode
 
TGo4AnalysisStepfxCurrentStep
 
TGo4EventElementfxOutputEvent
 

Detailed Description

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

Definition at line 40 of file TGo4AnalysisStepManager.h.

Constructor & Destructor Documentation

TGo4AnalysisStepManager::TGo4AnalysisStepManager ( const char *  name)

Definition at line 27 of file TGo4AnalysisStepManager.cxx.

References fxStepIterator, and fxStepList.

TGo4AnalysisStepManager::~TGo4AnalysisStepManager ( )
virtual

Definition at line 40 of file TGo4AnalysisStepManager.cxx.

References fxStepIterator, and fxStepList.

Member Function Documentation

Bool_t TGo4AnalysisStepManager::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.

Definition at line 369 of file TGo4AnalysisStepManager.cxx.

References fiLastStepIndex, fxStepList, GO4TRACE, TGo4Analysis::Instance(), TGo4Analysis::Message(), and TGo4AnalysisStep::SetPreviousStep().

Referenced by TGo4Analysis::AddAnalysisStep().

void TGo4AnalysisStepManager::AutoSave ( )
void TGo4AnalysisStepManager::CloseAnalysis ( )

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

Definition at line 46 of file TGo4AnalysisStepManager.cxx.

References TGo4AnalysisStep::Close(), TGo4Log::Debug(), fxStepIterator, and GO4TRACE.

Referenced by TGo4Analysis::CloseAnalysis().

TGo4AnalysisStep * TGo4AnalysisStepManager::GetAnalysisStep ( const char *  name)

Access to certain analysis step by name. For analysis internal usage. if name==0, first step is returned

Definition at line 415 of file TGo4AnalysisStepManager.cxx.

References fiFirstStepIndex, fxStepList, and GO4TRACE.

Referenced by TGo4Analysis::GetAnalysisStep(), GetInputEvent(), GetOutputEvent(), NewStepProcessor(), NewStepSource(), NewStepStore(), SetStepStorage(), and Store().

TGo4AnalysisStep * TGo4AnalysisStepManager::GetAnalysisStepNum ( Int_t  number)

Access to certain analysis step by number.

Definition at line 431 of file TGo4AnalysisStepManager.cxx.

References fxStepList, and GO4TRACE.

Referenced by TGo4Analysis::GetAnalysisStepNum(), TGo4Analysis::PostLoop(), and TGo4Analysis::PreLoop().

TGo4EventElement * TGo4AnalysisStepManager::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.

Definition at line 313 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), TGo4AnalysisStep::GetEventProcessor(), TGo4EventProcessor::GetInputEvent(), and GO4TRACE.

Referenced by TGo4Analysis::GetInputEvent().

TGo4EventElement * TGo4AnalysisStepManager::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.

Definition at line 327 of file TGo4AnalysisStepManager.cxx.

References fxStepList, TGo4AnalysisStep::GetEventProcessor(), TGo4EventProcessor::GetInputEvent(), and GO4TRACE.

Int_t TGo4AnalysisStepManager::GetNumberOfAnalysisSteps ( )

Returns number of analysis steps

Definition at line 426 of file TGo4AnalysisStepManager.cxx.

References fxStepList.

Referenced by TGo4Analysis::PostLoop(), and TGo4Analysis::PreLoop().

TGo4EventElement * TGo4AnalysisStepManager::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.

Definition at line 342 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), TGo4AnalysisStep::GetOutputEvent(), and GO4TRACE.

Referenced by TGo4Analysis::GetOutputEvent().

TGo4EventElement * TGo4AnalysisStepManager::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.

Definition at line 355 of file TGo4AnalysisStepManager.cxx.

References fxStepList, TGo4AnalysisStep::GetOutputEvent(), and GO4TRACE.

TGo4EventElement* TGo4AnalysisStepManager::GetOutputEvent ( )
inline

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.

Definition at line 207 of file TGo4AnalysisStepManager.h.

References fxOutputEvent.

Bool_t TGo4AnalysisStepManager::InitEventClasses ( )
virtual

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.

Definition at line 60 of file TGo4AnalysisStepManager.cxx.

References TGo4Log::Debug(), fiCurrentStepIndex, fiFirstStepIndex, fiLastStepIndex, fxStepIterator, GO4TRACE, TGo4AnalysisStep::InitEventClasses(), TGo4Analysis::Instance(), TGo4AnalysisStep::IsMatchingPrevious(), TGo4AnalysisStep::IsProcessEnabled(), IsStepChecking(), and TGo4Analysis::Message().

Referenced by TGo4Analysis::InitEventClasses().

Int_t TGo4AnalysisStepManager::IsErrorStopEnabled ( )

Definition at line 539 of file TGo4AnalysisStepManager.cxx.

Referenced by TGo4Analysis::IsErrorStopEnabled().

Bool_t TGo4AnalysisStepManager::IsStepChecking ( )
inline

Definition at line 215 of file TGo4AnalysisStepManager.h.

References fbStepCheckingMode.

Referenced by InitEventClasses(), and ProcessAnalysisSteps().

Bool_t TGo4AnalysisStepManager::NewStepProcessor ( const char *  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.

Definition at line 274 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), GO4TRACE, and TGo4AnalysisStep::NewEventProcessor().

Referenced by TGo4Analysis::NewStepProcessor().

Bool_t TGo4AnalysisStepManager::NewStepSource ( const char *  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.

Definition at line 247 of file TGo4AnalysisStepManager.cxx.

References fiFirstStepIndex, fxStepList, GetAnalysisStep(), GO4TRACE, and TGo4AnalysisStep::NewEventSource().

Referenced by TGo4Analysis::NewStepSource().

Bool_t TGo4AnalysisStepManager::NewStepStore ( const char *  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.

Definition at line 223 of file TGo4AnalysisStepManager.cxx.

References fiLastStepIndex, fxStepList, GetAnalysisStep(), GO4TRACE, and TGo4AnalysisStep::NewEventStore().

Referenced by TGo4Analysis::NewStepStore().

Int_t TGo4AnalysisStepManager::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.

Definition at line 439 of file TGo4AnalysisStepManager.cxx.

References TGo4MainTree::Exists(), fiCurrentStepIndex, fiFirstStepIndex, fiLastStepIndex, fxCurrentStep, fxStepList, GO4TRACE, TGo4MainTree::Instance(), TGo4AnalysisStep::IsKeepInputEvent(), TGo4AnalysisStep::IsKeepOutputEvent(), TGo4AnalysisStep::IsSourceImplemented(), IsStepChecking(), TGo4AnalysisStep::Process(), SetOutputEvent(), TGo4AnalysisStep::SetSourceEnabled(), TGo4AnalysisStep::SetStatusMessage(), and TGo4MainTree::Update().

Referenced by TGo4Analysis::ProcessAnalysisSteps().

Bool_t TGo4AnalysisStepManager::SetFirstStep ( const char *  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.

Definition at line 127 of file TGo4AnalysisStepManager.cxx.

References fiFirstStepIndex, fiLastStepIndex, fxStepList, GO4TRACE, TGo4Analysis::Instance(), and TGo4Analysis::Message().

Referenced by TGo4Analysis::SetFirstStep().

Bool_t TGo4AnalysisStepManager::SetLastStep ( const char *  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.

Definition at line 164 of file TGo4AnalysisStepManager.cxx.

References fiFirstStepIndex, fiLastStepIndex, fxStepList, GO4TRACE, TGo4Analysis::Instance(), and TGo4Analysis::Message().

Referenced by TGo4Analysis::SetLastStep().

void TGo4AnalysisStepManager::SetOutputEvent ( TGo4EventElement event)
inline

Definition at line 209 of file TGo4AnalysisStepManager.h.

References fxOutputEvent.

Referenced by ProcessAnalysisSteps(), and TGo4Analysis::SetOutputEvent().

void TGo4AnalysisStepManager::SetStatus ( TGo4AnalysisStatus state)
void TGo4AnalysisStepManager::SetStepChecking ( Bool_t  on = kTRUE)
inline

Definition at line 213 of file TGo4AnalysisStepManager.h.

References fbStepCheckingMode.

Referenced by TGo4Analysis::SetStepChecking().

Bool_t TGo4AnalysisStepManager::SetStepStorage ( const char *  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.

Definition at line 204 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), GO4TRACE, and TGo4AnalysisStep::SetStoreEnabled().

Referenced by TGo4Analysis::SetStepStorage().

Int_t TGo4AnalysisStepManager::Store ( const char *  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.

Definition at line 289 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), and TGo4AnalysisStep::Store().

Referenced by TGo4Analysis::StoreCondition(), TGo4Analysis::StoreFitter(), TGo4Analysis::StoreFolder(), and TGo4Analysis::StoreParameter().

Int_t TGo4AnalysisStepManager::Store ( const char *  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.

Definition at line 295 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), and TGo4AnalysisStep::Store().

Int_t TGo4AnalysisStepManager::Store ( const char *  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.

Definition at line 301 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), and TGo4AnalysisStep::Store().

Int_t TGo4AnalysisStepManager::Store ( const char *  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.

Definition at line 307 of file TGo4AnalysisStepManager.cxx.

References GetAnalysisStep(), and TGo4AnalysisStep::Store().

void TGo4AnalysisStepManager::UpdateStatus ( TGo4AnalysisStatus state)

Member Data Documentation

Bool_t TGo4AnalysisStepManager::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 245 of file TGo4AnalysisStepManager.h.

Referenced by IsStepChecking(), SetStatus(), SetStepChecking(), and UpdateStatus().

Int_t TGo4AnalysisStepManager::fiCurrentStepIndex
private

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

Definition at line 239 of file TGo4AnalysisStepManager.h.

Referenced by InitEventClasses(), and ProcessAnalysisSteps().

Int_t TGo4AnalysisStepManager::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 229 of file TGo4AnalysisStepManager.h.

Referenced by GetAnalysisStep(), InitEventClasses(), NewStepSource(), ProcessAnalysisSteps(), SetFirstStep(), SetLastStep(), SetStatus(), and UpdateStatus().

Int_t TGo4AnalysisStepManager::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 235 of file TGo4AnalysisStepManager.h.

Referenced by AddAnalysisStep(), InitEventClasses(), NewStepStore(), ProcessAnalysisSteps(), SetFirstStep(), SetLastStep(), SetStatus(), and UpdateStatus().

TGo4AnalysisStep* TGo4AnalysisStepManager::fxCurrentStep
private

Points to the currently active analysis step. 1

Definition at line 249 of file TGo4AnalysisStepManager.h.

Referenced by ProcessAnalysisSteps(), SetStatus(), and UpdateStatus().

TGo4EventElement* TGo4AnalysisStepManager::fxOutputEvent
private

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

Definition at line 253 of file TGo4AnalysisStepManager.h.

Referenced by GetOutputEvent(), and SetOutputEvent().

TIterator* TGo4AnalysisStepManager::fxStepIterator
private

Iterator used for analysis step list.

Definition at line 224 of file TGo4AnalysisStepManager.h.

Referenced by AutoSave(), CloseAnalysis(), InitEventClasses(), SetStatus(), TGo4AnalysisStepManager(), UpdateStatus(), and ~TGo4AnalysisStepManager().

TObjArray* TGo4AnalysisStepManager::fxStepList
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 221 of file TGo4AnalysisStepManager.h.

Referenced by AddAnalysisStep(), GetAnalysisStep(), GetAnalysisStepNum(), GetInputEvent(), GetNumberOfAnalysisSteps(), GetOutputEvent(), NewStepSource(), NewStepStore(), ProcessAnalysisSteps(), SetFirstStep(), SetLastStep(), TGo4AnalysisStepManager(), and ~TGo4AnalysisStepManager().


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