vtkMRMLStorableNode.h

Go to the documentation of this file.

/*=auto=========================================================================
 
  Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) All Rights Reserved.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Program:   3D Slicer
  Module:    $RCSfile: vtkMRMLStorableNode.h,v $
  Date:      $Date: 2006/03/19 17:12:28 $
  Version:   $Revision: 1.6 $
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLStorableNode_h
#define __vtkMRMLStorableNode_h
 
// MRML includes
#include "vtkMRMLNode.h"
class vtkMRMLStorageNode;
 
// VTK includes
class vtkTagTable;
 
// STD includes
#include <vector>

class VTK_MRML_EXPORT vtkMRMLStorableNode : public vtkMRMLNode
{
public:
  vtkTypeMacro(vtkMRMLStorableNode, vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  vtkGetObjectMacro(UserTagTable, vtkTagTable);
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
 
  vtkMRMLNode* CreateNodeInstance() override = 0;
 
  const char* GetNodeTagName() override = 0;

  void ReadXMLAttributes(const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  void Copy(vtkMRMLNode* node) override;

  vtkMRMLCopyContentMacro(vtkMRMLStorableNode);

  void UpdateScene(vtkMRMLScene* scene) override;

  void ProcessMRMLEvents(vtkObject* /*caller*/, unsigned long /*event*/, void* /*callData*/) override;

  void SetAndObserveStorageNodeID(const char* storageNodeID);
  void AddAndObserveStorageNodeID(const char* storageNodeID);
  void SetAndObserveNthStorageNodeID(int n, const char* storageNodeID);

  bool HasStorageNodeID(const char* storageNodeID);

  void SetSlicerDataType(const char* type);
  const char* GetSlicerDataType();
 
  int GetNumberOfStorageNodes();
  const char* GetNthStorageNodeID(int n);
  const char* GetStorageNodeID();

  vtkMRMLStorageNode* GetNthStorageNode(int n);
  vtkMRMLStorageNode* GetStorageNode();

  virtual vtkMRMLStorageNode* CreateDefaultStorageNode();

  virtual std::string GetDefaultStorageNodeClassName(const char* filename = nullptr);

  virtual bool AddDefaultStorageNode(const char* filename = nullptr);

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

  virtual vtkMRMLStorageNode* CreateDefaultSequenceStorageNode();

  virtual bool GetModifiedSinceRead();

  virtual void StorableModified();
 
protected:
  vtkMRMLStorableNode();
  ~vtkMRMLStorableNode() override;
  vtkMRMLStorableNode(const vtkMRMLStorableNode&);
  void operator=(const vtkMRMLStorableNode&);
 
  static const char* StorageNodeReferenceRole;
  static const char* StorageNodeReferenceMRMLAttributeName;
 
  virtual const char* GetStorageNodeReferenceRole();
  virtual const char* GetStorageNodeReferenceMRMLAttributeName();
 
  vtkTagTable* UserTagTable;

  std::string SlicerDataType;
 
  std::string DefaultSequenceStorageNodeClassName;

  virtual vtkTimeStamp GetStoredTime();

  vtkTimeStamp StorableModifiedTime;
};
 
#endif