TGo4AnalysisStepStatus Class Reference

#include <TGo4AnalysisStepStatus.h>

Inheritance diagram for TGo4AnalysisStepStatus:

Public Member Functions
	TGo4AnalysisStepStatus ()
	TGo4AnalysisStepStatus (const char *name)
virtual	~TGo4AnalysisStepStatus ()
void	Print (Option_t *opt="") const override
void	SetSourcePar (TGo4EventSourceParameter *kind)
TGo4EventSourceParameter *	GetSourcePar () const
TGo4EventSourceParameter *	TakeSourcePar ()
void	SetStorePar (TGo4EventStoreParameter *kind)
TGo4EventStoreParameter *	GetStorePar () const
void	SetProcessorPar (TGo4EventProcessorParameter *kind)
TGo4EventProcessorParameter *	GetProcessorPar () 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 Int_t	PrintStatus (Text_t *buffer=nullptr, Int_t buflen=0)
void	Print (Option_t *opt="") const override

Private Attributes
TGo4EventSourceParameter *	fxSourceType {nullptr}
TGo4EventStoreParameter *	fxStoreType {nullptr}
TGo4EventProcessorParameter *	fxProcessorType {nullptr}
Bool_t	fbSourceEnabled {kFALSE}
Bool_t	fbStoreEnabled {kFALSE}
Bool_t	fbProcessEnabled {kFALSE}
Bool_t	fbErrorStopEnabled {kFALSE}
Bool_t	fbErrorStopped {kFALSE}
Int_t	fiProcessStatus {0}

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,...)
static void	PrintLine (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() [1/2]

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus

(

)

Definition at line 20 of file TGo4AnalysisStepStatus.cxx.

TGo4AnalysisStepStatus() [2/2]

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus

(

const char *

name

)

Definition at line 25 of file TGo4AnalysisStepStatus.cxx.

References GO4TRACE.

~TGo4AnalysisStepStatus()

TGo4AnalysisStepStatus::~TGo4AnalysisStepStatus ( )

virtual

Definition at line 31 of file TGo4AnalysisStepStatus.cxx.

References fxProcessorType, fxSourceType, fxStoreType, and GO4TRACE.

Member Function Documentation

GetProcessorPar()

TGo4EventProcessorParameter* TGo4AnalysisStepStatus::GetProcessorPar ( ) const

inline

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

Definition at line 66 of file TGo4AnalysisStepStatus.h.

References fxProcessorType.

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

GetProcessStatus()

Int_t TGo4AnalysisStepStatus::GetProcessStatus ( ) const

inline

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

Definition at line 95 of file TGo4AnalysisStepStatus.h.

References fiProcessStatus.

Referenced by Print().

GetSourcePar()

TGo4EventSourceParameter* TGo4AnalysisStepStatus::GetSourcePar ( ) const

inline

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

Definition at line 46 of file TGo4AnalysisStepStatus.h.

References fxSourceType, SetStorePar(), and TakeSourcePar().

Referenced by TGo4ConfigStep::ChangeEventInterval(), TGo4ConfigStep::ChangeSourceTimeout(), TGo4ConfigStep::ChangeStartEvent(), TGo4ConfigStep::ChangeStopEvent(), TGo4ConfigStep::CurrentSourceKind(), TGo4ConfigStep::GetSourceSetup(), TGo4ConfigStep::InputArguments(), TGo4ConfigStep::InputFileDialog(), TGo4ConfigStep::InputPortChanged(), TGo4ConfigStep::InputSourceText(), TGo4ConfigStep::InputTagfile(), Print(), TGo4ConfigStep::RetryCntChanged(), TGo4AnalysisStep::SetStatus(), and TGo4ConfigStep::SourceComboHighlighted().

GetStorePar()

TGo4EventStoreParameter* TGo4AnalysisStepStatus::GetStorePar ( ) const

inline

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

Definition at line 58 of file TGo4AnalysisStepStatus.h.

References fxStoreType, and SetProcessorPar().

Referenced by TGo4ConfigStep::OutputFileDialog(), TGo4ConfigStep::OutputNameText(), Print(), TGo4AnalysisStep::SetStatus(), TGo4ConfigStep::SetStepStatus(), TGo4ConfigStep::StoreBufferSize(), TGo4ConfigStep::StoreCompLevel(), TGo4ConfigStep::StoreOverWrite(), TGo4ConfigStep::StoreSplitLevel(), and TGo4ConfigStep::StoreTreeAutoSave().

IsErrorStopEnabled()

Bool_t TGo4AnalysisStepStatus::IsErrorStopEnabled ( ) const

inline

True if analysis step shall stop on error.

Definition at line 83 of file TGo4AnalysisStepStatus.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStep::SetStatus().

IsErrorStopped()

Bool_t TGo4AnalysisStepStatus::IsErrorStopped ( ) const

inline

True if analysis step has been stopped on error.

Definition at line 88 of file TGo4AnalysisStepStatus.h.

References fbErrorStopped.

IsProcessEnabled()

Bool_t TGo4AnalysisStepStatus::IsProcessEnabled ( ) const

inline

Definition at line 78 of file TGo4AnalysisStepStatus.h.

References fbProcessEnabled.

Referenced by Print(), TGo4AnalysisStep::SetStatus(), and TGo4ConfigStep::SetStepStatus().

IsSourceEnabled()

Bool_t TGo4AnalysisStepStatus::IsSourceEnabled ( ) const

inline

Definition at line 70 of file TGo4AnalysisStepStatus.h.

References fbSourceEnabled.

Referenced by Print(), TGo4AnalysisStep::SetStatus(), and TGo4ConfigStep::SetStepStatus().

IsStoreEnabled()

Bool_t TGo4AnalysisStepStatus::IsStoreEnabled ( ) const

inline

Definition at line 74 of file TGo4AnalysisStepStatus.h.

References fbStoreEnabled.

Referenced by Print(), TGo4AnalysisStep::SetStatus(), and TGo4ConfigStep::SetStepStatus().

Print()

void TGo4AnalysisStepStatus::Print ( Option_t *  opt = "" ) const

override

Definition at line 39 of file TGo4AnalysisStepStatus.cxx.

References TGo4Analysis::GetName(), GetProcessorPar(), GetProcessStatus(), GetSourcePar(), GetStorePar(), IsProcessEnabled(), IsSourceEnabled(), IsStoreEnabled(), and TGo4Status::PrintLine().

SetErrorStopEnabled()

void TGo4AnalysisStepStatus::SetErrorStopEnabled ( Bool_t  on = kTRUE )

inline

Enables or disables the stop-on-error mode.

Definition at line 81 of file TGo4AnalysisStepStatus.h.

References fbErrorStopEnabled.

Referenced by TGo4AnalysisStep::CreateStatus().

SetErrorStopped()

void TGo4AnalysisStepStatus::SetErrorStopped ( Bool_t  on )

inline

Enables or disables the stop-on-error mode.

Definition at line 86 of file TGo4AnalysisStepStatus.h.

References fbErrorStopped.

Referenced by TGo4AnalysisStep::CreateStatus().

SetProcessEnabled()

void TGo4AnalysisStepStatus::SetProcessEnabled ( Bool_t  on = kTRUE )

inline

Enables or disables the event processing.

Definition at line 77 of file TGo4AnalysisStepStatus.h.

References fbProcessEnabled.

Referenced by TGo4Interface::ConfigStep(), TGo4AnalysisStep::CreateStatus(), and TGo4ConfigStep::StepStateChanged().

SetProcessorPar()

void TGo4AnalysisStepStatus::SetProcessorPar

(

TGo4EventProcessorParameter *

kind

)

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

Definition at line 100 of file TGo4AnalysisStepStatus.cxx.

References fxProcessorType.

Referenced by TGo4AnalysisStep::CreateStatus(), and GetStorePar().

SetProcessStatus()

void TGo4AnalysisStepStatus::SetProcessStatus ( Int_t  val )

inline

Sets status value of processor, user defined.

Definition at line 91 of file TGo4AnalysisStepStatus.h.

References fiProcessStatus.

Referenced by TGo4AnalysisStep::CreateStatus().

SetSourceEnabled()

void TGo4AnalysisStepStatus::SetSourceEnabled ( Bool_t  on = kTRUE )

inline

Enables or disables the event source.

Definition at line 69 of file TGo4AnalysisStepStatus.h.

References fbSourceEnabled.

Referenced by TGo4Interface::ConfigStep(), TGo4AnalysisStep::CreateStatus(), and TGo4ConfigStep::InputStateChanged().

SetSourcePar()

void TGo4AnalysisStepStatus::SetSourcePar

(

TGo4EventSourceParameter *

kind

)

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

Definition at line 75 of file TGo4AnalysisStepStatus.cxx.

References fxSourceType.

Referenced by TGo4ConfigStep::ChangeSourceParameter(), TGo4AnalysisStep::CreateStatus(), TGo4Interface::StepFileSource(), TGo4Interface::StepMbsEventServerSource(), TGo4Interface::StepMbsFileSource(), TGo4Interface::StepMbsRevServSource(), TGo4Interface::StepMbsStreamSource(), TGo4Interface::StepMbsTransportSource(), TGo4Interface::StepRandomSource(), and TGo4Interface::StepUserSource().

SetStoreEnabled()

void TGo4AnalysisStepStatus::SetStoreEnabled ( Bool_t  on = kTRUE )

inline

Enables or disables the event store.

Definition at line 73 of file TGo4AnalysisStepStatus.h.

References fbStoreEnabled.

Referenced by TGo4Interface::ConfigStep(), TGo4AnalysisStep::CreateStatus(), and TGo4ConfigStep::OutputStateChanged().

SetStorePar()

void TGo4AnalysisStepStatus::SetStorePar

(

TGo4EventStoreParameter *

kind

)

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

Definition at line 91 of file TGo4AnalysisStepStatus.cxx.

References fxStoreType.

Referenced by TGo4AnalysisStep::CreateStatus(), GetSourcePar(), TGo4Interface::StepBackStore(), TGo4Interface::StepFileStore(), TGo4Interface::StepUserStore(), and TGo4ConfigStep::StoreComboHighlighted().

TakeSourcePar()

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

References fxSourceType.

Referenced by TGo4ConfigStep::ChangeSourceParameter(), and GetSourcePar().

Member Data Documentation

fbErrorStopEnabled

Bool_t TGo4AnalysisStepStatus::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 139 of file TGo4AnalysisStepStatus.h.

Referenced by IsErrorStopEnabled(), and SetErrorStopEnabled().

fbErrorStopped

Bool_t TGo4AnalysisStepStatus::fbErrorStopped {kFALSE}

private

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

Definition at line 143 of file TGo4AnalysisStepStatus.h.

Referenced by IsErrorStopped(), and SetErrorStopped().

fbProcessEnabled

Bool_t TGo4AnalysisStepStatus::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 132 of file TGo4AnalysisStepStatus.h.

Referenced by IsProcessEnabled(), and SetProcessEnabled().

fbSourceEnabled

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

Referenced by IsSourceEnabled(), and SetSourceEnabled().

fbStoreEnabled

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

Referenced by IsStoreEnabled(), and SetStoreEnabled().

fiProcessStatus

Int_t TGo4AnalysisStepStatus::fiProcessStatus {0}

private

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

Definition at line 146 of file TGo4AnalysisStepStatus.h.

Referenced by GetProcessStatus(), and SetProcessStatus().

fxProcessorType

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

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

fxSourceType

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

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

fxStoreType

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

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

---

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

• Go4StatusAnalysis/TGo4AnalysisStepStatus.h
• Go4StatusAnalysis/TGo4AnalysisStepStatus.cxx