itkMetaDataObject.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  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 itkMetaDataObject_h
#define itkMetaDataObject_h
 
#include "itkMetaDataDictionary.h"
#include "itkMacro.h"
#include "itkArray.h"
#include "itkMatrix.h"
 
#include <cstring>
 
namespace itk
{
template <typename MetaDataObjectType>
class ITK_TEMPLATE_EXPORT MetaDataObject : public MetaDataObjectBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MetaDataObject);
 
  using Self = MetaDataObject;
  using Superclass = MetaDataObjectBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkFactorylessNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(MetaDataObject);
 
  const char *
  GetMetaDataObjectTypeName() const override;
 
  const std::type_info &
  GetMetaDataObjectTypeInfo() const override;
 
  const MetaDataObjectType &
  GetMetaDataObjectValue() const;
 
  void
  SetMetaDataObjectValue(const MetaDataObjectType & newValue);
 
  void
  Print(std::ostream & os) const override;
 
  friend bool
  operator==(const Self & lhs, const Self & rhs)
  {
    return Self::EqualValues(lhs.m_MetaDataObjectValue, rhs.m_MetaDataObjectValue);
  }
 
  friend bool
  operator!=(const Self & lhs, const Self & rhs)
  {
    return !(lhs == rhs);
  }
 
protected:
  MetaDataObject() = default;
  ~MetaDataObject() override = default;
 
private:
  template <typename TValue>
  static auto
  Assign(TValue & target, const TValue & source) -> decltype(target = source)
  {
    return target = source;
  }
 
  template <typename TValue, size_t VNumberOfElements>
  static void
  Assign(TValue (&target)[VNumberOfElements], const TValue (&source)[VNumberOfElements])
  {
    for (size_t i = 0; i < VNumberOfElements; ++i)
    {
      Self::Assign(target[i], source[i]);
    }
  }
  template <typename TValue>
  static auto
  EqualValues(const TValue & lhs, const TValue & rhs) -> decltype(lhs == rhs)
  {
    return lhs == rhs;
  }
 
  template <typename TValue, size_t VNumberOfElements>
  static bool
  EqualValues(const TValue (&lhs)[VNumberOfElements], const TValue (&rhs)[VNumberOfElements])
  {
    for (size_t i = 0; i < VNumberOfElements; ++i)
    {
      if (!Self::EqualValues(lhs[i], rhs[i]))
      {
        return false;
      }
    }
    return true;
  }
  bool
  Equal(const MetaDataObjectBase & metaDataObjectBase) const override
  {
    const auto metaDataObject = dynamic_cast<const Self *>(&metaDataObjectBase);
    return (metaDataObject != nullptr) && (*this == *metaDataObject);
  }
  MetaDataObjectType m_MetaDataObjectValue{};
};
 
template <typename T>
inline void
EncapsulateMetaData(MetaDataDictionary & Dictionary, const std::string & key, const T & invalue)
{
  typename MetaDataObject<T>::Pointer temp = MetaDataObject<T>::New();
  temp->SetMetaDataObjectValue(invalue);
  Dictionary[key] = temp;
}
template <typename T>
inline void
EncapsulateMetaData(MetaDataDictionary & Dictionary, const char * key, const T & invalue)
{
  EncapsulateMetaData(Dictionary, std::string(key), invalue);
}
 
template <typename T>
inline bool
ExposeMetaData(const MetaDataDictionary & Dictionary, const std::string key, T & outval)
{
  auto keyIter = Dictionary.Find(key);
  if (keyIter == Dictionary.End())
  {
    return false;
  }
  auto const * const TempMetaDataObject = dynamic_cast<MetaDataObject<T> const *>(keyIter->second.GetPointer());
  if (TempMetaDataObject == nullptr)
  {
    return false;
  }
 
  outval = TempMetaDataObject->GetMetaDataObjectValue();
  return true;
}
 
} // end namespace itk
 
#define ITK_NATIVE_TYPE_METADATAPRINT(TYPE_NAME)                      \
  template <>                                                         \
  void itk::MetaDataObject<TYPE_NAME>::Print(std::ostream & os) const \
  {                                                                   \
    os << this->m_MetaDataObjectValue << std::endl;                   \
  }
 
#define ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(TYPE_NAME_PART1, TYPE_NAME_PART2)               \
  template <>                                                                                \
  void itk::MetaDataObject<TYPE_NAME_PART1, TYPE_NAME_PART2>::Print(std::ostream & os) const \
  {                                                                                          \
    this->m_MetaDataObjectValue->Print(os);                                                  \
  }
 
#define ITK_IMAGE_TYPE_METADATAPRINT(STORAGE_TYPE)                           \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 1>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 2>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 3>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 4>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 5>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 6>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 7>::Pointer) \
  ITK_OBJECT_TYPE_METADATAPRINT_1COMMA(itk::Image<STORAGE_TYPE, 8>::Pointer)
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMetaDataObject.hxx"
#endif
 
#endif // itkMetaDataObject_h
 
#ifndef ITK_TEMPLATE_EXPLICIT_MetaDataObject
// Explicit instantiation is required to ensure correct dynamic_cast
// behavior across shared libraries.
//
// IMPORTANT: Since within the same compilation unit,
//            ITK_TEMPLATE_EXPLICIT_<classname> defined and undefined states
//            need to be considered. This code *MUST* be *OUTSIDE* the header
//            guards.
//
#if defined(ITKCommon_EXPORTS)
//   We are building this library
#  define ITKCommon_EXPORT_EXPLICIT ITK_TEMPLATE_EXPORT
#else
//   We are using this library
#  define ITKCommon_EXPORT_EXPLICIT ITKCommon_EXPORT
#endif
namespace itk
{
 
ITK_GCC_PRAGMA_DIAG_PUSH()
ITK_GCC_PRAGMA_DIAG(ignored "-Wattributes")
 
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<bool>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<unsigned char>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<char>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<signed char>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<unsigned short>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<short>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<unsigned int>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<int>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<unsigned long>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<long>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<unsigned long long>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<long long>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<float>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<double>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<std::string>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<std::vector<float>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<std::vector<double>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<std::vector<std::vector<float>>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<std::vector<std::vector<double>>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<Array<char>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<Array<int>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<Array<float>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<Array<double>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<Matrix<float, 4, 4>>;
extern template class ITKCommon_EXPORT_EXPLICIT MetaDataObject<Matrix<double>>;
 
ITK_GCC_PRAGMA_DIAG_POP()
 
} // end namespace itk
#undef ITKCommon_EXPORT_EXPLICIT
#endif