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

#include <TGo4AnalysisStep.h>

Inheritance diagram for TGo4AnalysisStep:

Public Member Functions
	TGo4AnalysisStep ()
	default ctor for streamer.

	TGo4AnalysisStep (const char name, TGo4EventFactory eventfactory, TGo4EventSourceParameter sourcetype=nullptr, TGo4EventStoreParameter storetype=nullptr, TGo4EventProcessorParameter *processortype=nullptr)
	Normal ctor.

virtual	~TGo4AnalysisStep ()

void	Close ()
	Closes the analysis step.

void	CloseEventProcessor ()
	Unregister and close eventprocessor, if existing.

void	CloseEventSource ()
	Unregister and close eventsource, if existing.

void	CloseEventStore ()
	Unregister and close eventstore, if existing.

TGo4AnalysisStepStatus *	CreateStatus ()
	Create a copy of the analysis step internal state.

void	DeleteInputEvent ()
	Delete input event object.

void	DeleteOutputEvent ()
	Delete input event object.

TGo4EventProcessor *	GetEventProcessor () const
	Access to the event processor.

TGo4EventSourceParameter *	GetEventSource () const
	Return current event source parameter.

const char *	GetEventSourceName () const
	Access to name of currently active event source.

TGo4EventStoreParameter *	GetEventStore () const
	Return current event store parameter.

const char *	GetEventStoreName () const
	Access to name of currently active event store.

TGo4EventElement *	GetInputEvent () const
	Access to the input event of this step.

TGo4EventElement *	GetOutputEvent () const
	Access to the output event which has been filled last.

TGo4AnalysisStep *	GetPreviousStep () const
	Get previous analysis step.

Int_t	GetProcessStatus () const
	Status of the last event.

const char *	GetStatusMessage () const
	Status message of last Process() call.

TGo4EventFactory *	GetStepFactory () const
	Access to step factory.

virtual void	InitEventClasses ()
	Initialization of the event class plugins which are delivered from the user defined event factory.

Bool_t	IsErrorStopEnabled () const
	True if analysis step allows stop on error.

Bool_t	IsErrorStopped () const
	True if analysis step has been stopped on error.

Bool_t	IsEventSourceParam () const
	Return kTRUE, if event source parameter specified.

Bool_t	IsEventStoreParam () const
	Return kTRUE, if event store parameter specified.

Bool_t	IsKeepInputEvent () const

Bool_t	IsKeepOutputEvent () const

Bool_t	IsMatchingPrevious () const
	Check if an analysis step is matching as a previous step to this step.

Bool_t	IsProcessEnabled () const

Bool_t	IsSourceEnabled () const

Bool_t	IsSourceImplemented () const

Bool_t	IsStoreEnabled () const

Bool_t	IsStoreImplemented () const

void	NewEventProcessor (TGo4EventProcessorParameter *kind)
	For lazy initialization of event processor.

void	NewEventSource (TGo4EventSourceParameter *kind)
	For lazy initialization of event source.

void	NewEventStore (TGo4EventStoreParameter *kind)
	For lazy initialization of event store.

void	NewInputEvent ()
	create input event object

void	NewOutputEvent ()
	create input event object

void	Process ()
	The main analysis action which is invoked by the external go4 analysis.

void	ResetErrorStop ()
	Reset the stopped-after-error state of this analysis step object.

void	SetErrorStopEnabled (Bool_t on)
	Enables or disables the stop-on-error mode.

void	SetEventProcessor (TGo4EventProcessorParameter *kind)
	Sets the event processor parameter which is used on initialization of this step.

void	SetEventSource (TGo4EventSourceParameter *kind)
	Sets the event source parameter which is used on initialization of this step.

void	SetEventStore (TGo4EventStoreParameter *kind)
	Sets the event store parameter which is used on initialization of this step.

void	SetInputEvent (TGo4EventElement *in)
	Sets reference to external input event.

void	SetPreviousStep (TGo4AnalysisStep *pre)
	Sets reference to previous analysis step.

void	SetProcessEnabled (Bool_t on=kTRUE)
	Enables or disables the event processing.

void	SetSourceEnabled (Bool_t on=kTRUE)
	Enables or disables the event source.

void	SetStatus (TGo4AnalysisStepStatus *state)
	Set all analysis step parameters to that of given status object.

void	SetStatusMessage (const char *txt)
	Set Status message of last Process() call.

void	SetStoreEnabled (Bool_t on=kTRUE)
	Enables or disables the event store.

Int_t	Store (TFolder *fold)
	Saves a folder correlated with the current event into the storage.

Int_t	Store (TGo4Condition *conny)
	Saves a condition correlated with the current event into the storage.

Int_t	Store (TGo4Fitter *fitter)
	Saves a fitter correlated with the current event into the storage.

Int_t	Store (TGo4Parameter *cali)
	Saves a parameter correlated with the current event into the storage.

void	StoreCalibration ()
	Store the current calibration object of the event processor into the event store instance.

Private Attributes
Bool_t	fbErrorStopEnabled {kFALSE}
	Operation mode switch.

Bool_t	fbErrorStopped {kFALSE}
	True if the analysis step has been stopped after input error.

Bool_t	fbProcessEnabled {kFALSE}
	Enables processing of the input event.

Bool_t	fbSourceEnabled {kFALSE}
	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 {kFALSE}
	Flag for the previous analysis step.

Bool_t	fbStoreEnabled {kFALSE}
	Enables event store.

Bool_t	fbStoreImplemented {kFALSE}
	Flag for the subsequent analysis step.

TString	fcStatusMessage
	Most recent status message.

Int_t	fiProcessStatus {0}
	Contains current analysis step status value.

TGo4EventFactory *	fxEventFactory {nullptr}
	The abstract factory implementation which provides the event classes.

TGo4EventProcessor *	fxEventProcessor {nullptr}
	The processing class which works on the input event and fills the output event.

TGo4EventSource *	fxEventSource {nullptr}
	The source of the input events.

TGo4EventStore *	fxEventStore {nullptr}
	The storage instance for the unpacked events (detector) structures.

TGo4EventElement *	fxInputEvent {nullptr}
	points to the last input event delivered from the event source 1 aggregation

TGo4EventElement *	fxOutputEvent {nullptr}
	The unpacked event (detector) structure that has been filled by the analysis step .

TGo4Analysis *	fxOwner {nullptr}
	Points back to the analysis which keeps this step.

TGo4AnalysisStep *	fxPrevious {nullptr}
	Points to the previous analysis step.

TGo4EventProcessorParameter *	fxProcessorType {nullptr}
	Parameter object of next event processor to be activated.

TGo4EventSourceParameter *	fxSourceType {nullptr}
	Parameter object of next event source to be activated.

TGo4EventStoreParameter *	fxStoreType {nullptr}
	Parameter object of next event storage to be activated.

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 60 of file TGo4AnalysisStep.h.

Constructor & Destructor Documentation

◆ TGo4AnalysisStep() [1/2]

TGo4AnalysisStep::TGo4AnalysisStep ( )

default ctor for streamer.

Definition at line 56 of file TGo4AnalysisStep.cxx.

References fbErrorStopEnabled, fbErrorStopped, fbProcessEnabled, fbSourceEnabled, fbSourceImplemented, fbStoreEnabled, fbStoreImplemented, fxEventFactory, fxEventProcessor, fxEventSource, fxEventStore, fxInputEvent, fxOutputEvent, fxOwner, fxPrevious, fxProcessorType, fxSourceType, fxStoreType, and GO4TRACE.

Referenced by GetPreviousStep(), and SetPreviousStep().

◆ TGo4AnalysisStep() [2/2]

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

Normal ctor.

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

Definition at line 35 of file TGo4AnalysisStep.cxx.

References fbErrorStopEnabled, fbErrorStopped, fbProcessEnabled, fbSourceEnabled, fbSourceImplemented, fbStoreEnabled, fbStoreImplemented, fxEventFactory, fxEventProcessor, fxEventSource, fxEventStore, fxInputEvent, fxOutputEvent, fxOwner, fxPrevious, fxProcessorType, fxSourceType, fxStoreType, GO4TRACE, TGo4Analysis::Instance(), and SetStatusMessage().

◆ ~TGo4AnalysisStep()

TGo4AnalysisStep::~TGo4AnalysisStep ( )

virtual

Definition at line 72 of file TGo4AnalysisStep.cxx.

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

Member Function Documentation

◆ Close()

void TGo4AnalysisStep::Close ( )

Closes the analysis step.

Closes all files and connections and frees memory.

Definition at line 142 of file TGo4AnalysisStep.cxx.

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

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

◆ CloseEventProcessor()

void TGo4AnalysisStep::CloseEventProcessor ( )

Unregister and close eventprocessor, if existing.

Definition at line 177 of file TGo4AnalysisStep.cxx.

References fxEventProcessor, fxOwner, and GO4TRACE.

Referenced by Close(), and NewEventProcessor().

◆ CloseEventSource()

void TGo4AnalysisStep::CloseEventSource ( )

Unregister and close eventsource, if existing.

Definition at line 166 of file TGo4AnalysisStep.cxx.

References fbSourceImplemented, fxEventSource, fxOwner, and GO4TRACE.

Referenced by Close(), and NewEventSource().

◆ CloseEventStore()

void TGo4AnalysisStep::CloseEventStore ( )

Unregister and close eventstore, if existing.

Definition at line 152 of file TGo4AnalysisStep.cxx.

References fbStoreImplemented, fxEventStore, fxOwner, and GO4TRACE.

Referenced by Close(), and NewEventStore().

◆ CreateStatus()

TGo4AnalysisStepStatus * TGo4AnalysisStep::CreateStatus ( )

Create a copy of the analysis step internal state.

To be sent to the Display.

Definition at line 380 of file TGo4AnalysisStep.cxx.

◆ DeleteInputEvent()

void TGo4AnalysisStep::DeleteInputEvent ( )

Delete input event object.

Definition at line 187 of file TGo4AnalysisStep.cxx.

References fxInputEvent, fxOwner, and GO4TRACE.

Referenced by Close(), and NewInputEvent().

◆ DeleteOutputEvent()

void TGo4AnalysisStep::DeleteOutputEvent ( )

Delete input event object.

Definition at line 197 of file TGo4AnalysisStep.cxx.

References fxOutputEvent, fxOwner, and GO4TRACE.

Referenced by Close(), and NewOutputEvent().

◆ GetEventProcessor()

TGo4EventProcessor * TGo4AnalysisStep::GetEventProcessor ( ) const

inline

Access to the event processor.

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

Definition at line 196 of file TGo4AnalysisStep.h.

References fxEventProcessor.

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

◆ GetEventSource()

TGo4EventSourceParameter * TGo4AnalysisStep::GetEventSource ( ) const

inline

Return current event source parameter.

Definition at line 93 of file TGo4AnalysisStep.h.

References fxSourceType.

Referenced by main().

◆ GetEventSourceName()

const char * TGo4AnalysisStep::GetEventSourceName ( ) const

Access to name of currently active event source.

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

Definition at line 264 of file TGo4AnalysisStep.cxx.

References fxEventSource.

Referenced by TGo4Analysis::RunImplicitLoop(), and TGo4AnalysisClient::UpdateStatus().

◆ GetEventStore()

TGo4EventStoreParameter * TGo4AnalysisStep::GetEventStore ( ) const

inline

Return current event store parameter.

Definition at line 105 of file TGo4AnalysisStep.h.

References fxStoreType.

Referenced by main().

◆ GetEventStoreName()

const char * TGo4AnalysisStep::GetEventStoreName ( ) const

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 259 of file TGo4AnalysisStep.cxx.

References fxEventStore.

◆ GetInputEvent()

TGo4EventElement * TGo4AnalysisStep::GetInputEvent ( ) const

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 192 of file TGo4AnalysisStep.h.

References fxInputEvent.

◆ GetOutputEvent()

TGo4EventElement * TGo4AnalysisStep::GetOutputEvent ( ) const

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 186 of file TGo4AnalysisStep.h.

References fxOutputEvent.

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

◆ GetPreviousStep()

TGo4AnalysisStep * TGo4AnalysisStep::GetPreviousStep ( ) const

inline

Get previous analysis step.

Returns 0 if there is none.

Definition at line 181 of file TGo4AnalysisStep.h.

References TGo4AnalysisStep(), and fxPrevious.

◆ GetProcessStatus()

Int_t TGo4AnalysisStep::GetProcessStatus ( ) const

inline

Status of the last event.

Definition at line 223 of file TGo4AnalysisStep.h.

References fiProcessStatus.

◆ GetStatusMessage()

const char * TGo4AnalysisStep::GetStatusMessage ( ) const

inline

Status message of last Process() call.

Definition at line 226 of file TGo4AnalysisStep.h.

References fcStatusMessage.

◆ GetStepFactory()

TGo4EventFactory * TGo4AnalysisStep::GetStepFactory ( ) const

inline

Access to step factory.

Useful in setup macros

Definition at line 200 of file TGo4AnalysisStep.h.

References fxEventFactory.

◆ InitEventClasses()

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 84 of file TGo4AnalysisStep.cxx.

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

Referenced by TGo4AnalysisStepManager::InitEventClasses().

◆ IsErrorStopEnabled()

Bool_t TGo4AnalysisStep::IsErrorStopEnabled ( ) const

inline

True if analysis step allows stop on error.

Definition at line 220 of file TGo4AnalysisStep.h.

References fbErrorStopEnabled.

◆ IsErrorStopped()

Bool_t TGo4AnalysisStep::IsErrorStopped ( ) const

inline

True if analysis step has been stopped on error.

Definition at line 217 of file TGo4AnalysisStep.h.

References fbErrorStopped.

◆ IsEventSourceParam()

Bool_t TGo4AnalysisStep::IsEventSourceParam ( ) const

Return kTRUE, if event source parameter specified.

Definition at line 474 of file TGo4AnalysisStep.cxx.

References fxSourceType.

◆ IsEventStoreParam()

Bool_t TGo4AnalysisStep::IsEventStoreParam ( ) const

Return kTRUE, if event store parameter specified.

Definition at line 494 of file TGo4AnalysisStep.cxx.

References fxStoreType.

◆ IsKeepInputEvent()

Bool_t TGo4AnalysisStep::IsKeepInputEvent ( ) const

inline

Definition at line 212 of file TGo4AnalysisStep.h.

References fxEventProcessor.

◆ IsKeepOutputEvent()

Bool_t TGo4AnalysisStep::IsKeepOutputEvent ( ) const

inline

Definition at line 214 of file TGo4AnalysisStep.h.

References fxEventProcessor.

◆ IsMatchingPrevious()

Bool_t TGo4AnalysisStep::IsMatchingPrevious ( ) const

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 246 of file TGo4AnalysisStep.cxx.

References fxInputEvent, fxPrevious, GO4TRACE, and IsProcessEnabled().

Referenced by TGo4AnalysisStepManager::InitEventClasses().

◆ IsProcessEnabled()

Bool_t TGo4AnalysisStep::IsProcessEnabled ( ) const

inline

Definition at line 210 of file TGo4AnalysisStep.h.

References fbProcessEnabled.

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

◆ IsSourceEnabled()

Bool_t TGo4AnalysisStep::IsSourceEnabled ( ) const

inline

Definition at line 208 of file TGo4AnalysisStep.h.

References fbSourceEnabled.

◆ IsSourceImplemented()

Bool_t TGo4AnalysisStep::IsSourceImplemented ( ) const

inline

Definition at line 206 of file TGo4AnalysisStep.h.

References fbSourceImplemented.

◆ IsStoreEnabled()

Bool_t TGo4AnalysisStep::IsStoreEnabled ( ) const

inline

Definition at line 202 of file TGo4AnalysisStep.h.

References fbStoreEnabled.

◆ IsStoreImplemented()

Bool_t TGo4AnalysisStep::IsStoreImplemented ( ) const

inline

Definition at line 204 of file TGo4AnalysisStep.h.

References fbStoreImplemented.

◆ NewEventProcessor()

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 358 of file TGo4AnalysisStep.cxx.

References CloseEventProcessor(), fxEventFactory, fxEventProcessor, fxInputEvent, fxOutputEvent, fxOwner, GO4TRACE, TGo4Analysis::Instance(), TGo4Analysis::Message(), and SetEventProcessor().

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

◆ NewEventSource()

void TGo4AnalysisStep::NewEventSource ( TGo4EventSourceParameter * kind )

For lazy initialization of event source.

Uses the CreateEventSource method of the specialized event factory. Is called from init eventclass 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 269 of file TGo4AnalysisStep.cxx.

References CloseEventSource(), fbSourceEnabled, fbSourceImplemented, fxEventFactory, fxEventSource, fxInputEvent, fxOwner, fxPrevious, GO4TRACE, TGo4Analysis::Instance(), TGo4Analysis::Message(), SetEventSource(), and SetStatusMessage().

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

◆ NewEventStore()

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 322 of file TGo4AnalysisStep.cxx.

References CloseEventStore(), fbStoreEnabled, fbStoreImplemented, fxEventFactory, fxEventStore, fxOwner, GO4TRACE, TGo4Analysis::Instance(), TGo4Analysis::Message(), SetEventStore(), and SetStatusMessage().

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

◆ NewInputEvent()

void TGo4AnalysisStep::NewInputEvent ( )

create input event object

Definition at line 405 of file TGo4AnalysisStep.cxx.

References DeleteInputEvent(), fxEventFactory, fxEventSource, fxInputEvent, fxOwner, GO4TRACE, TGo4Analysis::Instance(), and TGo4Analysis::Message().

Referenced by InitEventClasses().

◆ NewOutputEvent()

void TGo4AnalysisStep::NewOutputEvent ( )

create input event object

Definition at line 421 of file TGo4AnalysisStep.cxx.

References DeleteOutputEvent(), fxEventFactory, fxEventProcessor, fxOutputEvent, fxOwner, GO4TRACE, TGo4Analysis::Instance(), and TGo4Analysis::Message().

Referenced by InitEventClasses().

◆ Process()

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 97 of file TGo4AnalysisStep.cxx.

References fbProcessEnabled, fbSourceEnabled, fbStoreEnabled, fiProcessStatus, fxEventProcessor, fxEventSource, fxEventStore, fxInputEvent, fxOutputEvent, fxOwner, GO4TRACE, and SetStatusMessage().

◆ ResetErrorStop()

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 169 of file TGo4AnalysisStep.h.

References fbErrorStopped.

◆ SetErrorStopEnabled()

void TGo4AnalysisStep::SetErrorStopEnabled ( Bool_t on )

inline

Enables or disables the stop-on-error mode.

Definition at line 164 of file TGo4AnalysisStep.h.

References fbErrorStopEnabled.

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

◆ SetEventProcessor()

void TGo4AnalysisStep::SetEventProcessor ( TGo4EventProcessorParameter * kind )

Sets the event processor parameter which is used on initialization 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 454 of file TGo4AnalysisStep.cxx.

References fxProcessorType.

Referenced by NewEventProcessor(), and SetStatus().

◆ SetEventSource()

void TGo4AnalysisStep::SetEventSource ( TGo4EventSourceParameter * kind )

Sets the event source parameter which is used on initialization 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 464 of file TGo4AnalysisStep.cxx.

References fxSourceType.

Referenced by main(), NewEventSource(), and SetStatus().

◆ SetEventStore()

void TGo4AnalysisStep::SetEventStore ( TGo4EventStoreParameter * kind )

Sets the event store parameter which is used on initialization 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 479 of file TGo4AnalysisStep.cxx.

References fxStoreType.

Referenced by main(), NewEventStore(), and SetStatus().

◆ SetInputEvent()

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 175 of file TGo4AnalysisStep.h.

References fxInputEvent.

◆ SetPreviousStep()

void TGo4AnalysisStep::SetPreviousStep ( TGo4AnalysisStep * pre )

inline

Sets reference to previous analysis step.

Definition at line 178 of file TGo4AnalysisStep.h.

References TGo4AnalysisStep(), and fxPrevious.

Referenced by TGo4AnalysisStepManager::AddAnalysisStep().

◆ SetProcessEnabled()

void TGo4AnalysisStep::SetProcessEnabled ( Bool_t on = kTRUE )

inline

Enables or disables the event processing.

Definition at line 161 of file TGo4AnalysisStep.h.

References fbProcessEnabled.

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

◆ SetSourceEnabled()

void TGo4AnalysisStep::SetSourceEnabled ( Bool_t on = kTRUE )

inline

Enables or disables the event source.

Definition at line 155 of file TGo4AnalysisStep.h.

References fbSourceEnabled.

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

◆ SetStatus()

void TGo4AnalysisStep::SetStatus ( TGo4AnalysisStepStatus * state )

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

Definition at line 438 of file TGo4AnalysisStep.cxx.

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

◆ SetStatusMessage()

void TGo4AnalysisStep::SetStatusMessage ( const char * txt )

inline

Set Status message of last Process() call.

Definition at line 229 of file TGo4AnalysisStep.h.

References fcStatusMessage.

Referenced by TGo4AnalysisStep(), NewEventSource(), NewEventStore(), and Process().

◆ SetStoreEnabled()

void TGo4AnalysisStep::SetStoreEnabled ( Bool_t on = kTRUE )

inline

Enables or disables the event store.

Definition at line 158 of file TGo4AnalysisStep.h.

References fbStoreEnabled.

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

◆ Store() [1/4]

Int_t TGo4AnalysisStep::Store ( TFolder * fold )

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

Definition at line 238 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, and fxEventStore.

◆ Store() [2/4]

Int_t TGo4AnalysisStep::Store ( TGo4Condition * conny )

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

Definition at line 224 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, and fxEventStore.

◆ Store() [3/4]

Int_t TGo4AnalysisStep::Store ( TGo4Fitter * fitter )

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

Definition at line 231 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, and fxEventStore.

◆ Store() [4/4]

Int_t TGo4AnalysisStep::Store ( TGo4Parameter * cali )

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

Definition at line 217 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, and fxEventStore.

Referenced by TGo4AnalysisStepManager::Store(), TGo4AnalysisStepManager::Store(), TGo4AnalysisStepManager::Store(), and TGo4AnalysisStepManager::Store().

◆ StoreCalibration()

void TGo4AnalysisStep::StoreCalibration ( )

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

Definition at line 207 of file TGo4AnalysisStep.cxx.

References fbStoreEnabled, fxEventProcessor, fxEventStore, and GO4TRACE.

Referenced by TGo4AnalysisStepManager::AutoSave().

Field Documentation

◆ fbErrorStopEnabled

Bool_t TGo4AnalysisStep::fbErrorStopEnabled {kFALSE}

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 368 of file TGo4AnalysisStep.h.

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

◆ fbErrorStopped

Bool_t TGo4AnalysisStep::fbErrorStopped {kFALSE}

private

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

Definition at line 371 of file TGo4AnalysisStep.h.

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

◆ fbProcessEnabled

Bool_t TGo4AnalysisStep::fbProcessEnabled {kFALSE}

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 361 of file TGo4AnalysisStep.h.

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

◆ fbSourceEnabled

Bool_t TGo4AnalysisStep::fbSourceEnabled {kFALSE}

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 341 of file TGo4AnalysisStep.h.

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

◆ fbSourceImplemented

Bool_t TGo4AnalysisStep::fbSourceImplemented {kFALSE}

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 345 of file TGo4AnalysisStep.h.

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

◆ fbStoreEnabled

Bool_t TGo4AnalysisStep::fbStoreEnabled {kFALSE}

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 350 of file TGo4AnalysisStep.h.

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

◆ fbStoreImplemented

Bool_t TGo4AnalysisStep::fbStoreImplemented {kFALSE}

private

Flag for the subsequent analysis step.

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

Definition at line 354 of file TGo4AnalysisStep.h.

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

◆ fcStatusMessage

TString TGo4AnalysisStep::fcStatusMessage

private

Most recent status message.

May be delivered by eventsource or eventstore.

Definition at line 377 of file TGo4AnalysisStep.h.

Referenced by GetStatusMessage(), and SetStatusMessage().

◆ fiProcessStatus

Int_t TGo4AnalysisStep::fiProcessStatus {0}

private

Contains current analysis step status value.

To be checked by framework after Process().

Definition at line 374 of file TGo4AnalysisStep.h.

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

◆ fxEventFactory

TGo4EventFactory* TGo4AnalysisStep::fxEventFactory {nullptr}

private

The abstract factory implementation which provides the event classes.

aggregationByValue 1

Definition at line 290 of file TGo4AnalysisStep.h.

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

◆ fxEventProcessor

TGo4EventProcessor* TGo4AnalysisStep::fxEventProcessor {nullptr}

private

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

aggregation 1

Definition at line 307 of file TGo4AnalysisStep.h.

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

◆ fxEventSource

TGo4EventSource* TGo4AnalysisStep::fxEventSource {nullptr}

private

The source of the input events.

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

Definition at line 301 of file TGo4AnalysisStep.h.

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

◆ fxEventStore

TGo4EventStore* TGo4AnalysisStep::fxEventStore {nullptr}

private

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

aggregation 1

Definition at line 295 of file TGo4AnalysisStep.h.

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

◆ fxInputEvent

TGo4EventElement* TGo4AnalysisStep::fxInputEvent {nullptr}

private

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

Definition at line 312 of file TGo4AnalysisStep.h.

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

◆ fxOutputEvent

TGo4EventElement* TGo4AnalysisStep::fxOutputEvent {nullptr}

private

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

1 aggregation

Definition at line 318 of file TGo4AnalysisStep.h.

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

◆ fxOwner

TGo4Analysis* TGo4AnalysisStep::fxOwner {nullptr}

private

Points back to the analysis which keeps this step.

Definition at line 281 of file TGo4AnalysisStep.h.

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

◆ fxPrevious

TGo4AnalysisStep* TGo4AnalysisStep::fxPrevious {nullptr}

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 285 of file TGo4AnalysisStep.h.

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

◆ fxProcessorType

TGo4EventProcessorParameter* TGo4AnalysisStep::fxProcessorType {nullptr}

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. aggregation

Definition at line 336 of file TGo4AnalysisStep.h.

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

◆ fxSourceType

TGo4EventSourceParameter* TGo4AnalysisStep::fxSourceType {nullptr}

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. aggregation

Definition at line 324 of file TGo4AnalysisStep.h.

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

◆ fxStoreType

TGo4EventStoreParameter* TGo4AnalysisStep::fxStoreType {nullptr}

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. aggregation

Definition at line 330 of file TGo4AnalysisStep.h.

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

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

Go4Analysis/TGo4AnalysisStep.h
Go4Analysis/TGo4AnalysisStep.cxx

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TGo4AnalysisStep() [1/2]

◆ TGo4AnalysisStep() [2/2]

◆ ~TGo4AnalysisStep()

Member Function Documentation

◆ Close()

◆ CloseEventProcessor()

◆ CloseEventSource()

◆ CloseEventStore()

◆ CreateStatus()

◆ DeleteInputEvent()

◆ DeleteOutputEvent()

◆ GetEventProcessor()

◆ GetEventSource()

◆ GetEventSourceName()

◆ GetEventStore()

◆ GetEventStoreName()

◆ GetInputEvent()

◆ GetOutputEvent()

◆ GetPreviousStep()

◆ GetProcessStatus()

◆ GetStatusMessage()

◆ GetStepFactory()

◆ InitEventClasses()

◆ IsErrorStopEnabled()

◆ IsErrorStopped()

◆ IsEventSourceParam()

◆ IsEventStoreParam()

◆ IsKeepInputEvent()

◆ IsKeepOutputEvent()

◆ IsMatchingPrevious()

◆ IsProcessEnabled()

◆ IsSourceEnabled()

◆ IsSourceImplemented()

◆ IsStoreEnabled()

◆ IsStoreImplemented()

◆ NewEventProcessor()

◆ NewEventSource()

◆ NewEventStore()

◆ NewInputEvent()

◆ NewOutputEvent()

◆ Process()

◆ ResetErrorStop()

◆ SetErrorStopEnabled()

◆ SetEventProcessor()

◆ SetEventSource()

◆ SetEventStore()

◆ SetInputEvent()

◆ SetPreviousStep()

◆ SetProcessEnabled()

◆ SetSourceEnabled()

◆ SetStatus()

◆ SetStatusMessage()

◆ SetStoreEnabled()

◆ Store() [1/4]

◆ Store() [2/4]

◆ Store() [3/4]

◆ Store() [4/4]

◆ StoreCalibration()

Field Documentation

◆ fbErrorStopEnabled

◆ fbErrorStopped

◆ fbProcessEnabled

◆ fbSourceEnabled

◆ fbSourceImplemented

◆ fbStoreEnabled

◆ fbStoreImplemented

◆ fcStatusMessage

◆ fiProcessStatus

◆ fxEventFactory

◆ fxEventProcessor

◆ fxEventSource

◆ fxEventStore

◆ fxInputEvent

◆ fxOutputEvent

◆ fxOwner

◆ fxPrevious