Status object of one analysis step. More...

#include <TGo4AnalysisStepStatus.h>

Inheritance diagram for TGo4AnalysisStepStatus:

Public Member Functions
	TGo4AnalysisStepStatus ()

	TGo4AnalysisStepStatus (const char *name)

virtual	~TGo4AnalysisStepStatus ()

TGo4EventProcessorParameter *	GetProcessorPar () const
	Returns the event processor parameter which was put into this status object.

Int_t	GetProcessStatus () const
	Returns status value of processor.

TGo4EventSourceParameter *	GetSourcePar () const
	Returns the event source parameter which was put into this status object.

TGo4EventStoreParameter *	GetStorePar () const
	Returns the event store parameter which was put into this status object.

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

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

Bool_t	IsProcessEnabled () const

Bool_t	IsSourceEnabled () const

Bool_t	IsStoreEnabled () const

void	Print (Option_t *opt="") const override

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

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

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

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

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

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

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

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

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

TGo4EventSourceParameter *	TakeSourcePar ()
	Removes source parameter from the step and return it back to the user User is responsible to cleanup this object.

Public Member Functions inherited from TGo4Status
	TGo4Status ()

	TGo4Status (const char *name)

	TGo4Status (const char name, const char title)

virtual	~TGo4Status ()

void	Print (Option_t *opt="") const override

virtual Int_t	PrintStatus (Text_t *buffer=nullptr, Int_t buflen=0)
	DEPRECATED - please use Print(Option_t *) signature basic method to printout status information on stdout; to be overridden by specific subclass.

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	fbStoreEnabled {kFALSE}
	Enables event store.

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

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.

Additional Inherited Members
Public Types inherited from TGo4Status
enum	{ kGo4NoReset = BIT(20) , kGo4CanDelete = BIT(21) , kGo4BackStoreReset = BIT(22) }
	Go4 status bits to be used in object manager to suppress resetting or deleting histograms, etc. More...

Static Public Member Functions inherited from TGo4Status
static Text_t *	PrintBuffer (char buffer, Int_t &buflen, const char text,...)
	Print text with variable expression into buffer.

static Text_t *	PrintIndent (Text_t *buffer, Int_t &buflen)
	Insert indentation blanks into text buffer.

static void	PrintLine (const char *text,...)
	Print single line of debug output with appropriate indent.

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.

References TGo4Status::TGo4Status().

◆ TGo4AnalysisStepStatus() [2/2]

TGo4AnalysisStepStatus::TGo4AnalysisStepStatus ( const char * name )

Definition at line 25 of file TGo4AnalysisStepStatus.cxx.

References TGo4Status::TGo4Status(), and 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.

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

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

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

◆ 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(), and TGo4AnalysisStep::SetStatus().

◆ IsSourceEnabled()

Bool_t TGo4AnalysisStepStatus::IsSourceEnabled ( ) const

inline

Definition at line 70 of file TGo4AnalysisStepStatus.h.

References fbSourceEnabled.

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

◆ IsStoreEnabled()

Bool_t TGo4AnalysisStepStatus::IsStoreEnabled ( ) const

inline

Definition at line 74 of file TGo4AnalysisStepStatus.h.

References fbStoreEnabled.

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

◆ Print()

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

override

Definition at line 39 of file TGo4AnalysisStepStatus.cxx.

References 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(), and TGo4AnalysisStep::CreateStatus().

◆ 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().

◆ 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(), and TGo4AnalysisStep::CreateStatus().

◆ 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 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(), and TGo4AnalysisStep::CreateStatus().

◆ 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(), TGo4Interface::StepBackStore(), TGo4Interface::StepFileStore(), and TGo4Interface::StepUserStore().

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

Field 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 ~TGo4AnalysisStepStatus(), GetProcessorPar(), and SetProcessorPar().

◆ 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 ~TGo4AnalysisStepStatus(), GetSourcePar(), SetSourcePar(), and TakeSourcePar().

◆ 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 ~TGo4AnalysisStepStatus(), GetStorePar(), and SetStorePar().

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

Go4StatusAnalysis/TGo4AnalysisStepStatus.h
Go4StatusAnalysis/TGo4AnalysisStepStatus.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TGo4AnalysisStepStatus() [1/2]

◆ TGo4AnalysisStepStatus() [2/2]

◆ ~TGo4AnalysisStepStatus()

Member Function Documentation

◆ GetProcessorPar()

◆ GetProcessStatus()

◆ GetSourcePar()

◆ GetStorePar()

◆ IsErrorStopEnabled()

◆ IsErrorStopped()

◆ IsProcessEnabled()

◆ IsSourceEnabled()

◆ IsStoreEnabled()

◆ Print()

◆ SetErrorStopEnabled()

◆ SetErrorStopped()

◆ SetProcessEnabled()

◆ SetProcessorPar()

◆ SetProcessStatus()

◆ SetSourceEnabled()

◆ SetSourcePar()

◆ SetStoreEnabled()

◆ SetStorePar()

◆ TakeSourcePar()

Field Documentation

◆ fbErrorStopEnabled

◆ fbErrorStopped

◆ fbProcessEnabled

◆ fbSourceEnabled

◆ fbStoreEnabled

◆ fiProcessStatus

◆ fxProcessorType

◆ fxSourceType

◆ fxStoreType