albaDevice.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaDevice
 Authors: Marco Petrone
 
 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 __albaDevice_h
#define __albaDevice_h
 
#include "albaAgentThreaded.h"
#include "albaStorable.h"
 
//----------------------------------------------------------------------------
// forward declarations :
//----------------------------------------------------------------------------
class albaGUI;
 
class ALBA_EXPORT albaDevice : public albaAgentThreaded, public albaStorable
{
public:
  enum DEVICE_MINIMUM_ID {MIN_DEVICE_ID=1000000};
 
  //------------------------------------------------------------------------------
  // Events
  //------------------------------------------------------------------------------
  ALBA_ID_DEC(DEVICE_NAME_CHANGED) 
  ALBA_ID_DEC(DEVICE_STARTED); 
  ALBA_ID_DEC(DEVICE_STOPPED); 
  //----------------------------------------------------------------------------
  //    GUI Constants
  //----------------------------------------------------------------------------
  enum DEVICE_WIDGET_ID
  {
    ID_NAME=MINID,
    ID_ACTIVATE,
    ID_SHUTDOWN,
    ID_AUTO_START,
    ID_LAST
  };
 
  albaTypeMacro(albaDevice,albaAgentThreaded);
 
  unsigned long GetID() {return m_ID;};
 
  void SetID(unsigned long id) {m_ID=id;};
 
  virtual void SetName(const char *name);
 
  void SetAutoStart(bool flag) {m_AutoStart=flag;}
  bool GetAutoStart() { return m_AutoStart!=0;}
 
  void AutoStartOn() {m_AutoStart=true;}
 
  void AutoStartOff() {m_AutoStart=false;}
 
  virtual int Start();
 
  virtual void Stop();
 
  virtual int StartUp() { return m_AutoStart?Start():0;}
 
  void SetPersistentFlag(bool flag) { m_PersistentFalg = flag; }
  bool GetPersistentFlag() {return m_PersistentFalg;}
 
  bool IsPersistent() {return m_PersistentFalg;}
  
  albaGUI *GetGui();
  
  virtual void UpdateGui();
  
  virtual void OnEvent(albaEventBase *event);
 
protected:
  albaDevice();
  virtual ~albaDevice();
 
  virtual int InternalInitialize();
 
  virtual void CreateGui();
 
  virtual int InternalStore(albaStorageElement *node);
  
  virtual int InternalRestore(albaStorageElement *node);
  
 
  albaGUI*             m_Gui;
  albaID               m_ID;
  int                 m_AutoStart;
  int                 m_Start;  //SIL. 07-jun-2006 : -- connected to a Bool in the Gui
  bool                m_Locked;
  bool                m_PersistentFalg;
 
private:
  albaDevice(const albaDevice&);  // Not implemented.
  void operator=(const albaDevice&);  // Not implemented.
 
  int Initialize() {return Superclass::Initialize();}
 
  void Shutdown() {Superclass::Shutdown();} 
};
 
#endif