Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

TGo4Command Class Reference

This is the Go4 Abstract Command Class; part of the Base command pattern. More...

#include <TGo4Command.h>

Inheritance diagram for TGo4Command:

TGo4AnalysisCommand TGo4ExampleCommand TGo4RemoteCommand TGo4TaskHandlerCommand TGo4AnalysisObjectCommand TGo4ComAddTreeHistogram TGo4ComAutosave TGo4ComGetAnalysisStatus TGo4ComGetNamesList TGo4ComInitAnalysis TGo4ComLoadAnalysisStatus TGo4ComPrintConditions TGo4ComPrintDynList TGo4ComPrintHistograms TGo4ComSaveAnalysisStatus TGo4ComSetAnalysisStatus TGo4ComAction1 TGo4ComAction2 TGo4ComDisconnectSlave TGo4ComExecLine TGo4ComMasterQuit TGo4ComQuit TGo4ComRemoveClient TGo4ComServerQuit TGo4ComStart TGo4ComStop List of all members.

Public Member Functions

 TGo4Command ()
 TGo4Command (const char *name, const char *description, Int_t id)
virtual ~TGo4Command ()
virtual Int_t ExeCom ()
 Do the command action.
virtual Int_t UnExeCom ()
 For undo functionality (not yet impl.
virtual Int_t RefuseCom ()
 Optional action if command is not allowed (warning message e.g.
virtual Bool_t Log (Int_t mode=0)
Bool_t IsEnabled () const
Bool_t IsExclusive () const
Bool_t IsLocal () const
virtual void Help ()
Int_t GetCommandID () const
Bool_t IsSynchron () const
const char * GetReceiverName () const
void SetReceiverName (const char *)
const char * GetTaskName () const
void SetTaskName (const char *)
const char * What () const
void SetDescription (const char *)
virtual void SetReceiver (TGo4CommandReceiver *rec)
Go4CommandMode_t GetProtection ()
Go4CommandMode_t GetMode ()
virtual void Set (TGo4RemoteCommand *remcon)
 Set internals of this command from specification of external remote command (command container).
void SetMode (Go4CommandMode_t m)

Static Public Member Functions

static const char * GetModeDescription (Go4CommandMode_t mode)
 text description of current execution mode

Protected Member Functions

void SetProtection (Go4CommandMode_t m)

Protected Attributes

Bool_t fbIsEnabled
Bool_t fbIsExclusive
Bool_t fbIsSynchron
Bool_t fbIsLocal
Int_t fiCommandID
Int_t fiVersion
Go4CommandMode_t fiMode
 mode value for execution rights of sending task
Go4CommandMode_t fiProtection
 Execute protection of this command.
TGo4CommandReceiver * fxReceiverBase

Static Protected Attributes

static const char * fgcMODEDESCRIPTION []
 resolve description of command modes here

Private Attributes

TString fxDescription
TString fxReceiverName
TString fxTaskName

Detailed Description

This is the Go4 Abstract Command Class; part of the Base command pattern.

Definition at line 38 of file TGo4Command.h.

Constructor & Destructor Documentation

TGo4Command::TGo4Command (   ) 
 

Definition at line 44 of file TGo4Command.cxx.

References fbIsEnabled, fbIsExclusive, fbIsLocal, fbIsSynchron, fiCommandID, fiMode, fiProtection, fiVersion, kGo4ComModeObserver, kGo4ComModeRefused, SetDescription(), SetReceiverName(), SetTaskName(), and TRACE.

TGo4Command::TGo4Command (  const char *  name,
const char *  description,
Int_t  id
) 
 

Definition at line 27 of file TGo4Command.cxx.

References fbIsEnabled, fbIsExclusive, fbIsLocal, fbIsSynchron, fiCommandID, fiMode, fiProtection, fiVersion, kGo4ComModeObserver, kGo4ComModeRefused, SetDescription(), SetReceiverName(), SetTaskName(), and TRACE.

TGo4Command::~TGo4Command (   )  [virtual]
 

Definition at line 60 of file TGo4Command.cxx.

References TRACE.

Member Function Documentation

Int_t TGo4Command::ExeCom (   )  [virtual]
 

Do the command action.

Reimplemented in TGo4ComAddTreeHistogram, TGo4ComAutosave, TGo4ComClearObject, TGo4ComDeleteObject, TGo4ComGetAnalysisStatus, TGo4ComGetCurrentEvent, TGo4ComGetEnvelope, TGo4ComGetNamesList, TGo4ComGetObjectStatus, TGo4ComInitAnalysis, TGo4ComLoadAnalysisStatus, TGo4ComPrintConditions, TGo4ComPrintDynList, TGo4ComPrintHistograms, TGo4ComSaveAnalysisStatus, TGo4ComSetAnalysisStatus, TGo4ComSetObject, TGo4ComSetPrintEvent, TGo4ComSetProtections, TGo4RemoteCommand, TGo4ComDisconnectSlave, TGo4ComExecLine, TGo4ComMasterQuit, TGo4ComQuit, TGo4ComRemoveClient, TGo4ComServerQuit, TGo4ComStart, TGo4ComStop, TGo4ComAction1, and TGo4ComAction2.

Definition at line 123 of file TGo4Command.cxx.

References TRACE, and What().

Referenced by TGo4CommandInvoker::Invoke().

Int_t TGo4Command::UnExeCom (   )  [virtual]
 

For undo functionality (not yet impl.

)

Definition at line 130 of file TGo4Command.cxx.

References TRACE.

Int_t TGo4Command::RefuseCom (   )  [virtual]
 

Optional action if command is not allowed (warning message e.g.

)

Reimplemented in TGo4AnalysisCommand, and TGo4TaskHandlerCommand.

Definition at line 136 of file TGo4Command.cxx.

References GetMode(), GetModeDescription(), and TGo4Log::Warn().

Referenced by TGo4TaskHandlerCommand::RefuseCom(), and TGo4AnalysisCommand::RefuseCom().

Bool_t TGo4Command::Log (  Int_t  mode = 0  )  [virtual]
 

Definition at line 143 of file TGo4Command.cxx.

References TRACE, and What().

Bool_t TGo4Command::IsEnabled (   )  const
 

Definition at line 76 of file TGo4Command.cxx.

References fbIsEnabled, and TRACE.

Bool_t TGo4Command::IsExclusive (   )  const
 

Definition at line 82 of file TGo4Command.cxx.

References fbIsExclusive, and TRACE.

Bool_t TGo4Command::IsLocal (   )  const
 

Definition at line 163 of file TGo4Command.cxx.

References fbIsLocal.

void TGo4Command::Help (   )  [virtual]
 

Definition at line 71 of file TGo4Command.cxx.

References TRACE.

Int_t TGo4Command::GetCommandID (   )  const
 

Definition at line 65 of file TGo4Command.cxx.

References fiCommandID, and TRACE.

Referenced by TGo4LocalCommandRunnable::Run(), and TGo4AnalysisMainRunnable::Run().

Bool_t TGo4Command::IsSynchron (   )  const
 

Definition at line 157 of file TGo4Command.cxx.

References fbIsSynchron, and TRACE.

const char * TGo4Command::GetReceiverName (   )  const
 

Definition at line 88 of file TGo4Command.cxx.

References fxReceiverName, and TRACE.

Referenced by TGo4CommandInvoker::Invoke().

void TGo4Command::SetReceiverName (  const char *   ) 
 

Definition at line 94 of file TGo4Command.cxx.

References fxReceiverName, and TRACE.

Referenced by TGo4RemoteCommand::InitPars(), TGo4AnalysisCommand::TGo4AnalysisCommand(), TGo4ComAddTreeHistogram::TGo4ComAddTreeHistogram(), TGo4ComAutosave::TGo4ComAutosave(), TGo4ComClearObject::TGo4ComClearObject(), TGo4ComDeleteObject::TGo4ComDeleteObject(), TGo4ComDisconnectSlave::TGo4ComDisconnectSlave(), TGo4ComGetAnalysisStatus::TGo4ComGetAnalysisStatus(), TGo4ComGetCurrentEvent::TGo4ComGetCurrentEvent(), TGo4ComGetEnvelope::TGo4ComGetEnvelope(), TGo4ComGetNamesList::TGo4ComGetNamesList(), TGo4ComGetObjectStatus::TGo4ComGetObjectStatus(), TGo4ComInitAnalysis::TGo4ComInitAnalysis(), TGo4ComLoadAnalysisStatus::TGo4ComLoadAnalysisStatus(), TGo4Command(), TGo4ComMasterQuit::TGo4ComMasterQuit(), TGo4ComPrintConditions::TGo4ComPrintConditions(), TGo4ComPrintDynList::TGo4ComPrintDynList(), TGo4ComPrintHistograms::TGo4ComPrintHistograms(), TGo4ComRemoveClient::TGo4ComRemoveClient(), TGo4ComSaveAnalysisStatus::TGo4ComSaveAnalysisStatus(), TGo4ComServerQuit::TGo4ComServerQuit(), TGo4ComSetAnalysisStatus::TGo4ComSetAnalysisStatus(), TGo4ComSetObject::TGo4ComSetObject(), TGo4ComSetPrintEvent::TGo4ComSetPrintEvent(), TGo4ComSetProtections::TGo4ComSetProtections(), TGo4ExampleCommand::TGo4ExampleCommand(), and TGo4TaskHandlerCommand::TGo4TaskHandlerCommand().

const char * TGo4Command::GetTaskName (   )  const
 

Definition at line 100 of file TGo4Command.cxx.

References fxTaskName, and TRACE.

Referenced by TGo4ComGetObjectStatus::ExeCom(), TGo4ComGetNamesList::ExeCom(), TGo4ComGetEnvelope::ExeCom(), TGo4ComGetCurrentEvent::ExeCom(), TGo4ComGetAnalysisStatus::ExeCom(), TGo4CommandInvoker::ExecuteFromRemote(), TGo4TaskHandlerCommand::RefuseCom(), and TGo4AnalysisCommand::RefuseCom().

void TGo4Command::SetTaskName (  const char *   ) 
 

Definition at line 106 of file TGo4Command.cxx.

References fxTaskName, and TRACE.

Referenced by TGo4CommandInvoker::ExecuteFromRemote(), TGo4Task::NextCommand(), TGo4ServerTask::NextCommand(), and TGo4Command().

const char * TGo4Command::What (   )  const
 

Definition at line 117 of file TGo4Command.cxx.

References fxDescription, and TRACE.

Referenced by ExeCom(), Log(), and TGo4CommandProtoList::ShowCommands().

void TGo4Command::SetDescription (  const char *   ) 
 

Definition at line 112 of file TGo4Command.cxx.

References fxDescription, and TRACE.

Referenced by TGo4RemoteCommand::InitPars(), TGo4ComAction1::TGo4ComAction1(), TGo4ComAction2::TGo4ComAction2(), TGo4ComExecLine::TGo4ComExecLine(), TGo4ComGetEnvelope::TGo4ComGetEnvelope(), TGo4ComGetNamesList::TGo4ComGetNamesList(), TGo4Command(), TGo4ComSetProtections::TGo4ComSetProtections(), TGo4ComStart::TGo4ComStart(), and TGo4ComStop::TGo4ComStop().

void TGo4Command::SetReceiver (  TGo4CommandReceiver *  rec  )  [virtual]
 

Definition at line 169 of file TGo4Command.cxx.

References fxReceiverBase, and TRACE.

Referenced by TGo4CommandInvoker::Invoke().

Go4CommandMode_t TGo4Command::GetProtection (   )  [inline]
 

Definition at line 81 of file TGo4Command.h.

References fiProtection.

Go4CommandMode_t TGo4Command::GetMode (   )  [inline]
 

Definition at line 82 of file TGo4Command.h.

References fiMode.

Referenced by TGo4CommandInvoker::ExecuteFromRemote(), TGo4TaskHandlerCommand::RefuseCom(), RefuseCom(), and TGo4AnalysisCommand::RefuseCom().

void TGo4Command::Set (  TGo4RemoteCommand *  remcon  )  [virtual]
 

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

Must be overloaded for each specific command!

Reimplemented in TGo4AnalysisObjectCommand, TGo4ComAddTreeHistogram, TGo4ComAutosave, TGo4ComGetCurrentEvent, TGo4ComLoadAnalysisStatus, TGo4ComSaveAnalysisStatus, TGo4ComSetAnalysisStatus, TGo4ComSetObject, TGo4ComSetPrintEvent, and TGo4ComSetProtections.

Definition at line 183 of file TGo4Command.cxx.

Referenced by TGo4CommandProtoList::MakeCommand().

void TGo4Command::SetMode (  Go4CommandMode_t  m  )  [inline]
 

Definition at line 89 of file TGo4Command.h.

References fiMode.

Referenced by TGo4CommandInvoker::ExecuteFromRemote(), TGo4Task::NextCommand(), and TGo4ServerTask::NextCommand().

const char * TGo4Command::GetModeDescription (  Go4CommandMode_t  mode  )  [static]
 

text description of current execution mode

Definition at line 176 of file TGo4Command.cxx.

References fgcMODEDESCRIPTION.

Referenced by TGo4TaskManager::AddClient(), TGo4AnalysisProxy::ReceiveStatus(), TGo4TaskHandlerCommand::RefuseCom(), RefuseCom(), and TGo4AnalysisCommand::RefuseCom().

void TGo4Command::SetProtection (  Go4CommandMode_t  m  )  [inline, protected]
 

Definition at line 110 of file TGo4Command.h.

References fiProtection.

Referenced by TGo4ComAddTreeHistogram::TGo4ComAddTreeHistogram(), TGo4ComAutosave::TGo4ComAutosave(), TGo4ComClearObject::TGo4ComClearObject(), TGo4ComDeleteObject::TGo4ComDeleteObject(), TGo4ComInitAnalysis::TGo4ComInitAnalysis(), TGo4ComLoadAnalysisStatus::TGo4ComLoadAnalysisStatus(), TGo4ComSaveAnalysisStatus::TGo4ComSaveAnalysisStatus(), TGo4ComServerQuit::TGo4ComServerQuit(), TGo4ComSetAnalysisStatus::TGo4ComSetAnalysisStatus(), TGo4ComSetObject::TGo4ComSetObject(), TGo4ComSetProtections::TGo4ComSetProtections(), and TGo4TaskHandlerCommand::TGo4TaskHandlerCommand().

Member Data Documentation

Bool_t TGo4Command::fbIsEnabled [protected]
 

Definition at line 96 of file TGo4Command.h.

Referenced by TGo4RemoteCommand::InitPars(), IsEnabled(), TGo4AnalysisCommand::TGo4AnalysisCommand(), TGo4Command(), TGo4ExampleCommand::TGo4ExampleCommand(), and TGo4TaskHandlerCommand::TGo4TaskHandlerCommand().

Bool_t TGo4Command::fbIsExclusive [protected]
 

Definition at line 97 of file TGo4Command.h.

Referenced by TGo4RemoteCommand::InitPars(), IsExclusive(), and TGo4Command().

Bool_t TGo4Command::fbIsSynchron [protected]
 

Definition at line 98 of file TGo4Command.h.

Referenced by TGo4RemoteCommand::InitPars(), IsSynchron(), TGo4AnalysisCommand::TGo4AnalysisCommand(), TGo4ComExecLine::TGo4ComExecLine(), TGo4Command(), TGo4ComMasterQuit::TGo4ComMasterQuit(), TGo4ComQuit::TGo4ComQuit(), TGo4ComServerQuit::TGo4ComServerQuit(), TGo4ComStart::TGo4ComStart(), TGo4ComStop::TGo4ComStop(), TGo4ExampleCommand::TGo4ExampleCommand(), and TGo4TaskHandlerCommand::TGo4TaskHandlerCommand().

Bool_t TGo4Command::fbIsLocal [protected]
 

Definition at line 99 of file TGo4Command.h.

Referenced by TGo4RemoteCommand::InitPars(), IsLocal(), TGo4ComDisconnectSlave::TGo4ComDisconnectSlave(), TGo4Command(), TGo4ComMasterQuit::TGo4ComMasterQuit(), TGo4ComRemoveClient::TGo4ComRemoveClient(), and TGo4ComServerQuit::TGo4ComServerQuit().

Int_t TGo4Command::fiCommandID [protected]
 

Definition at line 101 of file TGo4Command.h.

Referenced by GetCommandID(), TGo4RemoteCommand::InitPars(), TGo4Command(), and TGo4TaskHandlerCommand::TGo4TaskHandlerCommand().

Int_t TGo4Command::fiVersion [protected]
 

Definition at line 102 of file TGo4Command.h.

Referenced by TGo4RemoteCommand::InitPars(), and TGo4Command().

Go4CommandMode_t TGo4Command::fiMode [protected]
 

mode value for execution rights of sending task

Definition at line 105 of file TGo4Command.h.

Referenced by GetMode(), SetMode(), and TGo4Command().

Go4CommandMode_t TGo4Command::fiProtection [protected]
 

Execute protection of this command.

If Execution mode is not sufficient, command is not allowed to be executed.

Definition at line 108 of file TGo4Command.h.

Referenced by GetProtection(), SetProtection(), and TGo4Command().

const char * TGo4Command::fgcMODEDESCRIPTION [static, protected]
 

Initial value:

   {"NOMODE","Observer","Controller","Administrator"}
resolve description of command modes here

Definition at line 23 of file TGo4Command.cxx.

Referenced by GetModeDescription().

TString TGo4Command::fxDescription [private]
 

Definition at line 117 of file TGo4Command.h.

Referenced by SetDescription(), and What().

TString TGo4Command::fxReceiverName [private]
 

Definition at line 118 of file TGo4Command.h.

Referenced by GetReceiverName(), and SetReceiverName().

TString TGo4Command::fxTaskName [private]
 

Definition at line 119 of file TGo4Command.h.

Referenced by GetTaskName(), and SetTaskName().

TGo4CommandReceiver* TGo4Command::fxReceiverBase [protected]
 

Definition at line 122 of file TGo4Command.h.

Referenced by TGo4ComAction2::ExeCom(), TGo4ComAction1::ExeCom(), TGo4ComStop::ExeCom(), TGo4ComStart::ExeCom(), TGo4ComServerQuit::ExeCom(), TGo4ComRemoveClient::ExeCom(), TGo4ComQuit::ExeCom(), TGo4ComMasterQuit::ExeCom(), TGo4ComExecLine::ExeCom(), TGo4ComDisconnectSlave::ExeCom(), TGo4RemoteCommand::ExeCom(), TGo4ComSetProtections::ExeCom(), TGo4ComSetPrintEvent::ExeCom(), TGo4ComSetObject::ExeCom(), TGo4ComSetAnalysisStatus::ExeCom(), TGo4ComSaveAnalysisStatus::ExeCom(), TGo4ComPrintHistograms::ExeCom(), TGo4ComPrintDynList::ExeCom(), TGo4ComPrintConditions::ExeCom(), TGo4ComLoadAnalysisStatus::ExeCom(), TGo4ComInitAnalysis::ExeCom(), TGo4ComGetObjectStatus::ExeCom(), TGo4ComGetNamesList::ExeCom(), TGo4ComGetEnvelope::ExeCom(), TGo4ComGetCurrentEvent::ExeCom(), TGo4ComGetAnalysisStatus::ExeCom(), TGo4ComDeleteObject::ExeCom(), TGo4ComClearObject::ExeCom(), TGo4ComAutosave::ExeCom(), TGo4ComAddTreeHistogram::ExeCom(), TGo4TaskHandlerCommand::RefuseCom(), TGo4AnalysisCommand::RefuseCom(), and SetReceiver().

The documentation for this class was generated from the following files:
Generated on Fri Nov 28 13:00:43 2008 for Go4-v3.04-1 by  doxygen 1.4.2