itkObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkObject_h
#define itkObject_h

#include "itkLightObject.h"
#include "itkEventObject.h"
#include "itkMetaDataDictionary.h"
#include "itkSingletonMacro.h"

namespace itk
{
// Forward reference because of private implementation
class SubjectImplementation;
// Forward reference because of circular dependencies
class ITK_FORWARD_EXPORT Command;

class ITKCommon_EXPORT Object:public LightObject
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(Object);

  using Self = Object;
  using Superclass = LightObject;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  static Pointer New();

  LightObject::Pointer CreateAnother() const override;

  itkTypeMacro(Object, LightObject);

  virtual void DebugOn() const;

  virtual void DebugOff() const;

  bool GetDebug() const;

  void SetDebug(bool debugFlag) const;

  virtual ModifiedTimeType GetMTime() const;

  virtual const TimeStamp & GetTimeStamp() const;

  virtual void Modified() const;

  void Register() const override;

  void UnRegister() const noexcept override;

  void SetReferenceCount(int) override;

  static void SetGlobalWarningDisplay(bool flag);

  static bool GetGlobalWarningDisplay();

  static void GlobalWarningDisplayOn()
  { SetGlobalWarningDisplay(true); }
  static void GlobalWarningDisplayOff()
  { SetGlobalWarningDisplay(false); }

  unsigned long AddObserver(const EventObject & event, Command *);

  unsigned long AddObserver(const EventObject & event, Command *) const;

  Command * GetCommand(unsigned long tag);

  void InvokeEvent(const EventObject &);

  void InvokeEvent(const EventObject &) const;

  void RemoveObserver(unsigned long tag);

  void RemoveAllObservers();

  bool HasObserver(const EventObject & event) const;

  MetaDataDictionary & GetMetaDataDictionary();

  const MetaDataDictionary & GetMetaDataDictionary() const;

  void SetMetaDataDictionary(const MetaDataDictionary & rhs);
  void SetMetaDataDictionary( MetaDataDictionary && rrhs);

  itkSetMacro(ObjectName, std::string);
  itkGetConstReferenceMacro(ObjectName, std::string);

protected:
  Object();
  ~Object() override;

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

  bool PrintObservers(std::ostream & os, Indent indent) const;

  virtual void SetTimeStamp( const TimeStamp & time );

private:
  itkGetGlobalDeclarationMacro(bool, GlobalWarningDisplay);

  mutable bool m_Debug{false};

  mutable TimeStamp m_MTime;

  static bool *m_GlobalWarningDisplay;

  SubjectImplementation *m_SubjectImplementation{nullptr};

  mutable MetaDataDictionary *m_MetaDataDictionary{nullptr};

  std::string m_ObjectName;
};
} // end namespace itk

#endif