Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

TGo4AnalysisStep Class Reference

Contains a single step of the analysis. More...

#include <TGo4AnalysisStep.h>

List of all members.

Public Member Functions

 TGo4AnalysisStep ()
 default ctor for streamer.
 TGo4AnalysisStep (const char *name, TGo4EventFactory *eventfactory, TGo4EventSourceParameter *sourcetype=0, TGo4EventStoreParameter *storetype=0, TGo4EventProcessorParameter *processortype=0)
 Normal ctor.
virtual ~TGo4AnalysisStep ()
void SetEventSource (TGo4EventSourceParameter *kind)
 Sets the event source parameter which is used on intitialization of this step.
void NewEventSource (TGo4EventSourceParameter *kind)
 For lazy initialization of event source.
void CloseEventSource ()
 Unregister and close eventsource, if existing.
void SetEventStore (TGo4EventStoreParameter *kind)
 Sets the event storee parameter which is used on intitialization of this step.
void NewEventStore (TGo4EventStoreParameter *kind)
 For lazy initialization of event store.
void CloseEventStore ()
 Unregister and close eventstore, if existing.
void SetEventProcessor (TGo4EventProcessorParameter *kind)
 Sets the event processor parameter which is used on intitialization of this step.
void NewEventProcessor (TGo4EventProcessorParameter *kind)
 For lazy initialization of event processor.
void CloseEventProcessor ()
 Unregister and close eventprocessor, if existing.
void NewInputEvent ()
 create input event object
void DeleteInputEvent ()
 Delete input event object.
void NewOutputEvent ()
 create input event object
void DeleteOutputEvent ()
 Delete input event object.
virtual void InitEventClasses ()
 Initialization of the event class plugins which are delivered from the user defined event factory.
void SetSourceEnabled (Bool_t on=kTRUE)
 Enables or disables the event source.
void SetStoreEnabled (Bool_t on=kTRUE)
 Enables or disables the event store.
void SetProcessEnabled (Bool_t on=kTRUE)
 Enables or disables the event processing.
void SetErrorStopEnabled (Bool_t on)
 Enables or disables the stop-on-error mode.
void ResetErrorStop ()
 Reset the stopped-after-error state of this analysis step object.
void SetInputEvent (TGo4EventElement *in)
 Sets reference to external input event.
void SetPreviousStep (TGo4AnalysisStep *pre)
 Sets reference to previous analysis step.
TGo4AnalysisStep * GetPreviousStep ()
 Get previous analysis step.
TGo4EventElement * GetOutputEvent ()
 Access to the output event which has been filled last.
TGo4EventElement * GetInputEvent ()
 Access to the input event of this step.
TGo4EventProcessor * GetEventProcessor ()
 Access to the event processor.
TGo4EventFactory * GetStepFactory ()
 Access to step factory.
Bool_t IsStoreEnabled ()
Bool_t IsStoreImplemented ()
Bool_t IsSourceImplemented ()
Bool_t IsSourceEnabled ()
Bool_t IsProcessEnabled ()
Bool_t IsErrorStopped ()
 True if analsis step has been stopped on error.
Bool_t IsErrorStopEnabled ()
 True if analsis step allows stop on error.
Int_t GetProcessStatus ()
 Status of the last event.
const char * GetStatusMessage ()
 Status message of last Process() call.
void SetStatusMessage (const char *txt)
 Set Status message of last Process() call.
Bool_t IsMatchingPrevious ()
 Check if an analysis step is matching as a previous step to this step.
const char * GetEventStoreName ()
 Access to name of currently active event store.
const char * GetEventSourceName ()
 Access to name of currently active event source.
void StoreCalibration ()
 Store the current calibration object of the event processor into the event store instance.
Int_t Store (TGo4Parameter *cali)
 Saves a parameter correllated with the current event into the storage.
Int_t Store (TGo4Condition *conny)
 Saves a condition correllated with the current event into the storage.
Int_t Store (TGo4Fitter *fitter)
 Saves a fitter correllated with the current event into the storage.
Int_t Store (TFolder *fold)
 Saves a folder correllated with the current event into the storage.
void Process ()
 The main analysis action which is invoked by the external go4 analysis.
void Close ()
 Closes the analysis step.
void SetStatus (TGo4AnalysisStepStatus *state)
 Set all analysis step parameters to that of given status object.
TGo4AnalysisStepStatus * CreateStatus ()
 Create a copy of the analysis step internal state.

Private Attributes

TGo4Analysis * fxOwner
 Points back to the analysis wich keeps this step.
TGo4AnalysisStep * fxPrevious
 Points to the previous analysis step.
TGo4EventFactory * fxEventFactory
 The abstract factory implementation which provides the event classes.
TGo4EventStore * fxEventStore
 The storage instance for the unpacked events (detector) structures.
TGo4EventSource * fxEventSource
 The source of the input events.
TGo4EventProcessor * fxEventProcessor
 The processing class which works on the input event and fills the output event.
TGo4EventElement * fxInputEvent
 points to the last input event delivered from the event source 1
TGo4EventElement * fxOutputEvent
 The unpacked event (detector) structure that has been filled by the analysis step .
TGo4EventSourceParameter * fxSourceType
 Parameter object of next event source to be activated.
TGo4EventStoreParameter * fxStoreType
 Parameter object of next event storage to be activated.
TGo4EventProcessorParameter * fxProcessorType
 Parameter object of next event processor to be activated.
Bool_t fbSourceEnabled
 Enables event source.If true, the event source is used to get the input event; otherwise we use the output of the previous step.
Bool_t fbSourceImplemented
 Flag for the previous analysis step.
Bool_t fbStoreEnabled
 Enables event store.
Bool_t fbStoreImplemented
 Flag for the subsequent analysis step.
Bool_t fbProcessEnabled
 Enables processing of the input event.
Bool_t fbErrorStopEnabled
 Operation mode switch.
Bool_t fbErrorStopped
 True if the analysis step has been stopped after input error.
Int_t fiProcessStatus
 Contains current analysis step status value.
TString fcStatusMessage
 Most recent status message.
TString fcBuffer
 Buffer string for text output.

Detailed Description

Contains a single step of the analysis.

Each analysis step has an event source, an input event structure, an output event structure (both from event element class), and an event store. Input event is converted to output event using an event processor instance which is referenced by the output event class, but not stored with the resulting data. Analysis steps are held in an analysis step list which is processed iteratively; output event of an analysis step is input event of the subsequent analysis step, etc. The first analysis step takes its input event from an external event source, e.g. a file; the last step writes the output event into its external event store. Starting and ending point within the chain of analysis steps may be changed on the fly.

Author:
J. Adamczewski
Since:
11-Jan-2001

Definition at line 59 of file TGo4AnalysisStep.h.

Constructor & Destructor Documentation

TGo4AnalysisStep::TGo4AnalysisStep (   ) 
 

default ctor for streamer.

Definition at line 62 of file TGo4AnalysisStep.cxx.

References fxEventFactory, fxOwner, and TRACE.

TGo4AnalysisStep::TGo4AnalysisStep (  const char *  name,
TGo4EventFactory *  eventfactory,
TGo4EventSourceParameter *  sourcetype = 0,
TGo4EventStoreParameter *  storetype = 0,
TGo4EventProcessorParameter *  processortype = 0
) 
 

Normal ctor.

Note: factory and parameter objects are adopted by analysis step, i.e. they are deleted by dtor.

Definition at line 41 of file TGo4AnalysisStep.cxx.

References fxEventFactory, fxOwner, fxStoreType, TGo4Analysis::Instance(), SetStatusMessage(), and TRACE.

TGo4AnalysisStep::~TGo4AnalysisStep (   )  [virtual]
 

Definition at line 78 of file TGo4AnalysisStep.cxx.

References Close(), fxEventFactory, fxOwner, fxProcessorType, fxSourceType, fxStoreType, and TRACE.

Member Function Documentation

void TGo4AnalysisStep::SetEventSource (  TGo4EventSourceParameter *  kind  ) 
 

Sets the event source parameter which is used on intitialization of this step.

The event source will not yet be created; Creation is done by InitEventClasses() method, or by calling the NewEventSource() method on the fly.

Definition at line 587 of file TGo4AnalysisStep.cxx.

References fxSourceType.

Referenced by NewEventSource(), and SetStatus().

void TGo4AnalysisStep::NewEventSource (  TGo4EventSourceParameter *  kind  ) 
 

For lazy initialization of event source.

Uses the CreateEventSource method of the specialized event factory. Is called from init eventclasse in the timer initialization of the analysis, or may called on the fly to switch the source from event server to file. Parameter is passed to factory method for user specification of source.

Definition at line 345 of file TGo4AnalysisStep.cxx.

References TGo4Analysis::AddEventSource(), CloseEventSource(), TGo4EventFactory::CreateEventSource(), fbSourceEnabled, fbSourceImplemented, fxEventFactory, fxEventSource, fxInputEvent, fxOwner, fxPrevious, GetEventStoreName(), TGo4EventElement::Init(), TGo4Analysis::Instance(), IsStoreEnabled(), SetEventSource(), TGo4EventElement::SetEventSource(), SetStatusMessage(), and TRACE.

Referenced by InitEventClasses(), and TGo4AnalysisStepManager::NewStepSource().

void TGo4AnalysisStep::CloseEventSource (   ) 
 

Unregister and close eventsource, if existing.

Definition at line 190 of file TGo4AnalysisStep.cxx.

References fbSourceImplemented, fxEventSource, fxOwner, TGo4Analysis::RemoveEventSource(), and TRACE.

Referenced by Close(), and NewEventSource().

void TGo4AnalysisStep::SetEventStore (  TGo4EventStoreParameter *  kind  ) 
 

Sets the event storee parameter which is used on intitialization of this step.

The event store will not yet be created; Creation is done by InitEventClasses() method, or by calling the NewEventStore() method on the fly.

Definition at line 597 of file TGo4AnalysisStep.cxx.

References fxStoreType.

Referenced by NewEventStore(), and SetStatus().

void TGo4AnalysisStep::NewEventStore (  TGo4EventStoreParameter *  kind  ) 
 

For lazy initialization of event store.

Uses the CreateEventStore method of the specialized event factory. Is called from initeventclasses in the timer initialization of the analysis, or may called on the fly to switch the store. Parameter is passed to factory method for user specification of store.

Definition at line 415 of file TGo4AnalysisStep.cxx.

References TGo4Analysis::AddEventStore(), TGo4Analysis::AddTree(), CloseEventStore(), TGo4EventFactory::CreateEventStore(), fbStoreEnabled, fbStoreImplemented, fxEventFactory, fxEventStore, fxOwner, TGo4EventStore::GetTree(), TGo4Analysis::Instance(), SetEventStore(), SetStatusMessage(), and TRACE.

Referenced by InitEventClasses(), and TGo4AnalysisStepManager::NewStepStore().

void TGo4AnalysisStep::CloseEventStore (   ) 
 

Unregister and close eventstore, if existing.

Definition at line 175 of file TGo4AnalysisStep.cxx.

References fbStoreImplemented, fxEventStore, fxOwner, TGo4EventStore::GetTree(), TGo4Analysis::RemoveEventStore(), TGo4Analysis::RemoveTree(), and TRACE.

Referenced by Close(), and NewEventStore().

void TGo4AnalysisStep::SetEventProcessor (  TGo4EventProcessorParameter *  kind  ) 
 

Sets the event processor parameter which is used on intitialization of this step.

The event processor will not yet be created; Creation is done by InitEventClasses() method, or by calling the NewEventProcessor() method on the fly.

Definition at line 577 of file TGo4AnalysisStep.cxx.

References fxProcessorType.

Referenced by NewEventProcessor(), and SetStatus().

void TGo4AnalysisStep::NewEventProcessor (  TGo4EventProcessorParameter *  kind  ) 
 

For lazy initialization of event processor.

Uses the CreateEventProcessor method of the specialized event factory. Is called from initeventclasses in the timer initialization of the analysis, or may called on the fly to switch the processing algorithm. Parameter is passed to factory method for user specification of processor.

Definition at line 461 of file TGo4AnalysisStep.cxx.

References TGo4Analysis::AddEventProcessor(), CloseEventProcessor(), TGo4EventFactory::CreateEventProcessor(), fxEventFactory, fxEventProcessor, fxInputEvent, fxOutputEvent, fxOwner, TGo4EventElement::Init(), TGo4Analysis::Instance(), SetEventProcessor(), TGo4EventElement::SetEventSource(), and TRACE.

Referenced by InitEventClasses(), and TGo4AnalysisStepManager::NewStepProcessor().

void TGo4AnalysisStep::CloseEventProcessor (   ) 
 

Unregister and close eventprocessor, if existing.

Definition at line 202 of file TGo4AnalysisStep.cxx.

References fxEventProcessor, fxOwner, TGo4Analysis::RemoveEventProcessor(), and TRACE.

Referenced by Close(), and NewEventProcessor().

void TGo4AnalysisStep::NewInputEvent (   ) 
 

create input event object

Definition at line 518 of file TGo4AnalysisStep.cxx.

References TGo4Analysis::AddEventStructure(), TGo4EventFactory::CreateInputEvent(), DeleteInputEvent(), fxEventFactory, fxEventSource, fxInputEvent, fxOwner, TGo4EventElement::Init(), TGo4Analysis::Instance(), TGo4EventElement::SetEventSource(), and TRACE.

Referenced by InitEventClasses().

void TGo4AnalysisStep::DeleteInputEvent (   ) 
 

Delete input event object.

Definition at line 213 of file TGo4AnalysisStep.cxx.

References fxInputEvent, fxOwner, TGo4Analysis::RemoveEventStructure(), and TRACE.

Referenced by Close(), and NewInputEvent().

void TGo4AnalysisStep::NewOutputEvent (   ) 
 

create input event object

Definition at line 538 of file TGo4AnalysisStep.cxx.

References TGo4Analysis::AddEventStructure(), TGo4EventFactory::CreateOutputEvent(), DeleteOutputEvent(), fxEventFactory, fxEventProcessor, fxOutputEvent, fxOwner, TGo4EventElement::Init(), TGo4Analysis::Instance(), TGo4EventElement::SetEventSource(), and TRACE.

Referenced by InitEventClasses().

void TGo4AnalysisStep::DeleteOutputEvent (   ) 
 

Delete input event object.

Definition at line 224 of file TGo4AnalysisStep.cxx.

References fxOutputEvent, fxOwner, TGo4Analysis::RemoveEventStructure(), and TRACE.

Referenced by Close(), and NewOutputEvent().

void TGo4AnalysisStep::InitEventClasses (   )  [virtual]
 

Initialization of the event class plugins which are delivered from the user defined event factory.

Parameters are ids for the implementation kind

Definition at line 98 of file TGo4AnalysisStep.cxx.

References fbProcessEnabled, fxProcessorType, fxSourceType, fxStoreType, NewEventProcessor(), NewEventSource(), NewEventStore(), NewInputEvent(), NewOutputEvent(), and TRACE.

Referenced by TGo4AnalysisStepManager::InitEventClasses().

void TGo4AnalysisStep::SetSourceEnabled (  Bool_t  on = kTRUE  )  [inline]
 

Enables or disables the event source.

Definition at line 143 of file TGo4AnalysisStep.h.

References fbSourceEnabled.

Referenced by TGo4AnalysisStepManager::ProcessAnalysisSteps(), SetStatus(), TMeshAnalysis::TMeshAnalysis(), TXXXAnalysis::TXXXAnalysis(), TYYYAnalysis::TYYYAnalysis(), and TMeshParameter::UpdateFrom().

void TGo4AnalysisStep::SetStoreEnabled (  Bool_t  on = kTRUE  )  [inline]
 

Enables or disables the event store.

Definition at line 146 of file TGo4AnalysisStep.h.

References fbStoreEnabled.

Referenced by SetStatus(), TGo4AnalysisStepManager::SetStepStorage(), TMeshAnalysis::TMeshAnalysis(), TXXXAnalysis::TXXXAnalysis(), and TYYYAnalysis::TYYYAnalysis().

void TGo4AnalysisStep::SetProcessEnabled (  Bool_t  on = kTRUE  )  [inline]
 

Enables or disables the event processing.

Definition at line 149 of file TGo4AnalysisStep.h.

References fbProcessEnabled.

Referenced by SetStatus(), TMeshAnalysis::TMeshAnalysis(), TXXXAnalysis::TXXXAnalysis(), TYYYAnalysis::TYYYAnalysis(), and TMeshParameter::UpdateFrom().

void TGo4AnalysisStep::SetErrorStopEnabled (  Bool_t  on  )  [inline]
 

Enables or disables the stop-on-error mode.

Definition at line 152 of file TGo4AnalysisStep.h.

References fbErrorStopEnabled.

Referenced by SetStatus(), TXXXAnalysis::TXXXAnalysis(), and TYYYAnalysis::TYYYAnalysis().

void TGo4AnalysisStep::ResetErrorStop (   )  [inline]
 

Reset the stopped-after-error state of this analysis step object.

May be used to restart analysis after clearing the situation.

Definition at line 157 of file TGo4AnalysisStep.h.

References fbErrorStopped.

void TGo4AnalysisStep::SetInputEvent (  TGo4EventElement *  in  )  [inline]
 

Sets reference to external input event.

The processor will use this input event at the next call of process. I this analysis step is the first in the chain, the input event will be taken from the event source of this step.

Definition at line 163 of file TGo4AnalysisStep.h.

References fxInputEvent.

void TGo4AnalysisStep::SetPreviousStep (  TGo4AnalysisStep *  pre  )  [inline]
 

Sets reference to previous analysis step.

Definition at line 166 of file TGo4AnalysisStep.h.

References fxPrevious.

TGo4AnalysisStep* TGo4AnalysisStep::GetPreviousStep (   )  [inline]
 

Get previous analysis step.

Returns 0 if there is none.

Definition at line 169 of file TGo4AnalysisStep.h.

References fxPrevious.

TGo4EventElement* TGo4AnalysisStep::GetOutputEvent (   )  [inline]
 

Access to the output event which has been filled last.

Is used to pass the output to the next analysis step, or to the main analysis user event function.

Definition at line 174 of file TGo4AnalysisStep.h.

References fxOutputEvent.

Referenced by TGo4AnalysisStepManager::GetOutputEvent(), and IsMatchingPrevious().

TGo4EventElement* TGo4AnalysisStep::GetInputEvent (   )  [inline]
 

Access to the input event of this step.

Useful to pass incoming event from event source to a subsequent step or to user event function, without processing it.

Definition at line 180 of file TGo4AnalysisStep.h.

References fxInputEvent.

TGo4EventProcessor* TGo4AnalysisStep::GetEventProcessor (   )  [inline]
 

Access to the event processor.

Useful if processor has own data to be displayed, e.g. histograms.

Definition at line 184 of file TGo4AnalysisStep.h.

References fxEventProcessor.

Referenced by TGo4AnalysisStepManager::GetInputEvent().

TGo4EventFactory* TGo4AnalysisStep::GetStepFactory (   )  [inline]
 

Access to step factory.

Useful in setup macros

Definition at line 188 of file TGo4AnalysisStep.h.

References fxEventFactory.

Bool_t TGo4AnalysisStep::IsStoreEnabled (   )  [inline]
 

Definition at line 190 of file TGo4AnalysisStep.h.

References fbStoreEnabled.

Referenced by NewEventSource().

Bool_t TGo4AnalysisStep::IsStoreImplemented (   )  [inline]
 

Definition at line 192 of file TGo4AnalysisStep.h.

References fbStoreImplemented.

Bool_t TGo4AnalysisStep::IsSourceImplemented (   )  [inline]
 

Definition at line 194 of file TGo4AnalysisStep.h.

References fbSourceImplemented.

Referenced by TGo4AnalysisStepManager::ProcessAnalysisSteps().

Bool_t TGo4AnalysisStep::IsSourceEnabled (   )  [inline]
 

Definition at line 196 of file TGo4AnalysisStep.h.

References fbSourceEnabled.

Bool_t TGo4AnalysisStep::IsProcessEnabled (   )  [inline]
 

Definition at line 198 of file TGo4AnalysisStep.h.

References fbProcessEnabled.

Referenced by TGo4AnalysisStepManager::InitEventClasses(), and IsMatchingPrevious().

Bool_t TGo4AnalysisStep::IsErrorStopped (   )  [inline]
 

True if analsis step has been stopped on error.

Definition at line 201 of file TGo4AnalysisStep.h.

References fbErrorStopped.

Bool_t TGo4AnalysisStep::IsErrorStopEnabled (   )  [inline]
 

True if analsis step allows stop on error.

Definition at line 204 of file TGo4AnalysisStep.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStepManager::IsErrorStopEnabled().

Int_t TGo4AnalysisStep::GetProcessStatus (   )  [inline]
 

Status of the last event.

Definition at line 207 of file TGo4AnalysisStep.h.

References fiProcessStatus.

Referenced by TGo4AnalysisStepException::TGo4AnalysisStepException().

const char* TGo4AnalysisStep::GetStatusMessage (   )  [inline]
 

Status message of last Process() call.

Definition at line 210 of file TGo4AnalysisStep.h.

References fcBuffer, and fcStatusMessage.

Referenced by TGo4AnalysisStepException::TGo4AnalysisStepException().

void TGo4AnalysisStep::SetStatusMessage (  const char *  txt  )  [inline]
 

Set Status message of last Process() call.

Definition at line 213 of file TGo4AnalysisStep.h.

References fcStatusMessage.

Referenced by NewEventSource(), NewEventStore(), Process(), TGo4AnalysisStepManager::ProcessAnalysisSteps(), and TGo4AnalysisStep().

Bool_t TGo4AnalysisStep::IsMatchingPrevious (   ) 
 

Check if an analysis step is matching as a previous step to this step.

Will compare by the classnames of input and output events as created by the event factory. To be used at the end of InitEventClasses method of analysis to ensure that chain of analysis steps would be working.

Definition at line 297 of file TGo4AnalysisStep.cxx.

References fxInputEvent, fxPrevious, GetOutputEvent(), IsProcessEnabled(), and TRACE.

Referenced by TGo4AnalysisStepManager::InitEventClasses().

const char * TGo4AnalysisStep::GetEventStoreName (   ) 
 

Access to name of currently active event store.

Used to avoid collisions between store and source (files) of subsequent steps. Returns 0 pointer if there is no store implemented.

Definition at line 332 of file TGo4AnalysisStep.cxx.

References fxEventStore, and TRACE.

Referenced by NewEventSource().

const char * TGo4AnalysisStep::GetEventSourceName (   ) 
 

Access to name of currently active event source.

in case of listmode list, this should give currently open file!

Definition at line 339 of file TGo4AnalysisStep.cxx.

References fxEventSource, and TGo4EventSource::GetActiveName().

Referenced by TGo4AnalysisClient::UpdateStatus().

void TGo4AnalysisStep::StoreCalibration (   ) 
 

Store the current calibration object of the event processor into the event store instance.

Definition at line 237 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, fxEventProcessor, fxEventStore, TGo4EventProcessor::GetCalibration(), TGo4EventStore::Store(), and TRACE.

Referenced by TGo4AnalysisStepManager::AutoSave().

Int_t TGo4AnalysisStep::Store (  TGo4Parameter *  cali  ) 
 

Saves a parameter correllated with the current event into the storage.

Definition at line 261 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, fxEventStore, and TGo4EventStore::Store().

Referenced by TGo4AnalysisStepManager::Store().

Int_t TGo4AnalysisStep::Store (  TGo4Condition *  conny  ) 
 

Saves a condition correllated with the current event into the storage.

Definition at line 269 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, fxEventStore, and TGo4EventStore::Store().

Int_t TGo4AnalysisStep::Store (  TGo4Fitter *  fitter  ) 
 

Saves a fitter correllated with the current event into the storage.

Definition at line 278 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, fxEventStore, and TGo4EventStore::Store().

Int_t TGo4AnalysisStep::Store (  TFolder *  fold  ) 
 

Saves a folder correllated with the current event into the storage.

Definition at line 287 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, fxEventStore, and TGo4EventStore::Store().

void TGo4AnalysisStep::Process (   ) 
 

The main analysis action which is invoked by the external go4 analysis.

Reads input event from source (if first step), fills the output event by means of the event processor, and stores the output event (if last step).

Definition at line 112 of file TGo4AnalysisStep.cxx.

References fbProcessEnabled, fbSourceEnabled, fbStoreEnabled, TGo4EventElement::Fill(), fiProcessStatus, fxEventProcessor, fxEventSource, fxEventStore, fxInputEvent, fxOutputEvent, fxOwner, TGo4Analysis::GetOutputEvent(), TGo4EventElement::SetEventSource(), TGo4EventProcessor::SetInputEvent(), TGo4Analysis::SetOutputEvent(), SetStatusMessage(), TGo4EventStore::Store(), and TRACE.

Referenced by TGo4AnalysisStepManager::ProcessAnalysisSteps().

void TGo4AnalysisStep::Close (   ) 
 

Closes the analysis step.

Closes all files and connections and frees memory.

Definition at line 165 of file TGo4AnalysisStep.cxx.

References CloseEventProcessor(), CloseEventSource(), CloseEventStore(), DeleteInputEvent(), DeleteOutputEvent(), and TRACE.

Referenced by TGo4AnalysisStepManager::CloseAnalysis(), and ~TGo4AnalysisStep().

void TGo4AnalysisStep::SetStatus (  TGo4AnalysisStepStatus *  state  ) 
 

Set all analysis step parameters to that of given status object.

Definition at line 559 of file TGo4AnalysisStep.cxx.

References fbErrorStopped, fiProcessStatus, TGo4AnalysisStepStatus::GetProcessorPar(), TGo4AnalysisStepStatus::GetSourcePar(), TGo4AnalysisStepStatus::GetStorePar(), TGo4AnalysisStepStatus::IsErrorStopEnabled(), TGo4AnalysisStepStatus::IsProcessEnabled(), TGo4AnalysisStepStatus::IsSourceEnabled(), TGo4AnalysisStepStatus::IsStoreEnabled(), SetErrorStopEnabled(), SetEventProcessor(), SetEventSource(), SetEventStore(), SetProcessEnabled(), SetSourceEnabled(), SetStoreEnabled(), and TRACE.

Referenced by TGo4AnalysisStepManager::SetStatus().

TGo4AnalysisStepStatus * TGo4AnalysisStep::CreateStatus (   ) 
 

Create a copy of the analysis step internal state.

To be sent to the Display.

Definition at line 489 of file TGo4AnalysisStep.cxx.

References fbErrorStopEnabled, fbErrorStopped, fbProcessEnabled, fbSourceEnabled, fbStoreEnabled, fiProcessStatus, fxProcessorType, fxSourceType, fxStoreType, TGo4AnalysisStepStatus::SetErrorStopEnabled(), TGo4AnalysisStepStatus::SetErrorStopped(), TGo4AnalysisStepStatus::SetProcessEnabled(), TGo4AnalysisStepStatus::SetProcessorPar(), TGo4AnalysisStepStatus::SetProcessStatus(), TGo4AnalysisStepStatus::SetSourceEnabled(), TGo4AnalysisStepStatus::SetSourcePar(), TGo4AnalysisStepStatus::SetStoreEnabled(), TGo4AnalysisStepStatus::SetStorePar(), and TRACE.

Referenced by TGo4AnalysisStepManager::UpdateStatus().

Member Data Documentation

TGo4Analysis* TGo4AnalysisStep::fxOwner [private]
 

Points back to the analysis wich keeps this step.

Definition at line 265 of file TGo4AnalysisStep.h.

Referenced by CloseEventProcessor(), CloseEventSource(), CloseEventStore(), DeleteInputEvent(), DeleteOutputEvent(), NewEventProcessor(), NewEventSource(), NewEventStore(), NewInputEvent(), NewOutputEvent(), Process(), TGo4AnalysisStep(), and ~TGo4AnalysisStep().

TGo4AnalysisStep* TGo4AnalysisStep::fxPrevious [private]
 

Points to the previous analysis step.

Useful to check the corresponding input and output event types, and the event source state.

Definition at line 269 of file TGo4AnalysisStep.h.

Referenced by GetPreviousStep(), IsMatchingPrevious(), NewEventSource(), and SetPreviousStep().

TGo4EventFactory* TGo4AnalysisStep::fxEventFactory [private]
 

The abstract factory implementation which provides the event classes.

1

Definition at line 274 of file TGo4AnalysisStep.h.

Referenced by GetStepFactory(), NewEventProcessor(), NewEventSource(), NewEventStore(), NewInputEvent(), NewOutputEvent(), TGo4AnalysisStep(), and ~TGo4AnalysisStep().

TGo4EventStore* TGo4AnalysisStep::fxEventStore [private]
 

The storage instance for the unpacked events (detector) structures.

1

Definition at line 279 of file TGo4AnalysisStep.h.

Referenced by CloseEventStore(), GetEventStoreName(), NewEventStore(), Process(), Store(), and StoreCalibration().

TGo4EventSource* TGo4AnalysisStep::fxEventSource [private]
 

The source of the input events.

Can be a remote event server, or a root file, or anything else. 1

Definition at line 285 of file TGo4AnalysisStep.h.

Referenced by CloseEventSource(), GetEventSourceName(), NewEventSource(), NewInputEvent(), and Process().

TGo4EventProcessor* TGo4AnalysisStep::fxEventProcessor [private]
 

The processing class which works on the input event and fills the output event.

1

Definition at line 291 of file TGo4AnalysisStep.h.

Referenced by CloseEventProcessor(), GetEventProcessor(), NewEventProcessor(), NewOutputEvent(), Process(), and StoreCalibration().

TGo4EventElement* TGo4AnalysisStep::fxInputEvent [private]
 

points to the last input event delivered from the event source 1

Definition at line 296 of file TGo4AnalysisStep.h.

Referenced by DeleteInputEvent(), GetInputEvent(), IsMatchingPrevious(), NewEventProcessor(), NewEventSource(), NewInputEvent(), Process(), and SetInputEvent().

TGo4EventElement* TGo4AnalysisStep::fxOutputEvent [private]
 

The unpacked event (detector) structure that has been filled by the analysis step .

1

Definition at line 302 of file TGo4AnalysisStep.h.

Referenced by DeleteOutputEvent(), GetOutputEvent(), NewEventProcessor(), NewOutputEvent(), and Process().

TGo4EventSourceParameter* TGo4AnalysisStep::fxSourceType [private]
 

Parameter object of next event source to be activated.

Is used by eventfactory as parameter for factory method. Meaning is defined in actual user event factory.

Definition at line 308 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), InitEventClasses(), SetEventSource(), and ~TGo4AnalysisStep().

TGo4EventStoreParameter* TGo4AnalysisStep::fxStoreType [private]
 

Parameter object of next event storage to be activated.

Is used by eventfactory as parameter for factory method. Meaning is defined in actual user event factory.

Definition at line 314 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), InitEventClasses(), SetEventStore(), TGo4AnalysisStep(), and ~TGo4AnalysisStep().

TGo4EventProcessorParameter* TGo4AnalysisStep::fxProcessorType [private]
 

Parameter object of next event processor to be activated.

Is used by eventfactory as parameter for factory method. Meaning is defined in actual user event factory.

Definition at line 320 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), InitEventClasses(), SetEventProcessor(), and ~TGo4AnalysisStep().

Bool_t TGo4AnalysisStep::fbSourceEnabled [private]
 

Enables event source.If true, the event source is used to get the input event; otherwise we use the output of the previous step.

Definition at line 325 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), IsSourceEnabled(), NewEventSource(), Process(), and SetSourceEnabled().

Bool_t TGo4AnalysisStep::fbSourceImplemented [private]
 

Flag for the previous analysis step.

If true, the event source instance exists, i.e. a file may be open. Usage is optional so far.

Definition at line 329 of file TGo4AnalysisStep.h.

Referenced by CloseEventSource(), IsSourceImplemented(), and NewEventSource().

Bool_t TGo4AnalysisStep::fbStoreEnabled [private]
 

Enables event store.

If true, the event store is used as output; otherwise we pass the output to the next step.

Definition at line 334 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), IsStoreEnabled(), NewEventStore(), Process(), SetStoreEnabled(), Store(), and StoreCalibration().

Bool_t TGo4AnalysisStep::fbStoreImplemented [private]
 

Flag for the subsequent analysis step.

If true, the event store instance exists, i.e. a file may be open.

Definition at line 338 of file TGo4AnalysisStep.h.

Referenced by CloseEventStore(), IsStoreImplemented(), and NewEventStore().

Bool_t TGo4AnalysisStep::fbProcessEnabled [private]
 

Enables processing of the input event.

If true, Process method produces an output event from the input; otherwise we do not fill the output. Useful if event source of this step shall be used to pass the input event to another analysis step. If process is disabled, also the eventstore is disabled.

Definition at line 345 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), InitEventClasses(), IsProcessEnabled(), Process(), and SetProcessEnabled().

Bool_t TGo4AnalysisStep::fbErrorStopEnabled [private]
 

Operation mode switch.

If true, the analysis step process method will stop the analysis if the event source returns an error code. Otherwise, the event source may be reset then and the analysis continues from start.

Definition at line 352 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), IsErrorStopEnabled(), and SetErrorStopEnabled().

Bool_t TGo4AnalysisStep::fbErrorStopped [private]
 

True if the analysis step has been stopped after input error.

Definition at line 355 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), IsErrorStopped(), ResetErrorStop(), and SetStatus().

Int_t TGo4AnalysisStep::fiProcessStatus [private]
 

Contains current analysis step status value.

To be checked by framework after Process().

Definition at line 358 of file TGo4AnalysisStep.h.

Referenced by CreateStatus(), GetProcessStatus(), Process(), and SetStatus().

TString TGo4AnalysisStep::fcStatusMessage [private]
 

Most recent status message.

May be delivered by eventsource or eventstore.

Definition at line 361 of file TGo4AnalysisStep.h.

Referenced by GetStatusMessage(), and SetStatusMessage().

TString TGo4AnalysisStep::fcBuffer [private]
 

Buffer string for text output.

Definition at line 364 of file TGo4AnalysisStep.h.

Referenced by GetStatusMessage().

The documentation for this class was generated from the following files:
Generated on Fri Nov 28 13:00:24 2008 for Go4-v3.04-1 by  doxygen 1.4.2