TGo4ComGetCurrentEvent Class Reference

Requests the current event as a sample from the client. More...

#include <TGo4ComGetCurrentEvent.h>

Inheritance diagram for TGo4ComGetCurrentEvent:

Public Member Functions
	TGo4ComGetCurrentEvent ()
	TGo4ComGetCurrentEvent (const char *obname)
Int_t	ExeCom () override
	Do the command action.
Bool_t	IsOutputEvent () const
Bool_t	IsPrintoutOnly () const
Bool_t	IsTreeMode () const
void	Set (TGo4RemoteCommand *remcon) override
	Set internals of this command from specification of external remote command (command container).
void	SetOutputEvent (Bool_t output=kTRUE)
void	SetPrintoutOnly (Bool_t on=kTRUE)
void	SetTreeMode (Bool_t on=kTRUE)
Public Member Functions inherited from TGo4AnalysisObjectCommand
	TGo4AnalysisObjectCommand ()
	TGo4AnalysisObjectCommand (const char *comname, const char *description, const char *obname)
const char *	GetFolderName () const
const char *	GetObjectName () const
	access to the object name under command.
void	SetFolderName (const char *name)
void	SetObjectName (const char *name)
	set the object name under command.
Public Member Functions inherited from TGo4AnalysisCommand
	TGo4AnalysisCommand ()
	TGo4AnalysisCommand (const char *name, const char *desc)
Int_t	RefuseCom () override
	Optional action if command is not allowed (warning message e.g.)
Public Member Functions inherited from TGo4Command
	TGo4Command ()
	TGo4Command (const char *name, const char *description, Int_t id)
virtual	~TGo4Command ()
Int_t	GetCommandID () const
Go4CommandMode_t	GetMode () const
Go4CommandMode_t	GetProtection () const
const char *	GetReceiverName () const
const char *	GetTaskName () const
virtual void	Help ()
Bool_t	IsEnabled () const
Bool_t	IsExclusive () const
Bool_t	IsLocal () const
Bool_t	IsSynchron () const
virtual Bool_t	Log (Int_t mode=0)
void	SetDescription (const char *)
void	SetMode (Go4CommandMode_t m)
virtual void	SetReceiver (TGo4CommandReceiver *rec)
void	SetReceiverName (const char *)
void	SetTaskName (const char *)
const char *	What () const

Private Attributes
Bool_t	fbOutputEvent
	If true output event is searched, otherwise input event of step.
Bool_t	fbPrintoutOnly
	If true, the event will not be sent but content is shown on analysis terminal.
Bool_t	fbTreeMode
	If true, event will be put into tree before showing; otherwise use PrintEvent method or send event directly.

Additional Inherited Members
Static Public Member Functions inherited from TGo4Command
static const char *	GetModeDescription (Go4CommandMode_t mode)
	text description of current execution mode
Protected Member Functions inherited from TGo4Command
void	SetProtection (Go4CommandMode_t m)
Protected Attributes inherited from TGo4Command
Bool_t	fbIsEnabled {kFALSE}
Bool_t	fbIsExclusive {kFALSE}
Bool_t	fbIsLocal {kFALSE}
Bool_t	fbIsSynchron {kFALSE}
Int_t	fiCommandID {0}
Go4CommandMode_t	fiMode {kGo4ComModeRefused}
	mode value for execution rights of sending task
Go4CommandMode_t	fiProtection {kGo4ComModeRefused}
	Execute protection of this command.
Int_t	fiVersion {0}
TGo4CommandReceiver *	fxReceiverBase {nullptr}
Static Protected Attributes inherited from TGo4Command
static const char *	fgcMODEDESCRIPTION []
	resolve description of command modes here

Detailed Description

Requests the current event as a sample from the client.

Object name is name of the analysis step that owns the event. By default, the output event of that step is taken. If no such analysis step, the event is searched by name in the eventstructure folder. Event will be filled in a temporary tree that is send to the gui. Any user event display may apply this command.

Author

J. Adamczewski

Since

02-Jul-2002

Definition at line 31 of file TGo4ComGetCurrentEvent.h.

Constructor & Destructor Documentation

TGo4ComGetCurrentEvent() [1/2]

TGo4ComGetCurrentEvent::TGo4ComGetCurrentEvent

(

)

Definition at line 35 of file TGo4ComGetCurrentEvent.cxx.

References TGo4AnalysisObjectCommand::TGo4AnalysisObjectCommand(), fbOutputEvent, fbPrintoutOnly, fbTreeMode, GO4TRACE, and TGo4Command::SetReceiverName().

TGo4ComGetCurrentEvent() [2/2]

TGo4ComGetCurrentEvent::TGo4ComGetCurrentEvent

(

const char *

obname

)

Definition at line 24 of file TGo4ComGetCurrentEvent.cxx.

References TGo4AnalysisObjectCommand::TGo4AnalysisObjectCommand(), fbOutputEvent, fbPrintoutOnly, fbTreeMode, GO4TRACE, and TGo4Command::SetReceiverName().

Member Function Documentation

ExeCom()

Int_t TGo4ComGetCurrentEvent::ExeCom ( )

overridevirtual

Do the command action.

Reimplemented from TGo4Command.

Definition at line 46 of file TGo4ComGetCurrentEvent.cxx.

References TGo4Analysis::CreateSingleEventTree(), TGo4Log::Debug(), TGo4Command::fxReceiverBase, TGo4Analysis::GetEventStructure(), TGo4Analysis::GetInputEvent(), TGo4AnalysisObjectCommand::GetObjectName(), TGo4Analysis::GetOutputEvent(), TGo4Command::GetTaskName(), GO4TRACE, TGo4Analysis::Instance(), IsOutputEvent(), IsPrintoutOnly(), IsTreeMode(), TGo4Slave::SendObject(), TGo4AnalysisClient::SendStatusMessage(), and TGo4Analysis::ShowEvent().

IsOutputEvent()

Bool_t TGo4ComGetCurrentEvent::IsOutputEvent ( ) const

inline

Definition at line 45 of file TGo4ComGetCurrentEvent.h.

References fbOutputEvent.

Referenced by ExeCom().

IsPrintoutOnly()

Bool_t TGo4ComGetCurrentEvent::IsPrintoutOnly ( ) const

inline

Definition at line 49 of file TGo4ComGetCurrentEvent.h.

References fbPrintoutOnly.

Referenced by ExeCom().

IsTreeMode()

Bool_t TGo4ComGetCurrentEvent::IsTreeMode ( ) const

inline

Definition at line 53 of file TGo4ComGetCurrentEvent.h.

References fbTreeMode.

Referenced by ExeCom().

Set()

void TGo4ComGetCurrentEvent::Set ( TGo4RemoteCommand * remcon )

overridevirtual

Set internals of this command from specification of external remote command (command container).

Must be overloaded for each specific command!

Reimplemented from TGo4AnalysisObjectCommand.

Definition at line 114 of file TGo4ComGetCurrentEvent.cxx.

References fbOutputEvent, fbPrintoutOnly, fbTreeMode, TGo4RemoteCommand::GetValue(), and TGo4AnalysisObjectCommand::Set().

SetOutputEvent()

void TGo4ComGetCurrentEvent::SetOutputEvent ( Bool_t output = kTRUE )

inline

Definition at line 47 of file TGo4ComGetCurrentEvent.h.

References fbOutputEvent.

SetPrintoutOnly()

void TGo4ComGetCurrentEvent::SetPrintoutOnly ( Bool_t on = kTRUE )

inline

Definition at line 51 of file TGo4ComGetCurrentEvent.h.

References fbPrintoutOnly.

SetTreeMode()

void TGo4ComGetCurrentEvent::SetTreeMode ( Bool_t on = kTRUE )

inline

Definition at line 55 of file TGo4ComGetCurrentEvent.h.

References fbTreeMode.

Field Documentation

fbOutputEvent

Bool_t TGo4ComGetCurrentEvent::fbOutputEvent

private

If true output event is searched, otherwise input event of step.

Definition at line 61 of file TGo4ComGetCurrentEvent.h.

Referenced by TGo4ComGetCurrentEvent(), TGo4ComGetCurrentEvent(), IsOutputEvent(), Set(), and SetOutputEvent().

fbPrintoutOnly

Bool_t TGo4ComGetCurrentEvent::fbPrintoutOnly

private

If true, the event will not be sent but content is shown on analysis terminal.

Definition at line 64 of file TGo4ComGetCurrentEvent.h.

Referenced by TGo4ComGetCurrentEvent(), TGo4ComGetCurrentEvent(), IsPrintoutOnly(), Set(), and SetPrintoutOnly().

fbTreeMode

Bool_t TGo4ComGetCurrentEvent::fbTreeMode

private

If true, event will be put into tree before showing; otherwise use PrintEvent method or send event directly.

Definition at line 68 of file TGo4ComGetCurrentEvent.h.

Referenced by TGo4ComGetCurrentEvent(), TGo4ComGetCurrentEvent(), IsTreeMode(), Set(), and SetTreeMode().

---

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

• Go4CommandsAnalysis/TGo4ComGetCurrentEvent.h
• Go4CommandsAnalysis/TGo4ComGetCurrentEvent.cxx