Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

TGo4AnalysisStepStatus Class Reference

Status object of one analysis step. More...

#include <TGo4AnalysisStepStatus.h>

Inheritance diagram for TGo4AnalysisStepStatus:

TGo4Status List of all members.

Public Methods

 TGo4AnalysisStepStatus ()
 default ctor for streamer. More...

 TGo4AnalysisStepStatus (const char *name)
virtual ~TGo4AnalysisStepStatus ()
virtual Int_t PrintStatus (Text_t *buffer=0, Int_t buflen=0)
 basic method to printout status information on stdout; to be overridden by specific subclass. More...

void SetSourcePar (TGo4EventSourceParameter *kind)
 Sets the event source parameter which is used on intitialization of this step. More...

TGo4EventSourceParameterGetSourcePar () const
 Returns the event source parameter which was put into this status object. More...

void SetStorePar (TGo4EventStoreParameter *kind)
 Sets the event store parameter which is used on intitialization of this step. More...

TGo4EventStoreParameterGetStorePar () const
 Returns the event store parameter which was put into this status object. More...

void SetProcessorPar (TGo4EventProcessorParameter *kind)
 Sets the event processor parameter which is used on intitialization of this step. More...

TGo4EventProcessorParameterGetProcessorPar () const
 Returns the event processor parameter which was put into this status object. More...

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

Int_t IsSourceEnabled () const
void SetStoreEnabled (Bool_t on=kTRUE)
 Enables or disables the event store. More...

Int_t IsStoreEnabled () const
void SetProcessEnabled (Bool_t on=kTRUE)
 Enables or disables the event processing. More...

Int_t IsProcessEnabled () const
void SetErrorStopEnabled (Bool_t on=kTRUE)
 Enables or disables the stop-on-error mode. More...

Int_t IsErrorStopEnabled () const
 True if analysis step shall stop on error. More...

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

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

void SetProcessStatus (Int_t val)
 Sets status value of processor, user defined. More...

Int_t GetProcessStatus () const
 Returns status value of processor. More...


Private Attributes

TGo4EventSourceParameterfxSourceType
 Parameter object of next event source to be activated. More...

TGo4EventStoreParameterfxStoreType
 Parameter object of next event storage to be activated. More...

TGo4EventProcessorParameterfxProcessorType
 Parameter object of next event processor to be activated. More...

Int_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. More...

Int_t fbStoreEnabled
 Enables event store. More...

Int_t fbProcessEnabled
 Enables processing of the input event. More...

Int_t fbErrorStopEnabled
 Operation mode switch. More...

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

Int_t fiProcessStatus
 Contains current analysis step status value. More...


Friends

class TGo4Analysis

Detailed Description

Status object of one analysis step.

Will be aggregated in analysis status.

Since:
1/2001

Definition at line 31 of file TGo4AnalysisStepStatus.h.


Constructor & Destructor Documentation

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus   [inline]
 

default ctor for streamer.

Definition at line 37 of file TGo4AnalysisStepStatus.h.

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus const char *    name
 

Definition at line 24 of file TGo4AnalysisStepStatus.cxx.

References TRACE.

TGo4AnalysisStepStatus::~TGo4AnalysisStepStatus   [virtual]
 

Definition at line 33 of file TGo4AnalysisStepStatus.cxx.

References fxProcessorType, fxSourceType, fxStoreType, and TRACE.


Member Function Documentation

Int_t TGo4AnalysisStepStatus::PrintStatus Text_t *    buffer = 0,
Int_t    buflen = 0
[virtual]
 

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

Reimplemented from TGo4Status.

Definition at line 41 of file TGo4AnalysisStepStatus.cxx.

References GetProcessorPar(), GetProcessStatus(), GetSourcePar(), GetStorePar(), IsProcessEnabled(), IsSourceEnabled(), IsStoreEnabled(), TGo4Status::PrintBuffer(), TGo4Status::PrintIndent(), TGo4EventStoreParameter::PrintParameter(), TGo4EventProcessorParameter::PrintParameter(), TGo4EventSourceParameter::PrintParameter(), and TRACE.

Referenced by TGo4AnalysisStatus::PrintStatus().

void TGo4AnalysisStepStatus::SetSourcePar TGo4EventSourceParameter   kind
 

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

Definition at line 144 of file TGo4AnalysisStepStatus.cxx.

References fxSourceType.

Referenced by TGo4AnalysisStep::CreateStatus().

TGo4EventSourceParameter* TGo4AnalysisStepStatus::GetSourcePar   const [inline]
 

Returns the event source parameter which was put into this status object.

Definition at line 53 of file TGo4AnalysisStepStatus.h.

References fxSourceType.

Referenced by PrintStatus(), and TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetStorePar TGo4EventStoreParameter   kind
 

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

Definition at line 153 of file TGo4AnalysisStepStatus.cxx.

References fxStoreType.

Referenced by TGo4AnalysisStep::CreateStatus().

TGo4EventStoreParameter* TGo4AnalysisStepStatus::GetStorePar   const [inline]
 

Returns the event store parameter which was put into this status object.

Definition at line 61 of file TGo4AnalysisStepStatus.h.

References fxStoreType.

Referenced by PrintStatus(), and TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetProcessorPar TGo4EventProcessorParameter   kind
 

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

Definition at line 162 of file TGo4AnalysisStepStatus.cxx.

References fxProcessorType.

Referenced by TGo4AnalysisStep::CreateStatus().

TGo4EventProcessorParameter* TGo4AnalysisStepStatus::GetProcessorPar   const [inline]
 

Returns the event processor parameter which was put into this status object.

Definition at line 69 of file TGo4AnalysisStepStatus.h.

References fxProcessorType.

Referenced by PrintStatus(), and TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetSourceEnabled Bool_t    on = kTRUE [inline]
 

Enables or disables the event source.

Definition at line 72 of file TGo4AnalysisStepStatus.h.

References fbSourceEnabled.

Referenced by TGo4AnalysisStep::CreateStatus().

Int_t TGo4AnalysisStepStatus::IsSourceEnabled   const [inline]
 

Definition at line 73 of file TGo4AnalysisStepStatus.h.

References fbSourceEnabled.

Referenced by PrintStatus(), and TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetStoreEnabled Bool_t    on = kTRUE [inline]
 

Enables or disables the event store.

Definition at line 76 of file TGo4AnalysisStepStatus.h.

References fbStoreEnabled.

Referenced by TGo4AnalysisStep::CreateStatus().

Int_t TGo4AnalysisStepStatus::IsStoreEnabled   const [inline]
 

Definition at line 77 of file TGo4AnalysisStepStatus.h.

References fbStoreEnabled.

Referenced by PrintStatus(), and TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetProcessEnabled Bool_t    on = kTRUE [inline]
 

Enables or disables the event processing.

Definition at line 80 of file TGo4AnalysisStepStatus.h.

References fbProcessEnabled.

Referenced by TGo4AnalysisStep::CreateStatus().

Int_t TGo4AnalysisStepStatus::IsProcessEnabled   const [inline]
 

Definition at line 81 of file TGo4AnalysisStepStatus.h.

References fbProcessEnabled.

Referenced by PrintStatus(), and TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetErrorStopEnabled Bool_t    on = kTRUE [inline]
 

Enables or disables the stop-on-error mode.

Definition at line 84 of file TGo4AnalysisStepStatus.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStep::CreateStatus().

Int_t TGo4AnalysisStepStatus::IsErrorStopEnabled   const [inline]
 

True if analysis step shall stop on error.

Definition at line 87 of file TGo4AnalysisStepStatus.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStep::SetStatus().

void TGo4AnalysisStepStatus::SetErrorStopped Bool_t    on [inline]
 

Enables or disables the stop-on-error mode.

Definition at line 90 of file TGo4AnalysisStepStatus.h.

References fbErrorStopped.

Referenced by TGo4AnalysisStep::CreateStatus().

Int_t TGo4AnalysisStepStatus::IsErrorStopped   const [inline]
 

True if analysis step has been stopped on error.

Definition at line 93 of file TGo4AnalysisStepStatus.h.

References fbErrorStopped.

void TGo4AnalysisStepStatus::SetProcessStatus Int_t    val [inline]
 

Sets status value of processor, user defined.

Definition at line 96 of file TGo4AnalysisStepStatus.h.

References fiProcessStatus.

Referenced by TGo4AnalysisStep::CreateStatus().

Int_t TGo4AnalysisStepStatus::GetProcessStatus   const [inline]
 

Returns status value of processor.

Meaning of value may be user defined.

Definition at line 100 of file TGo4AnalysisStepStatus.h.

References fiProcessStatus.

Referenced by PrintStatus().


Friends And Related Function Documentation

friend class TGo4Analysis [friend]
 

Definition at line 33 of file TGo4AnalysisStepStatus.h.


Member Data Documentation

TGo4EventSourceParameter* TGo4AnalysisStepStatus::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 108 of file TGo4AnalysisStepStatus.h.

Referenced by GetSourcePar(), SetSourcePar(), and ~TGo4AnalysisStepStatus().

TGo4EventStoreParameter* TGo4AnalysisStepStatus::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 114 of file TGo4AnalysisStepStatus.h.

Referenced by GetStorePar(), SetStorePar(), and ~TGo4AnalysisStepStatus().

TGo4EventProcessorParameter* TGo4AnalysisStepStatus::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 120 of file TGo4AnalysisStepStatus.h.

Referenced by GetProcessorPar(), SetProcessorPar(), and ~TGo4AnalysisStepStatus().

Int_t TGo4AnalysisStepStatus::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 125 of file TGo4AnalysisStepStatus.h.

Referenced by IsSourceEnabled(), and SetSourceEnabled().

Int_t TGo4AnalysisStepStatus::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 130 of file TGo4AnalysisStepStatus.h.

Referenced by IsStoreEnabled(), and SetStoreEnabled().

Int_t TGo4AnalysisStepStatus::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 137 of file TGo4AnalysisStepStatus.h.

Referenced by IsProcessEnabled(), and SetProcessEnabled().

Int_t TGo4AnalysisStepStatus::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 144 of file TGo4AnalysisStepStatus.h.

Referenced by IsErrorStopEnabled(), and SetErrorStopEnabled().

Int_t TGo4AnalysisStepStatus::fbErrorStopped [private]
 

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

Definition at line 148 of file TGo4AnalysisStepStatus.h.

Referenced by IsErrorStopped(), and SetErrorStopped().

Int_t TGo4AnalysisStepStatus::fiProcessStatus [private]
 

Contains current analysis step status value.

To be checked by framework after Process().

Definition at line 151 of file TGo4AnalysisStepStatus.h.

Referenced by GetProcessStatus(), and SetProcessStatus().


The documentation for this class was generated from the following files:
Generated on Tue Nov 8 10:56:29 2005 for Go4-v2.10-5 by doxygen1.2.15