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

#include <TGo4AnalysisStepStatus.h>

+ Inheritance diagram for TGo4AnalysisStepStatus:

Public Member Functions

 TGo4AnalysisStepStatus ()
 
 TGo4AnalysisStepStatus (const char *name)
 
virtual ~TGo4AnalysisStepStatus ()
 
virtual Int_t PrintStatus (Text_t *buffer=0, Int_t buflen=0)
 
void SetSourcePar (TGo4EventSourceParameter *kind)
 
TGo4EventSourceParameterGetSourcePar () const
 
TGo4EventSourceParameterTakeSourcePar ()
 
void SetStorePar (TGo4EventStoreParameter *kind)
 
TGo4EventStoreParameterGetStorePar () const
 
void SetProcessorPar (TGo4EventProcessorParameter *kind)
 
TGo4EventProcessorParameterGetProcessorPar () const
 
void SetSourceEnabled (Bool_t on=kTRUE)
 
Bool_t IsSourceEnabled () const
 
void SetStoreEnabled (Bool_t on=kTRUE)
 
Bool_t IsStoreEnabled () const
 
void SetProcessEnabled (Bool_t on=kTRUE)
 
Bool_t IsProcessEnabled () const
 
void SetErrorStopEnabled (Bool_t on=kTRUE)
 
Bool_t IsErrorStopEnabled () const
 
void SetErrorStopped (Bool_t on)
 
Bool_t IsErrorStopped () const
 
void SetProcessStatus (Int_t val)
 
Int_t GetProcessStatus () const
 
- Public Member Functions inherited from TGo4Status
 TGo4Status ()
 
 TGo4Status (const char *name)
 
 TGo4Status (const char *name, const char *title)
 
virtual ~TGo4Status ()
 
virtual void Print (Option_t *dummy="") const
 

Private Attributes

TGo4EventSourceParameterfxSourceType
 
TGo4EventStoreParameterfxStoreType
 
TGo4EventProcessorParameterfxProcessorType
 
Bool_t fbSourceEnabled
 
Bool_t fbStoreEnabled
 
Bool_t fbProcessEnabled
 
Bool_t fbErrorStopEnabled
 
Bool_t fbErrorStopped
 
Int_t fiProcessStatus
 

Additional Inherited Members

- Public Types inherited from TGo4Status
enum  { kGo4NoReset = BIT(20), kGo4CanDelete = BIT(21), kGo4BackStoreReset = BIT(22) }
 
- Static Public Member Functions inherited from TGo4Status
static Text_t * PrintIndent (Text_t *buffer, Int_t &buflen)
 
static Text_t * PrintBuffer (char *buffer, Int_t &buflen, const char *text,...)
 

Detailed Description

Status object of one analysis step. Will be aggregated in analysis status.

Since
1/2001

Definition at line 29 of file TGo4AnalysisStepStatus.h.

Constructor & Destructor Documentation

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus ( )

Definition at line 20 of file TGo4AnalysisStepStatus.cxx.

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus ( const char *  name)

Definition at line 34 of file TGo4AnalysisStepStatus.cxx.

References GO4TRACE.

TGo4AnalysisStepStatus::~TGo4AnalysisStepStatus ( )
virtual

Definition at line 50 of file TGo4AnalysisStepStatus.cxx.

References fxProcessorType, fxSourceType, fxStoreType, and GO4TRACE.

Member Function Documentation

TGo4EventProcessorParameter* TGo4AnalysisStepStatus::GetProcessorPar ( ) const
inline

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

Definition at line 68 of file TGo4AnalysisStepStatus.h.

References fxProcessorType.

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

Int_t TGo4AnalysisStepStatus::GetProcessStatus ( ) const
inline

Returns status value of processor. Meaning of value may be user defined.

Definition at line 97 of file TGo4AnalysisStepStatus.h.

References fiProcessStatus.

Referenced by PrintStatus().

TGo4EventSourceParameter* TGo4AnalysisStepStatus::GetSourcePar ( ) const
inline
TGo4EventStoreParameter* TGo4AnalysisStepStatus::GetStorePar ( ) const
inline
Bool_t TGo4AnalysisStepStatus::IsErrorStopEnabled ( ) const
inline

True if analysis step shall stop on error.

Definition at line 85 of file TGo4AnalysisStepStatus.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStep::SetStatus().

Bool_t TGo4AnalysisStepStatus::IsErrorStopped ( ) const
inline

True if analysis step has been stopped on error.

Definition at line 90 of file TGo4AnalysisStepStatus.h.

References fbErrorStopped.

Bool_t TGo4AnalysisStepStatus::IsProcessEnabled ( ) const
inline
Bool_t TGo4AnalysisStepStatus::IsSourceEnabled ( ) const
inline
Bool_t TGo4AnalysisStepStatus::IsStoreEnabled ( ) const
inline
Int_t TGo4AnalysisStepStatus::PrintStatus ( Text_t *  buffer = 0,
Int_t  buflen = 0 
)
virtual
void TGo4AnalysisStepStatus::SetErrorStopEnabled ( Bool_t  on = kTRUE)
inline

Enables or disables the stop-on-error mode.

Definition at line 83 of file TGo4AnalysisStepStatus.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStep::CreateStatus().

void TGo4AnalysisStepStatus::SetErrorStopped ( Bool_t  on)
inline

Enables or disables the stop-on-error mode.

Definition at line 88 of file TGo4AnalysisStepStatus.h.

References fbErrorStopped.

Referenced by TGo4AnalysisStep::CreateStatus().

void TGo4AnalysisStepStatus::SetProcessEnabled ( Bool_t  on = kTRUE)
inline
void TGo4AnalysisStepStatus::SetProcessorPar ( TGo4EventProcessorParameter kind)

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

Definition at line 183 of file TGo4AnalysisStepStatus.cxx.

References fxProcessorType.

Referenced by TGo4AnalysisStep::CreateStatus().

void TGo4AnalysisStepStatus::SetProcessStatus ( Int_t  val)
inline

Sets status value of processor, user defined.

Definition at line 93 of file TGo4AnalysisStepStatus.h.

References fiProcessStatus.

Referenced by TGo4AnalysisStep::CreateStatus().

void TGo4AnalysisStepStatus::SetSourceEnabled ( Bool_t  on = kTRUE)
inline
void TGo4AnalysisStepStatus::SetSourcePar ( TGo4EventSourceParameter kind)
void TGo4AnalysisStepStatus::SetStoreEnabled ( Bool_t  on = kTRUE)
inline
void TGo4AnalysisStepStatus::SetStorePar ( TGo4EventStoreParameter kind)
TGo4EventSourceParameter * TGo4AnalysisStepStatus::TakeSourcePar ( )

Removes source parameter from the step and return it back to the user User is responsible to cleanup this object

Definition at line 167 of file TGo4AnalysisStepStatus.cxx.

References fxSourceType.

Referenced by TGo4ConfigStep::ChangeSourceParameter().

Member Data Documentation

Bool_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 141 of file TGo4AnalysisStepStatus.h.

Referenced by IsErrorStopEnabled(), and SetErrorStopEnabled().

Bool_t TGo4AnalysisStepStatus::fbErrorStopped
private

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

Definition at line 145 of file TGo4AnalysisStepStatus.h.

Referenced by IsErrorStopped(), and SetErrorStopped().

Bool_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 134 of file TGo4AnalysisStepStatus.h.

Referenced by IsProcessEnabled(), and SetProcessEnabled().

Bool_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 122 of file TGo4AnalysisStepStatus.h.

Referenced by IsSourceEnabled(), and SetSourceEnabled().

Bool_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 127 of file TGo4AnalysisStepStatus.h.

Referenced by IsStoreEnabled(), and SetStoreEnabled().

Int_t TGo4AnalysisStepStatus::fiProcessStatus
private

Contains current analysis step status value. To be checked by framework after Process().

Definition at line 148 of file TGo4AnalysisStepStatus.h.

Referenced by GetProcessStatus(), and SetProcessStatus().

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

Definition at line 117 of file TGo4AnalysisStepStatus.h.

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

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

Definition at line 105 of file TGo4AnalysisStepStatus.h.

Referenced by GetSourcePar(), SetSourcePar(), TakeSourcePar(), 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. aggregation

Definition at line 111 of file TGo4AnalysisStepStatus.h.

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


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