mitkSmartPointerProperty.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
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 or http://www.mitk.org for details.

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

#ifndef MITKSMARTPOINTERPROPERTY_H_HEADER_INCLUDED_C126B791
#define MITKSMARTPOINTERPROPERTY_H_HEADER_INCLUDED_C126B791

#include "mitkBaseProperty.h"
#include "mitkUIDGenerator.h"
#include <MitkCoreExports.h>

#include <list>
#include <map>
#include <string>

namespace mitk
{
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4522)
#endif

  //##Documentation
  //## @brief Property containing a smart-pointer
  //## @ingroup DataManagement
  class MITKCORE_EXPORT SmartPointerProperty : public BaseProperty
  {
  public:
    mitkClassMacro(SmartPointerProperty, BaseProperty);

    itkFactorylessNewMacro(Self) itkCloneMacro(Self) mitkNewMacro1Param(SmartPointerProperty, itk::Object *);

    typedef itk::Object::Pointer ValueType;

    itk::Object::Pointer GetSmartPointer() const;
    ValueType GetValue() const;

    void SetSmartPointer(itk::Object *);
    void SetValue(const ValueType &);

    virtual std::string GetValueAsString() const override;

    static void PostProcessXMLReading();

    static unsigned int GetReferenceCountFor(itk::Object *);
    static std::string GetReferenceUIDFor(itk::Object *);
    static void RegisterPointerTarget(itk::Object *, const std::string uid);

    using BaseProperty::operator=;

  protected:
    SmartPointerProperty(itk::Object * = nullptr);
    SmartPointerProperty(const SmartPointerProperty &);

    itk::Object::Pointer m_SmartPointer;

  private:
    // purposely not implemented
    SmartPointerProperty &operator=(const SmartPointerProperty &);

    itk::LightObject::Pointer InternalClone() const override;

    virtual bool IsEqual(const BaseProperty &) const override;
    virtual bool Assign(const BaseProperty &) override;

    typedef std::map<itk::Object *, unsigned int> ReferenceCountMapType;
    typedef std::map<itk::Object *, std::string> ReferencesUIDMapType;
    typedef std::map<SmartPointerProperty *, std::string> ReadInSmartPointersMapType;
    typedef std::map<std::string, itk::Object *> ReadInTargetsMapType;

    static ReferenceCountMapType m_ReferenceCount;
    static ReferencesUIDMapType m_ReferencesUID;
    static ReadInSmartPointersMapType m_ReadInInstances;
    static ReadInTargetsMapType m_ReadInTargets;

    static UIDGenerator m_UIDGenerator;
  };

#ifdef _MSC_VER
#pragma warning(pop)
#endif

} // namespace mitk

#endif /* MITKSMARTPOINTERPROPERTY_H_HEADER_INCLUDED_C126B791 */