albaAgent.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaAgent
 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 __albaAgent_h
#define __albaAgent_h
 
#include "albaReferenceCounted.h"
#include "albaObserver.h"
#include "albaEventBroadcaster.h"
#include "albaString.h"
#include "albaEventBase.h"
 
#ifdef ALBA_EXPORTS
#include "albaDllMacros.h"
EXPORT_STL_VECTOR(ALBA_EXPORT, albaEventBroadcaster *);
#endif
 
//----------------------------------------------------------------------------
// forward declarations
//----------------------------------------------------------------------------
class vtkObject;
class vtkCallbackCommand;
class albaEventBroadcaster;
 
class ALBA_EXPORT albaAgent: public albaReferenceCounted, public albaObserver, public albaEventBroadcaster
{
public:
  albaAbstractTypeMacro(albaAgent,albaReferenceCounted);
  
  //------------------------------------------------------------------------------
  // Events
  //------------------------------------------------------------------------------
  ALBA_ID_DEC(AGENT_INITIALIZE); 
  
  void AddObserver(albaObserver *listener,albaID channel=MCH_UP);
  void RemoveObserver(albaObserver *listener);
  void RemoveAllObservers();
  
  virtual void OnEvent(albaEventBase *event);
  
  bool HasObservers(albaID channel);
  
  void GetObservers(albaID channel,std::vector<albaObserver *> &olist);
 
  int Initialize();
 
  void Shutdown();
 
  int IsInitialized() {return m_Initialized;}
  
  virtual void SetName(const char *name) {m_Name=name;}
  const char *GetName() {return m_Name;}
 
protected:
  albaAgent();
  virtual ~albaAgent();
 
  virtual int InternalInitialize() {return 0;};
 
  virtual void InternalShutdown() {};
 
#ifdef ALBA_USE_VTK
  static void InternalProcessVTKEvents(vtkObject* sender, unsigned long channel, void* clientdata, void* calldata);
#endif 
 
  void InvokeEvent(albaEventBase &event, albaID channel=-1);
  void InvokeEvent(albaEventBase *event, albaID channel=-1);
  void InvokeEvent(void *sender, int id, albaID channel=MCH_UP,void *data=NULL);
 
  albaString       m_Name;
  bool            m_Initialized; // flag set true by Initialize()
 
  std::vector<albaEventBroadcaster *> m_Channels;
 
#ifdef ALBA_USE_VTK
  vtkCallbackCommand *m_EventCallbackCommand; 
#endif 
 
private:
  albaAgent(const albaAgent&);  // Not implemented.
  void operator=(const albaAgent&);  // Not implemented.
 
};
 
#endif