itkEventObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkEventObject.h,v $
  Language:  C++
  Date:      $Date: 2008-10-13 15:36:31 $
  Version:   $Revision: 1.25 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

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

#ifndef __itkEventObject_h
#define __itkEventObject_h

#include "itkIndent.h"


namespace itk
{

class ITKCommon_EXPORT EventObject
{
public:
  EventObject() {}

  EventObject(const EventObject&){};
  
  virtual ~EventObject() {}

  virtual EventObject* MakeObject() const=0;  

  virtual void Print(std::ostream& os) const;

  virtual const char * GetEventName(void) const=0;

  virtual bool CheckEvent(const EventObject*) const=0;

protected:
  virtual void PrintSelf(std::ostream& os, Indent indent) const;
  virtual void PrintHeader(std::ostream& os, Indent indent) const;
  virtual void PrintTrailer(std::ostream& os, Indent indent) const;
private:
  typedef  EventObject * EventFactoryFunction();
  void operator=(const EventObject&);
};


inline std::ostream& operator<<(std::ostream& os, EventObject &e)
{
  (&e)->Print(os);
  return os;
}


#define itkEventMacro( classname , super ) \

  \
#define itkEventMacro( classname , super ) \
 class  classname : public super { \
   public: \
     typedef classname    Self; \
     typedef super        Superclass; \
     classname() {} \
     virtual ~classname() {} \
     virtual const char * GetEventName() const { return #classname; } \
     virtual bool CheckEvent(const ::itk::EventObject* e) const \
       { return dynamic_cast<const Self*>(e); } \
     virtual ::itk::EventObject* MakeObject() const \
       { return new Self; } \
     classname(const Self&s) :super(s){}; \
   private: \
     void operator=(const Self&); \
 };



itkEventMacro( NoEvent            , EventObject )
itkEventMacro( AnyEvent           , EventObject )
itkEventMacro( DeleteEvent        , AnyEvent )
itkEventMacro( StartEvent         , AnyEvent )
itkEventMacro( EndEvent           , AnyEvent )
itkEventMacro( ProgressEvent      , AnyEvent )
itkEventMacro( ExitEvent          , AnyEvent )
itkEventMacro( AbortEvent         , AnyEvent )
itkEventMacro( ModifiedEvent      , AnyEvent )
itkEventMacro( InitializeEvent     , AnyEvent )
itkEventMacro( IterationEvent     , AnyEvent )
itkEventMacro( PickEvent          , AnyEvent )
itkEventMacro( StartPickEvent     , PickEvent   )
itkEventMacro( EndPickEvent       , PickEvent   )
itkEventMacro( AbortCheckEvent    , PickEvent   )
itkEventMacro( FunctionEvaluationIterationEvent, IterationEvent )
itkEventMacro( GradientEvaluationIterationEvent, IterationEvent )
itkEventMacro( FunctionAndGradientEvaluationIterationEvent, IterationEvent )

itkEventMacro( UserEvent          , AnyEvent )

   
} // end namespace itk

#endif