albaOp.h

Go to the documentation of this file.

/*=========================================================================
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaOp
 Authors: Silvano Imboden
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
=========================================================================*/
#ifndef __albaOp_H__
#define __albaOp_H__
//----------------------------------------------------------------------------
// Include:
//----------------------------------------------------------------------------
#include "albaDefines.h" //important: albaDefines should always be included as first
#include "albaEvent.h"
#include "albaObserver.h"
#include "albaObject.h"
#include "albaServiceClient.h"
#include "albaAbsLogicManager.h"
 
//----------------------------------------------------------------------------
// forward references :
//----------------------------------------------------------------------------
class albaVME;
class albaGUI;
class albaGUIHolder;
class albaDeviceButtonsPadMouse;
class albaGUISettings;
 
//----------------------------------------------------------------------------
// constants :
//----------------------------------------------------------------------------
enum OPERATIONS_TYPE_ID
{
   OPTYPE_OP = 0,
   OPTYPE_IMPORTER,
   OPTYPE_EXPORTER,
   OPTYPE_EDIT,
   OPTYPE_STATECHANGER,
   OPTYPE_MAX,
};
 
//----------------------------------------------------------------------------
// albaOp :
//----------------------------------------------------------------------------
class ALBA_EXPORT albaOp : public albaObserver, public albaObject, public albaServiceClient
{
public:
   enum ALBAOP_ID
   {
      ID_HELP = MINID,
      MINID,
   };
 
   albaTypeMacro(albaOp, albaObject);
 
   albaOp();
   albaOp(const wxString &label);
   virtual  ~albaOp();
   void SetListener(albaObserver *Listener) { m_Listener = Listener; };
 
   int GetType();
 
   virtual void OnEvent(albaEventBase *alba_event);
   virtual albaOp* Copy();
 
   virtual void OpRun();
 
   virtual void SetParameters(void *param) {};
 
   virtual albaString GetParameters() { albaString parameters; return parameters; };
 
   virtual void OpDo();
 
   virtual void OpUndo();
 
   virtual albaGUI *GetGui() { return m_Gui; };
 
   virtual void SetInput(albaVME* vme) { m_Input = vme; };
   virtual albaVME   *GetInput() { return m_Input; };
 
   virtual albaVME *GetOutput() { return m_Output; };
   virtual void SetOutput(albaVME *output) { m_Output = output; };
 
   bool Accept(albaVME* vme);
 
   void EnableAccept(bool enable = true) { m_EnableAccept = enable; }
 
   virtual bool CanUndo();
 
   bool IsInputPreserving() { return m_InputPreserving; };
 
   void ShowGui();
 
   void HideGui();
 
   virtual bool OkEnabled();
 
   virtual void ForceStopWithOk();
 
   virtual void ForceStopWithCancel();
 
   wxString          m_Label; 
   int                     m_Id; 
   albaOp                *m_Next; 
 
   //SIL 22/04/04
   long            m_Compatibility;
   bool                 IsCompatible(long state);
   wxMenuItem     *m_MenuItem;
   wxString        m_OpMenuPath;
 
   //MARCO 7/05/04
   virtual const char **GetActions() { return NULL; };
 
   void SetMouse(albaDeviceButtonsPadMouse *mouse);
   albaDeviceButtonsPadMouse *GetMouse() { return m_Mouse; };
 
   void TestModeOn() { m_TestMode = true; };
 
   void TestModeOff() { m_TestMode = false; };
 
   bool GetTestMode() { return m_TestMode; };
 
   void SetCanundo(bool can_undo = true) { m_Canundo = can_undo; };
 
   bool GetCanundo() { return m_Canundo; };
 
   void SetSetting(albaGUISettings *setting) { m_SettingPanel = setting; };
 
   albaGUISettings *GetSetting() { return m_SettingPanel; };
 
   virtual char ** GetIcon();
 
protected:
 
   virtual bool InternalAccept(albaVME* vme);
 
   virtual void OpStop(int result);
 
   albaVME            *m_Input; 
   albaVME         *m_Output; 
   albaGUI         *m_Gui; 
   albaGUIHolder   *m_Guih;
   bool                 m_Canundo; 
   int                  m_OpType; 
   bool                 m_InputPreserving; 
   albaObserver    *m_Listener;
   albaDeviceButtonsPadMouse       *m_Mouse;
   albaGUISettings *m_SettingPanel;
   bool            m_TestMode; 
   bool m_EnableAccept;
};
#endif