mitkCollectionReader.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 MITK_COLLECTION_READER_H
#define MITK_COLLECTION_READER_H

#include "mitkCommon.h"
#include "mitkDataCollection.h"
#include <MitkDataCollectionExports.h>

// VTK
#include <vtkXMLParser.h>

namespace mitk {
  class MITKDATACOLLECTION_EXPORT CollectionReader : public vtkXMLParser
  {
  public:

    typedef std::vector<std::vector<std::string> > FileListType;

    DataCollection::Pointer LoadCollection(const std::string& xmlFileName);

    void AddDataElementIds(std::vector<std::string> dataElemetIds);
    void AddSubColIds(std::vector<std::string> subColIds);

    void SetDataItemNames(std::vector<std::string> itemNames);

    void ClearDataElementIds();
    void ClearSubColIds();

    void Clear();

    static DataCollection::Pointer FolderToCollection(std::string folder, std::vector<std::string> suffixes,std::vector<std::string> seriesNames,  bool allowGaps);

    static FileListType GenerateFileLists(std::string folder, std::vector<std::string> suffixes, bool allowGaps = false);

    static FileListType SanitizeFileList(FileListType list);

    CollectionReader();
    ~CollectionReader();
  protected:

    void  StartElement (const char* elementName, const char **atts);
    void  EndElement (const char* elementName);

  private:
    std::string ReadXMLStringAttribut( std::string name, const char** atts);
    bool ReadXMLBooleanAttribut( std::string name, const char** atts );
    int ReadXMLIntegerAttribut( std::string name, const char** atts );

    DataCollection::Pointer m_Collection;
    DataCollection::Pointer m_SubCollection;
    DataCollection::Pointer m_DataItemCollection;

    std::vector<std::string> m_SelectedSubColIds;

    std::vector<std::string> m_SelectedDataItemIds;

    std::vector<std::string> m_SelectedDataItemNames;

    bool m_ColIgnore;
    bool m_ItemIgnore;

    std::string m_BaseDir;
  };
} // namespace mitk

#endif /* MITK_COLLECTION_READER_H */