mitkDataStorageCompare.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef mitkDataStorageCompare_h_included
#define mitkDataStorageCompare_h_included

#include "mitkDataStorage.h"

namespace mitk
{
  class DataStorageCompare
  {
  public:
    typedef enum {
      CMP_Nothing = 0,      
      CMP_Hierarchy = 1,    
      CMP_Data = 2,         
      CMP_Properties = 4,   
      CMP_Mappers = 8,      
      CMP_Interactors = 16, 
      CMP_All = 0xfffffff,  
    } Tests;

    DataStorageCompare(const DataStorage *reference,
                       const DataStorage *test,
                       Tests flags = CMP_All,
                       double eps = mitk::eps);

    bool CompareVerbose();

    bool Compare(bool verbose = false);

    void Report();

  private:
    bool CompareHierarchy(bool verbose);

    bool CompareDataNodes(bool verbose);

    bool AreNodesEqual(const mitk::DataNode *reference, const mitk::DataNode *test, bool verbose = false);

    bool IsDataEqual(const mitk::BaseData *reference, const mitk::BaseData *test, bool verbose = false);

    bool ArePropertyListsEqual(const mitk::DataNode &reference, const mitk::DataNode &test, bool verbose = false);

    bool AreMappersEqual(const mitk::DataNode &reference, const mitk::DataNode &test, bool verbose);

    bool ArePropertyListsEqual(const mitk::PropertyList &reference,
                               const mitk::PropertyList &test,
                               bool verbose = false);

    double m_Eps;

    Tests m_TestAspects;

    DataStorage::ConstPointer m_ReferenceDS;

    DataStorage::ConstPointer m_TestDS;

    typedef std::multimap<std::string, DataNode::Pointer> HierarchyDescriptorMap;

    HierarchyDescriptorMap m_RefNodesByHierarchy;

    HierarchyDescriptorMap m_TestNodesByHierarchy;

    void DescribeHierarchyOfNodes(DataStorage::ConstPointer storage, HierarchyDescriptorMap &result);

    std::string GenerateNodeDescriptor(mitk::DataNode::Pointer node);

    std::string GenerateHierarchyDescriptor(DataNode::Pointer node, DataStorage::ConstPointer storage);

    bool m_HierarchyPassed;
    bool m_DataPassed;
    bool m_PropertiesPassed;
    bool m_MappersPassed;
    bool m_InteractorsPassed;
    int m_AspectsFailed;

  }; // class

  inline DataStorageCompare::Tests operator|(DataStorageCompare::Tests a, DataStorageCompare::Tests b)
  {
    return static_cast<DataStorageCompare::Tests>(static_cast<int>(a) | static_cast<int>(b));
  }

} // namespace

#endif