vtkMRMLMarkupsJsonElement.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Portions (c) Copyright Brigham and Women's Hospital (BWH) 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.
 
==============================================================================*/
 
// Markups Module MRML storage nodes
//
// Helper objects for reading/writing markups from/to JSON file
//
 
#ifndef vtkMRMLMarkupsJsonElement_h
#define vtkMRMLMarkupsJsonElement_h
 
// Markups includes
#include "vtkSlicerMarkupsModuleMRMLExport.h"
#include "vtkMRMLMessageCollection.h"
 
#include "vtkSmartPointer.h"
#include "vtkNew.h"
 
#include <vector>
 
class vtkCodedEntry;
 
class VTK_SLICER_MARKUPS_MODULE_MRML_EXPORT vtkMRMLMarkupsJsonElement : public vtkObject
{
public:
  static vtkMRMLMarkupsJsonElement* New();
  vtkTypeMacro(vtkMRMLMarkupsJsonElement, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  std::string GetSchema();
 
  bool HasMember(const char* propertyName);
 
  std::string GetStringProperty(const char* propertyName);
  bool GetStringProperty(const char* propertyName, std::string& propertyValue);
 
  bool GetBoolProperty(const char* propertyName);
 
  bool GetDoubleProperty(const char* propertyName, double& propertyValue);
 
  double GetDoubleProperty(const char* propertyName);
 
  bool GetIntProperty(const char* propertyName, int& propertyValue);
 
  int GetIntProperty(const char* propertyName);
 
  bool GetVectorProperty(const char* propertyName, double* v, int numberOfComponents = 3);
 
  bool GetMatrix4x4Property(const char* propertyName, double v[16], bool flipRasLps);
 
  bool GetStringVectorProperty(const char* propertyName, std::vector<std::string>& arrayValues);
 
  VTK_NEWINSTANCE
  vtkCodedEntry* GetCodedEntryProperty(const char* propertyName);
 
  VTK_NEWINSTANCE
  vtkDoubleArray* GetDoubleArrayProperty(const char* propertyName);
 
  bool GetArrayItemsStringProperty(const char* arrayName, const char* propertyName, std::vector<std::string>& propertyValues);
 
  VTK_NEWINSTANCE
  vtkMRMLMarkupsJsonElement* GetArrayProperty(const char* arrayName);
 
  VTK_NEWINSTANCE
  vtkMRMLMarkupsJsonElement* GetObjectProperty(const char* objectName);
 
  bool IsArray();
 
  int GetArraySize();
 
  VTK_NEWINSTANCE
  vtkMRMLMarkupsJsonElement* GetArrayItem(int childItemIndex);
 
  vtkGetObjectMacro(UserMessages, vtkMRMLMessageCollection);
 
  bool HasErrors();
 
protected:
  vtkMRMLMarkupsJsonElement();
  ~vtkMRMLMarkupsJsonElement() override;
  vtkMRMLMarkupsJsonElement(const vtkMRMLMarkupsJsonElement&);
  void operator=(const vtkMRMLMarkupsJsonElement&);
 
  vtkNew<vtkMRMLMessageCollection> UserMessages;
 
  class vtkInternal;
  vtkInternal* Internal;
  friend class vtkInternal;
  friend class vtkMRMLMarkupsJsonReader;
};
 
class VTK_SLICER_MARKUPS_MODULE_MRML_EXPORT vtkMRMLMarkupsJsonReader : public vtkObject
{
public:
 
  static vtkMRMLMarkupsJsonReader* New();
  vtkTypeMacro(vtkMRMLMarkupsJsonReader, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  VTK_NEWINSTANCE
  vtkMRMLMarkupsJsonElement* ReadFromFile(const char* filePath);
 
  vtkGetObjectMacro(UserMessages, vtkMRMLMessageCollection);
 
  bool HasErrors();
 
protected:
  vtkMRMLMarkupsJsonReader();
  ~vtkMRMLMarkupsJsonReader() override;
  vtkMRMLMarkupsJsonReader(const vtkMRMLMarkupsJsonReader&);
  void operator=(const vtkMRMLMarkupsJsonReader&);
 
  vtkNew<vtkMRMLMessageCollection> UserMessages;
};
 
 
class VTK_SLICER_MARKUPS_MODULE_MRML_EXPORT vtkMRMLMarkupsJsonWriter : public vtkObject
{
public:
 
  static vtkMRMLMarkupsJsonWriter *New();
  vtkTypeMacro(vtkMRMLMarkupsJsonWriter,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  bool WriteToFileBegin(const char* filePath, const char* schema);
 
  bool WriteToFileEnd();
 
  void WriteArrayPropertyStart(const std::string& propertyName);
  void WriteArrayPropertyEnd();
 
  void WriteObjectStart();
  void WriteObjectEnd();
 
  void WriteObjectPropertyStart(const std::string& propertyName);
  void WriteObjectPropertyEnd();
 
  void WriteStringProperty(const std::string& propertyName, const std::string& propertyValue);
  void WriteStringVectorProperty(const std::string& propertyName, const std::vector<std::string>& arrayValues);
  void WriteCodedEntryProperty(const std::string& propertyName, vtkCodedEntry* codedEntry);
  void WriteStringPropertyIfNotEmpty(const std::string& propertyName, const std::string& propertyValue);
  void WriteBoolProperty(const std::string& propertyName, bool propertyValue);
  void WriteIntProperty(const std::string& propertyName, int propertyValue);
  void WriteDoubleProperty(const std::string& propertyName, double propertyValue);
  void WriteVectorProperty(const std::string& propertyName, double* v, int numberOfComponents = 3);
  void WriteMatrix4x4Property(const std::string& propertyName, double v[16], bool flipRasLps);
  void WriteDoubleArrayProperty(const char* propertyName, vtkDoubleArray* doubleArray);
 
  vtkGetObjectMacro(UserMessages, vtkMRMLMessageCollection);
 
  bool HasErrors();
 
protected:
  vtkMRMLMarkupsJsonWriter();
  ~vtkMRMLMarkupsJsonWriter() override;
  vtkMRMLMarkupsJsonWriter(const vtkMRMLMarkupsJsonWriter&);
  void operator=(const vtkMRMLMarkupsJsonWriter&);
 
  vtkNew<vtkMRMLMessageCollection> UserMessages;
 
  class vtkInternal;
  vtkInternal* Internal;
  friend class vtkInternal;
};
 
#endif