mitkSceneIO.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 mitkSceneIO_h
#define mitkSceneIO_h
 
#include <MitkSceneSerializationExports.h>
 
#include <mitkDataStorage.h>
#include <mitkNodePredicateBase.h>
 
#include <Poco/Zip/ZipLocalFileHeader.h>
 
namespace tinyxml2
{
  class XMLDocument;
  class XMLElement;
}
 
namespace mitk
{
  class BaseData;
  class IPropertyTransience;
  class PropertyList;
 
  class MITKSCENESERIALIZATION_EXPORT SceneIO : public itk::Object
  {
  public:
    mitkClassMacroItkParent(SceneIO, itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
      typedef DataStorage::SetOfObjects FailedBaseDataListType;
 
    virtual DataStorage::Pointer LoadScene(const std::string &filename,
                                           DataStorage *storage = nullptr,
                                           bool clearStorageFirst = false);
 
    virtual DataStorage::Pointer LoadSceneUnzipped(const std::string &indexfilename,
      DataStorage *storage = nullptr,
      bool clearStorageFirst = false);
 
 
    virtual bool SaveScene(DataStorage::SetOfObjects::ConstPointer sceneNodes,
                           const DataStorage *storage,
                           const std::string &filename);
 
    const FailedBaseDataListType *GetFailedNodes();
 
    const PropertyList *GetFailedProperties();
 
  protected:
    SceneIO();
    ~SceneIO() override;
 
    std::string CreateEmptyTempDirectory();
 
    tinyxml2::XMLElement *SaveBaseData(tinyxml2::XMLDocument &doc, BaseData *data, const std::string &filenamehint, bool &error);
    tinyxml2::XMLElement *SavePropertyList(tinyxml2::XMLDocument &doc, const IPropertyTransience *transience, PropertyList *propertyList, const BaseData *nodeData, const std::string &filenamehint);
 
    void OnUnzipError(const void *pSender, std::pair<const Poco::Zip::ZipLocalFileHeader, const std::string> &info);
    void OnUnzipOk(const void *pSender, std::pair<const Poco::Zip::ZipLocalFileHeader, const Poco::Path> &info);
 
    FailedBaseDataListType::Pointer m_FailedNodes;
    PropertyList::Pointer m_FailedProperties;
 
    std::string m_WorkingDirectory;
    unsigned int m_UnzipErrors;
  };
}
 
#endif