mitkSceneIOTestScenarioProvider.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 mitkSceneIOTestScenarioProvider_h_included
#define mitkSceneIOTestScenarioProvider_h_included

#include "mitkStandaloneDataStorage.h"

namespace mitk
{
  class SceneIOTestScenarioProvider
  {
  public:
    typedef DataStorage::Pointer (SceneIOTestScenarioProvider::*BuilderMethodPointer)() const;

    struct Scenario
    {
      std::string key;                      
      bool serializable;                    
      std::string referenceArchiveFilename; 
      bool referenceArchiveLoadable;        
      double comparisonPrecision; 

      DataStorage::Pointer BuildDataStorage() const;

      Scenario(const std::string &_key,
               const SceneIOTestScenarioProvider *_scenarioProvider,
               SceneIOTestScenarioProvider::BuilderMethodPointer _providerMethod,
               bool _isSerializable,
               const std::string &_referenceArchiveFilename,
               bool _isReferenceLoadable,
               double _comparisonPrecision);

    private:
      const SceneIOTestScenarioProvider *m_ScenarioProvider;
      SceneIOTestScenarioProvider::BuilderMethodPointer m_ProviderMethod;
    };

    typedef std::vector<Scenario> ScenarioList;

    ScenarioList GetAllScenarios() const;

  private:
    ScenarioList m_Scenarios;

    int m_HowMuchIsMany;

    void AddScenario(const std::string &key,
                     BuilderMethodPointer creator,
                     bool isSerializable,
                     const std::string &referenceArchiveFilename = std::string(),
                     bool isReferenceLoadable = false,
                     double comparisionPrecision = mitk::eps);

    DataStorage::Pointer EmptyStorage() const;

    DataStorage::Pointer OneEmptyNode() const;

    DataStorage::Pointer OneEmptyNamedNode() const;

    DataStorage::Pointer ManyTopLevelNodes() const;

    DataStorage::Pointer LineOfManyOnlyChildren() const;

    DataStorage::Pointer ComplicatedFamilySituation() const;

    DataStorage::Pointer Image() const;

    DataStorage::Pointer Surface() const;

    DataStorage::Pointer PointSet() const;

    DataStorage::Pointer GeometryData() const;

    DataStorage::Pointer SpecialProperties() const;

  public:
// Helper to simplify writing the registration
#define AddSaveAndRestoreScenario(name) AddScenario(#name, &mitk::SceneIOTestScenarioProvider::name, true);

    // this one in the header so it is clearly visible when someone
    // adds a test to the bottom of the list
    SceneIOTestScenarioProvider() : m_HowMuchIsMany(50)
    {
      AddSaveAndRestoreScenario(EmptyStorage);
      AddSaveAndRestoreScenario(OneEmptyNode);
      AddSaveAndRestoreScenario(OneEmptyNamedNode);
      AddSaveAndRestoreScenario(ManyTopLevelNodes);
      AddSaveAndRestoreScenario(LineOfManyOnlyChildren);
      AddSaveAndRestoreScenario(ComplicatedFamilySituation);

      AddSaveAndRestoreScenario(Image);
      AddSaveAndRestoreScenario(Surface);
      AddSaveAndRestoreScenario(PointSet);

      if (sizeof(size_t) != 4)
        // this test is deactivated on 32 bit systems since it fails
        // on the only 32 bit dartclient. To activate it there, one
        // would have to debug the precision problem on a 32 bit
        // machine and either adapt expectations or fix a bug.
        AddSaveAndRestoreScenario(GeometryData);

      AddSaveAndRestoreScenario(SpecialProperties);

      // AddScenario("GeometryData", &mitk::SceneIOTestScenarioProvider::GeometryData, true, std::string(), false,
      // mitk::eps);
    }

  }; // class

} // namespace

#endif