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 "vtkMRMLTransformableNode.h"
class vtkMRMLStorageNode;

// VTK includes
class vtkTagTable;

// STD includes
#include <vector>

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

  virtual const char* GetNodeTagName() = 0;

  virtual void ReadXMLAttributes( const char** atts);
  
  virtual void WriteXML(ostream& of, int indent);

  virtual void Copy(vtkMRMLNode *node);

  virtual void UpdateScene(vtkMRMLScene *scene);

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

  void SetAndObserveStorageNodeID(const char *storageNodeID)
  {
    this->SetAndObserveNodeReferenceID(this->GetStorageNodeReferenceRole(), storageNodeID);
  }

  void AddAndObserveStorageNodeID(const char *storageNodeID)
  {
    this->AddAndObserveNodeReferenceID(this->GetStorageNodeReferenceRole(), storageNodeID);
  }

  void SetAndObserveNthStorageNodeID(int n, const char *storageNodeID)
  {
    this->SetAndObserveNthNodeReferenceID(this->GetStorageNodeReferenceRole(), n, storageNodeID);
  }

  void SetSlicerDataType ( const char *type );
  const char *GetSlicerDataType ();
  
  int GetNumberOfStorageNodes()
  {
    return this->GetNumberOfNodeReferences(this->GetStorageNodeReferenceRole());
  }

  const char *GetNthStorageNodeID(int n)
  {
    return this->GetNthNodeReferenceID(this->GetStorageNodeReferenceRole(), n);
  }

  const char *GetStorageNodeID()
  {
  return this->GetNthStorageNodeID(0);
  }

  vtkMRMLStorageNode* GetNthStorageNode(int n);

  vtkMRMLStorageNode* GetStorageNode();

  //std::vector<vtkMRMLStorageNode*> GetStorageNodes()const;

  virtual vtkMRMLStorageNode* CreateDefaultStorageNode();

  virtual bool GetModifiedSinceRead();

 protected:
  vtkMRMLStorableNode();
  ~vtkMRMLStorableNode();
  vtkMRMLStorableNode(const vtkMRMLStorableNode&);
  void operator=(const vtkMRMLStorableNode&);

  char* StorageNodeReferenceRole;
  char* StorageNodeReferenceRererenceMRMLAttributeName;

  vtkSetStringMacro(StorageNodeReferenceRole);
  vtkGetStringMacro(StorageNodeReferenceRole);
 
  vtkSetStringMacro(StorageNodeReferenceRererenceMRMLAttributeName);
  vtkGetStringMacro(StorageNodeReferenceRererenceMRMLAttributeName);


  vtkTagTable *UserTagTable;

  std::string SlicerDataType;

  virtual vtkTimeStamp GetStoredTime();

  vtkTimeStamp StorableModifiedTime;
};

#endif