---

/Go4CommandsBase/TGo4Command.h

Go to the documentation of this file.

//---------------------------------------------------------------
//        Go4 Release Package v2.10-5 (build 21005) 
//                      03-Nov-2005
//---------------------------------------------------------------
//       The GSI Online Offline Object Oriented (Go4) Project
//       Experiment Data Processing at DVEE department, GSI
//---------------------------------------------------------------
//
//Copyright (C) 2000- Gesellschaft f. Schwerionenforschung, GSI
//                    Planckstr. 1, 64291 Darmstadt, Germany
//Contact:            http://go4.gsi.de
//----------------------------------------------------------------
//This software can be used under the license agreements as stated
//in Go4License.txt file which is part of the distribution.
//----------------------------------------------------------------
#ifndef TGO4COMMAND_H
#define TGO4COMMAND_H

#include "TNamed.h"
#include "TString.h"

class TGo4CommandReceiver;


enum Go4CommandMode_t{
   kGo4ComModeRefused,     // no rights
   kGo4ComModeObserver,    // client may only observe 
   kGo4ComModeController,  // client has full control as user  
   kGo4ComModeAdministrator // full control over everything  
};



class TGo4Command  : public TNamed {
public:

    TGo4Command ();

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

    virtual ~TGo4Command ();

    virtual Int_t ExeCom();

    virtual Int_t UnExeCom();
    
    virtual Int_t RefuseCom();

    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(){return fiProtection;}
    Go4CommandMode_t GetMode(){return fiMode;}
    
    void SetMode(Go4CommandMode_t m){fiMode=m;}
    
    static const char* GetModeDescription(Go4CommandMode_t mode);

protected:

    Bool_t fbIsEnabled;   // comand can be executed
    Bool_t fbIsExclusive; // command can be executed only by ReceiverName
    Bool_t fbIsSynchron;  // command is queued = synchronous
    Bool_t fbIsLocal;     // command is to be executed by local command thread

    Int_t fiCommandID;    // command number
    Int_t fiVersion;      // version number
    
    Go4CommandMode_t fiMode; // 
    Go4CommandMode_t fiProtection; // 
        
   
    void SetProtection(Go4CommandMode_t m){fiProtection=m;}

    static char* fgcMODEDESCRIPTION[];

private:

    TString fxDescription;  // short description of command
    TString fxReceiverName; // name of receiver
    TString fxTaskName;     // name of task

protected:
    TGo4CommandReceiver * fxReceiverBase; 

    ClassDef(TGo4Command , 1) //TGo4Command
};

#endif //TGO4COMMAND_H




//----------------------------END OF GO4 SOURCE FILE ---------------------

---