TGo4Command Class Reference

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

#include <TGo4Command.h>

Inheritance diagram for TGo4Command:

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 36 of file TGo4Command.h.

---

Constructor & Destructor Documentation

TGo4Command::TGo4Command

(

)

Definition at line 42 of file TGo4Command.cxx.

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

Definition at line 25 of file TGo4Command.cxx.

TGo4Command::~TGo4Command

(

)

[virtual]

Definition at line 58 of file TGo4Command.cxx.

---

Member Function Documentation

Int_t TGo4Command::ExeCom

(

)

[virtual]

Do the command action.

Reimplemented in TGo4RemoteCommand, TGo4ComDisconnectSlave, TGo4ComExecLine, TGo4ComMasterQuit, TGo4ComQuit, TGo4ComRemoveClient, TGo4ComServerQuit, TGo4ComStart, TGo4ComStop, TGo4ComAction1, and TGo4ComAction2.

Definition at line 121 of file TGo4Command.cxx.

Int_t TGo4Command::UnExeCom

(

)

[virtual]

For undo functionality (not yet impl.

)

Definition at line 128 of file TGo4Command.cxx.

Int_t TGo4Command::RefuseCom

(

)

[virtual]

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

)

Reimplemented in TGo4TaskHandlerCommand.

Definition at line 134 of file TGo4Command.cxx.

Bool_t TGo4Command::Log

(

Int_t

mode = 0

)

[virtual]

Definition at line 141 of file TGo4Command.cxx.

Bool_t TGo4Command::IsEnabled

(

)

const

Definition at line 74 of file TGo4Command.cxx.

Bool_t TGo4Command::IsExclusive

(

)

const

Definition at line 80 of file TGo4Command.cxx.

Bool_t TGo4Command::IsLocal

(

)

const

Definition at line 161 of file TGo4Command.cxx.

void TGo4Command::Help

(

)

[virtual]

Definition at line 69 of file TGo4Command.cxx.

Int_t TGo4Command::GetCommandID

(

)

const

Definition at line 63 of file TGo4Command.cxx.

Bool_t TGo4Command::IsSynchron

(

)

const

Definition at line 155 of file TGo4Command.cxx.

const char * TGo4Command::GetReceiverName

(

)

const

Definition at line 86 of file TGo4Command.cxx.

void TGo4Command::SetReceiverName

(

const char *

name

)

Definition at line 92 of file TGo4Command.cxx.

const char * TGo4Command::GetTaskName

(

)

const

Definition at line 98 of file TGo4Command.cxx.

void TGo4Command::SetTaskName

(

const char *

name

)

Definition at line 104 of file TGo4Command.cxx.

const char * TGo4Command::What

(

)

const

Definition at line 115 of file TGo4Command.cxx.

void TGo4Command::SetDescription

(

const char *

txt

)

Definition at line 110 of file TGo4Command.cxx.

void TGo4Command::SetReceiver

(

TGo4CommandReceiver *

rec

)

[virtual]

Definition at line 167 of file TGo4Command.cxx.

Go4CommandMode_t TGo4Command::GetProtection

(

)

[inline]

Definition at line 79 of file TGo4Command.h.

Go4CommandMode_t TGo4Command::GetMode

(

)

[inline]

Definition at line 80 of file TGo4Command.h.

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!

Definition at line 181 of file TGo4Command.cxx.

void TGo4Command::SetMode

(

Go4CommandMode_t

m

)

[inline]

Definition at line 87 of file TGo4Command.h.

const char * TGo4Command::GetModeDescription

(

Go4CommandMode_t

mode

)

[static]

text description of current execution mode

Definition at line 174 of file TGo4Command.cxx.

void TGo4Command::SetProtection

(

Go4CommandMode_t

m

)

[inline, protected]

Definition at line 108 of file TGo4Command.h.

---

Member Data Documentation

Bool_t TGo4Command::fbIsEnabled [protected]

Definition at line 94 of file TGo4Command.h.

Bool_t TGo4Command::fbIsExclusive [protected]

Definition at line 95 of file TGo4Command.h.

Bool_t TGo4Command::fbIsSynchron [protected]

Definition at line 96 of file TGo4Command.h.

Bool_t TGo4Command::fbIsLocal [protected]

Definition at line 97 of file TGo4Command.h.

Int_t TGo4Command::fiCommandID [protected]

Definition at line 99 of file TGo4Command.h.

Int_t TGo4Command::fiVersion [protected]

Definition at line 100 of file TGo4Command.h.

Go4CommandMode_t TGo4Command::fiMode [protected]

mode value for execution rights of sending task

Definition at line 103 of file TGo4Command.h.

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 106 of file TGo4Command.h.

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

Initial value:

   {"NOMODE","Observer","Controller","Administrator"}

resolve description of command modes here

Definition at line 111 of file TGo4Command.h.

TString TGo4Command::fxDescription [private]

Definition at line 115 of file TGo4Command.h.

TString TGo4Command::fxReceiverName [private]

Definition at line 116 of file TGo4Command.h.

TString TGo4Command::fxTaskName [private]

Definition at line 117 of file TGo4Command.h.

TGo4CommandReceiver* TGo4Command::fxReceiverBase [protected]

Definition at line 120 of file TGo4Command.h.

---

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

• Go4CommandsBase/TGo4Command.h
• Go4CommandsBase/TGo4Command.cxx