niftkItkSignalCollector.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkItkSignalCollector_h
#define niftkItkSignalCollector_h

#include <itkCommand.h>
#include <itkEventObject.h>

#include <mitkCommon.h>

#include <vector>

namespace niftk
{

class ItkSignalListener
{
public:
  virtual void OnItkSignalReceived(const itk::Object* object, const itk::EventObject& event) = 0;
};


class ItkSignalCollector : public itk::Command
{
public:
  mitkClassMacroItkParent(ItkSignalCollector, itk::Command)
  itkNewMacro(ItkSignalCollector)

  typedef std::pair<const itk::Object*, itk::EventObject*> Signal;
  typedef std::vector<Signal> Signals;

  void Connect(itk::Object* object, const itk::EventObject& event);

  void AddListener(ItkSignalListener* listener);

  void RemoveListener(ItkSignalListener* listener);

  const Signals& GetSignals() const;

  Signals GetSignals(const itk::EventObject& event) const;

  Signals GetSignals(const itk::Object* object, const itk::EventObject& event = itk::AnyEvent()) const;

  virtual void Clear();

  virtual void ProcessEvent(const itk::Object* object, const itk::EventObject& event);

protected:

  ItkSignalCollector();

  virtual ~ItkSignalCollector();

  virtual void PrintSelf(std::ostream & os, itk::Indent indent) const override;

private:

  virtual void Execute(itk::Object* caller, const itk::EventObject& event) override;

  virtual void Execute(const itk::Object* object, const itk::EventObject& event) override;

  typedef std::multimap<itk::Object::Pointer, unsigned long> ObserverMap;
  ObserverMap m_ObserverTags;

  Signals m_Signals;

  std::vector<ItkSignalListener*> m_Listeners;

};

}

#endif