vtkMRMLFileReader.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 __vtkMRMLFileReader_h
#define __vtkMRMLFileReader_h
 
#include "vtkMRMLFileIOHandler.h"
 
class vtkMRMLIOProperties;

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

  virtual double CanLoadFileConfidence(const std::string& filePath);

  virtual bool CanLoadFile(const std::string& filePath);

  std::vector<std::string> GetSupportedNameFilters(const std::string& filePath);
  std::vector<std::string> GetSupportedNameFilters(const std::string& filePath, int& longestExtensionMatch);

  virtual bool Load(vtkMRMLIOProperties* properties);

  virtual std::string ExamineFileList(std::vector<std::string>& fileList, vtkMRMLIOProperties* ioProperties);

  virtual double ExamineFileListConfidence(std::vector<std::string>& fileList, vtkMRMLIOProperties* ioProperties);

  const std::vector<std::string>& GetLoadedNodeIDs() const;
  void SetLoadedNodeIDs(const std::vector<std::string>& nodeIDs);
  void AddLoadedNodeID(const std::string& nodeID);
  void ClearLoadedNodeIDs();

  vtkGetMacro(ConfidenceForMatchingExtension, double);
  vtkSetMacro(ConfidenceForMatchingExtension, double);
 
protected:
  vtkMRMLFileReader();
  ~vtkMRMLFileReader() override;

  static std::string ReadFileHeader(const std::string& filePath, size_t maxLength);

  static bool EndsWithNoCase(const std::string& text, const std::string& suffix);
 
  double ConfidenceForMatchingExtension{ 0.5 };
  std::vector<std::string> LoadedNodeIDs;
 
private:
  vtkMRMLFileReader(const vtkMRMLFileReader&) = delete;
  void operator=(const vtkMRMLFileReader&) = delete;
};
 
#endif