itkEventObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkEventObject_h
#define itkEventObject_h
 
#include "itkMacro.h"
#include "itkIndent.h"
 
namespace itk
{
class ITKCommon_EXPORT EventObject
{
public:
  EventObject() = default;
 
  EventObject(const EventObject &) = default;
 
  EventObject &
  operator=(const EventObject &) = delete;

  virtual ~EventObject() = default;

  [[nodiscard]] virtual EventObject *
  MakeObject() const = 0;

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

  [[nodiscard]] virtual const char *
  GetEventName() 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;
};

inline std::ostream &
operator<<(std::ostream & os, const EventObject & e)
{
  e.Print(os);
  return os;
}
 
 
#define ITKEvent_EXPORT ITKCommon_EXPORT

 
#define itkEventMacroDeclaration(classname, super)         \
                                  \
  class ITKEvent_EXPORT classname : public super           \
  {                                                        \
  public:                                                  \
    using Self = classname;                                \
    using Superclass = super;                              \
    classname() = default;                                 \
    classname(const Self & s);                             \
    ~classname() override;                                 \
    const char *                                           \
    GetEventName() const override;                         \
    bool                                                   \
    CheckEvent(const itk::EventObject * e) const override; \
    itk::EventObject *                                     \
    MakeObject() const override;                           \
    Self &                                                 \
    operator=(const Self &) = delete;                      \
  };                                                       \
  ITK_MACROEND_NOOP_STATEMENT
 
// Note: From ITK 6.0, the second parameter of itkEventMacroDefinition (`super`) is ignored.
#define itkEventMacroDefinition(classname, super)                            \
  classname::classname(const classname &) = default;                         \
  classname::~classname() = default;                                         \
  const char * classname::GetEventName() const { return #classname; }        \
  bool         classname::CheckEvent(const itk::EventObject * e) const       \
  {                                                                          \
    return dynamic_cast<const classname *>(e) != nullptr;                    \
  }                                                                          \
  itk::EventObject * classname::MakeObject() const { return new classname; } \
  ITK_MACROEND_NOOP_STATEMENT
 
#if !defined(ITK_LEGACY_REMOVE)
// Support Pre 2015 code bases
 
// This macro duplicates some of the declaration and definition
// macro code. The purpose is to provide a backward compatibility API
// for ITK applications.
// NOTE: New applications should use itkEventMacroDeclaration (in a
// .h file) and itkEventMacroDefinition (in a compiled .cxx
// file). This new approach guarantees that only one copy of the
// implementation will be present.
//
#  define itkEventMacro(classname, super)                \
                              \
    class ITKEvent_EXPORT classname : public super       \
    {                                                    \
    public:                                              \
      using Self = classname;                            \
      using Superclass = super;                          \
      classname() = default;                             \
      ~classname() override = default;                   \
      virtual const char *                               \
      GetEventName() const                               \
      {                                                  \
        return #classname;                               \
      }                                                  \
      virtual bool                                       \
      CheckEvent(const itk::EventObject * e) const       \
      {                                                  \
        return dynamic_cast<const Self *>(e) != nullptr; \
      }                                                  \
      virtual itk::EventObject *                         \
      MakeObject() const                                 \
      {                                                  \
        return new Self;                                 \
      }                                                  \
      classname(const Self &) = default;                 \
      Self &                                             \
      operator=(const Self &) = delete;                  \
    };
#endif
itkEventMacroDeclaration(NoEvent, EventObject);
itkEventMacroDeclaration(AnyEvent, EventObject);
itkEventMacroDeclaration(DeleteEvent, AnyEvent);
itkEventMacroDeclaration(StartEvent, AnyEvent);
itkEventMacroDeclaration(EndEvent, AnyEvent);
itkEventMacroDeclaration(ProgressEvent, AnyEvent);
itkEventMacroDeclaration(ExitEvent, AnyEvent);
itkEventMacroDeclaration(AbortEvent, AnyEvent);
itkEventMacroDeclaration(ModifiedEvent, AnyEvent);
itkEventMacroDeclaration(InitializeEvent, AnyEvent);
itkEventMacroDeclaration(IterationEvent, AnyEvent);
itkEventMacroDeclaration(MultiResolutionIterationEvent, IterationEvent);
itkEventMacroDeclaration(PickEvent, AnyEvent);
itkEventMacroDeclaration(StartPickEvent, PickEvent);
itkEventMacroDeclaration(EndPickEvent, PickEvent);
itkEventMacroDeclaration(AbortCheckEvent, PickEvent);
itkEventMacroDeclaration(FunctionEvaluationIterationEvent, IterationEvent);
itkEventMacroDeclaration(GradientEvaluationIterationEvent, IterationEvent);
itkEventMacroDeclaration(FunctionAndGradientEvaluationIterationEvent, IterationEvent);
itkEventMacroDeclaration(UserEvent, AnyEvent);
#undef ITKEvent_EXPORT
#define ITKEvent_EXPORT ITK_ABI_EXPORT
 
} // end namespace itk
 
#endif