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"

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:
  typedef Object                     Self;
  typedef LightObject                Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  static Pointer New();

  virtual LightObject::Pointer CreateAnother() const ITK_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;

  virtual void Register() const ITK_OVERRIDE;

  virtual void UnRegister() const ITK_NOEXCEPT ITK_OVERRIDE;

  virtual void SetReferenceCount(int) ITK_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);

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

protected:
  Object();
  virtual ~Object() ITK_OVERRIDE;

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

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

  virtual void SetTimeStamp( const TimeStamp & time );

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(Object);

  mutable bool m_Debug;

  mutable TimeStamp m_MTime;

  static bool m_GlobalWarningDisplay;

  SubjectImplementation *m_SubjectImplementation;

  mutable MetaDataDictionary *m_MetaDataDictionary;

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

#endif