vtkSlicerScriptedFileReaderBridge.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.
 
  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 __vtkSlicerScriptedFileReaderBridge_h
#define __vtkSlicerScriptedFileReaderBridge_h
 
// Slicer includes
#include "vtkSlicerBaseLogicExport.h"
 
// MRML includes
#include <vtkMRMLFileReader.h>
 
// VTK includes
#include <vtkPython.h>
 
// STD includes
#include <string>
#include <vector>
 
class vtkSmartPyObject;
class vtkWeakReference;

class VTK_SLICER_BASE_LOGIC_EXPORT vtkSlicerScriptedFileReaderBridge : public vtkMRMLFileReader
{
public:
  static vtkSlicerScriptedFileReaderBridge* New();
  vtkTypeMacro(vtkSlicerScriptedFileReaderBridge, vtkMRMLFileReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  bool CanLoadFile(const std::string& filePath) override;
  double CanLoadFileConfidence(const std::string& filePath) override;
  bool Load(vtkMRMLIOProperties* properties) override;
  std::string ExamineFileList(std::vector<std::string>& fileList, vtkMRMLIOProperties* ioProperties) override;
  double ExamineFileListConfidence(std::vector<std::string>& fileList, vtkMRMLIOProperties* ioProperties) override;
  void GetOptionsDescription(vtkMRMLIOOptionsDescription* description) override;

  vtkWeakReference* GetWeakReference();

  static PyObject* PropertiesToDict(vtkMRMLIOProperties* properties);
  static void UpdatePropertiesFromDict(vtkMRMLIOProperties* properties, PyObject* dict);
 
protected:
  vtkSlicerScriptedFileReaderBridge();
  ~vtkSlicerScriptedFileReaderBridge() override;

  void UnRegisterInternal(vtkObjectBase* o, vtkTypeBool check) override;
 
private:
  vtkSlicerScriptedFileReaderBridge(const vtkSlicerScriptedFileReaderBridge&) = delete;
  void operator=(const vtkSlicerScriptedFileReaderBridge&) = delete;

  PyObject* CallPythonMethod(const vtkSmartPyObject& pyArgs, const std::string& fName, bool decrementResult, bool* callFailed = nullptr);
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
#endif