vtkMRMLFileIOHandler.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  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.
 
==============================================================================*/
 
#ifndef __vtkMRMLFileIOHandler_h
#define __vtkMRMLFileIOHandler_h
 
#include "vtkMRMLIOProperties.h"
#include "vtkMRMLLogicExport.h"
 
#include <vtkMRMLMessageCollection.h>
 
#include <vtkNew.h>
#include <vtkObject.h>
#include <vtkWeakPointer.h>
 
#include <string>
#include <vector>
 
class vtkMRMLScene;
class vtkMRMLFileIOManager;
class vtkMRMLIOOptionsDescription;

class VTK_MRML_LOGIC_EXPORT vtkMRMLFileIOHandler : public vtkObject
{
public:
  static vtkMRMLFileIOHandler* New();
  vtkTypeMacro(vtkMRMLFileIOHandler, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkGetMacro(FileType, std::string);
  vtkSetMacro(FileType, std::string);

  vtkGetMacro(Description, std::string);
  vtkSetMacro(Description, std::string);

  void SetNameFilters(const std::vector<std::string>& filters);
  const std::vector<std::string>& GetNameFilters() const { return this->NameFilters; }

  const std::vector<std::string>& GetExtensions() const { return this->Extensions; }

  virtual bool MatchesExtension(const std::string& filePath) const;
  virtual std::string GetMatchedExtension(const std::string& filePath) const;

  virtual void SetScene(vtkMRMLScene* scene);
  vtkMRMLScene* GetScene() const;

  vtkMRMLMessageCollection* GetUserMessages() const;

  virtual bool IsWriter() const { return false; }

  vtkMRMLFileIOManager* GetFileIOManager() const;
  void SetFileIOManager(vtkMRMLFileIOManager* manager);



  virtual void GetOptionsDescription(vtkMRMLIOOptionsDescription* description);

  void FillOptionsDescription(vtkMRMLIOProperties* properties, vtkMRMLIOOptionsDescription* description);

  std::string GetOptionsDescriptionJSON(vtkMRMLIOProperties* properties);

  void GetOptionValues(vtkMRMLIOProperties* properties, vtkMRMLIOProperties* values);

  vtkMRMLIOProperties* GetOptionDefaults();

  static std::vector<std::string> GetMatchingNameFilters(const std::string& filePath,
                                                         const std::vector<std::string>& nameFilters,
                                                         bool requireReadableFile,
                                                         int* longestExtensionMatch = nullptr);

  static std::vector<std::string> NameFilterToWildcards(const std::string& nameFilter);

  static bool WildcardMatch(const std::string& pattern, const std::string& text);

  static std::string LongestMatchingExtension(const std::string& filePath, const std::vector<std::string>& extensions);
  static std::vector<std::string> ExtensionsFromNameFilter(const std::string& nameFilter);
 
protected:
  vtkMRMLFileIOHandler();
  ~vtkMRMLFileIOHandler() override;
 
  std::string FileType;
  std::string Description;
  std::vector<std::string> NameFilters;
  std::vector<std::string> Extensions;
  vtkWeakPointer<vtkMRMLScene> Scene;
  vtkWeakPointer<vtkMRMLFileIOManager> FileIOManager;
  vtkNew<vtkMRMLIOProperties> OptionDefaults;
  vtkNew<vtkMRMLMessageCollection> UserMessages;
 
private:
  vtkMRMLFileIOHandler(const vtkMRMLFileIOHandler&) = delete;
  void operator=(const vtkMRMLFileIOHandler&) = delete;
};
 
#endif