MRML node to represent a 3D surface model. More...

#include <Libs/MRML/Core/vtkMRMLStorableNode.h>

Inheritance diagram for vtkMRMLStorableNode:

Collaboration diagram for vtkMRMLStorableNode:

Public Types
typedef vtkMRMLTransformableNode	Superclass
Public Member Functions
void	AddAndObserveStorageNodeID (const char *storageNodeID)
virtual void	Copy (vtkMRMLNode *node)
virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()
virtual vtkMRMLNode *	CreateNodeInstance ()=0
	MRMLNode methods.
virtual const char *	GetClassName ()
virtual bool	GetModifiedSinceRead ()
virtual const char *	GetNodeTagName ()=0
vtkMRMLStorageNode *	GetNthStorageNode (int n)
const char *	GetNthStorageNodeID (int n)
int	GetNumberOfStorageNodes ()
const char *	GetSlicerDataType ()
vtkMRMLStorageNode *	GetStorageNode ()
const char *	GetStorageNodeID ()
virtual vtkTagTable *	GetUserTagTable ()
	Methods for user-specified metadata.
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessMRMLEvents (vtkObject , unsigned long, void )
virtual void	ReadXMLAttributes (const char **atts)
void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
void	SetAndObserveStorageNodeID (const char *storageNodeID)
void	SetSlicerDataType (const char *type)
virtual void	UpdateScene (vtkMRMLScene *scene)
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)
Protected Member Functions
virtual char *	GetStorageNodeReferenceRererenceMRMLAttributeName ()
virtual char *	GetStorageNodeReferenceRole ()
virtual vtkTimeStamp	GetStoredTime ()
void	operator= (const vtkMRMLStorableNode &)
virtual void	SetStorageNodeReferenceRererenceMRMLAttributeName (const char *)
virtual void	SetStorageNodeReferenceRole (const char *)
	vtkMRMLStorableNode ()
	vtkMRMLStorableNode (const vtkMRMLStorableNode &)
	~vtkMRMLStorableNode ()
Protected Attributes
std::string	SlicerDataType
vtkTimeStamp	StorableModifiedTime
char *	StorageNodeReferenceRererenceMRMLAttributeName
char *	StorageNodeReferenceRole
vtkTagTable *	UserTagTable

Detailed Description

MRML node to represent a 3D surface model.

Model nodes describe polygonal data. Models are assumed to have been constructed with the orientation and voxel dimensions of the original segmented volume.

Definition at line 33 of file vtkMRMLStorableNode.h.

Member Typedef Documentation

typedef vtkMRMLTransformableNode vtkMRMLStorableNode::Superclass

Reimplemented from vtkMRMLTransformableNode.

Definition at line 36 of file vtkMRMLStorableNode.h.

Constructor & Destructor Documentation

vtkMRMLStorableNode::vtkMRMLStorableNode ( ) [protected]

vtkMRMLStorableNode::~vtkMRMLStorableNode ( ) [protected]

vtkMRMLStorableNode::vtkMRMLStorableNode ( const vtkMRMLStorableNode & ) [protected]

Member Function Documentation

void vtkMRMLStorableNode::AddAndObserveStorageNodeID ( const char * storageNodeID ) [inline]

Definition at line 81 of file vtkMRMLStorableNode.h.

virtual void vtkMRMLStorableNode::Copy ( vtkMRMLNode * node ) [virtual]

Copy the node's attributes to this object

Reimplemented from vtkMRMLNode.

virtual vtkMRMLStorageNode* vtkMRMLStorableNode::CreateDefaultStorageNode ( ) [virtual]

Create a storage node for this node type or NULL if it doesn't have one. Null by default. This must be overwritten by subclasses that use storage nodes.

Reimplemented in vtkMRMLBSplineTransformNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLDoubleArrayNode, vtkMRMLFiducialListNode, vtkMRMLLinearTransformNode, vtkMRMLModelNode, vtkMRMLNonlinearTransformNode, vtkMRMLScalarVolumeNode, vtkMRMLSceneViewNode, vtkMRMLTensorVolumeNode, vtkMRMLTransformNode, vtkMRMLUnstructuredGridNode, vtkMRMLVectorVolumeNode, vtkMRMLAnnotationAngleNode, vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationNode, vtkMRMLAnnotationRulerNode, vtkMRMLAnnotationSnapshotNode, vtkMRMLFiberBundleNode, and vtkMRMLVolumePropertyNode.

virtual vtkMRMLNode* vtkMRMLStorableNode::CreateNodeInstance ( ) [pure virtual]

MRMLNode methods.

Implements vtkMRMLTransformableNode.

virtual const char* vtkMRMLStorableNode::GetClassName ( ) [virtual]

Reimplemented from vtkMRMLTransformableNode.

virtual bool vtkMRMLStorableNode::GetModifiedSinceRead ( ) [virtual]

Returns true if the node is more recent than the file on disk. This information can be used by the application to know which node has been modified since it has been last read or written. Only storable properties are considered: even if a "non storable" property (e.g. color of a mesh) is modified after the node is being loaded, GetModifiedSinceRead() should return false; the new property value won't be stored on file (only in the MRML scene). By default, calling Modified() on the node doesn't make the node "modified since read", only calling Modified() on StorableModifiedTime does. GetModifiedSinceRead() can be overwritten to handle special storable property modification time.

See also:: GetStoredTime() StorableModifiedTime Modified()

Reimplemented in vtkMRMLColorNode, vtkMRMLModelNode, vtkMRMLTransformNode, vtkMRMLVolumeNode, and vtkMRMLVolumePropertyNode.

virtual const char* vtkMRMLStorableNode::GetNodeTagName ( ) [pure virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLTransformableNode.

vtkMRMLStorageNode* vtkMRMLStorableNode::GetNthStorageNode ( int n )

Get associated display MRML node

const char* vtkMRMLStorableNode::GetNthStorageNodeID ( int n ) [inline]

Definition at line 107 of file vtkMRMLStorableNode.h.

int vtkMRMLStorableNode::GetNumberOfStorageNodes ( ) [inline]

Definition at line 102 of file vtkMRMLStorableNode.h.

const char* vtkMRMLStorableNode::GetSlicerDataType ( )

vtkMRMLStorageNode* vtkMRMLStorableNode::GetStorageNode ( )

const char* vtkMRMLStorableNode::GetStorageNodeID ( ) [inline]

Definition at line 112 of file vtkMRMLStorableNode.h.

virtual char* vtkMRMLStorableNode::GetStorageNodeReferenceRererenceMRMLAttributeName ( ) [protected, virtual]

virtual char* vtkMRMLStorableNode::GetStorageNodeReferenceRole ( ) [protected, virtual]

virtual vtkTimeStamp vtkMRMLStorableNode::GetStoredTime ( ) [protected, virtual]

Compute when the storable node was read/written for the last time. This information is used by GetModifiedSinceRead() to know if the node has been modified since the last time it was read or written By default, it retrieves the information from the associated storage nodes.

See also:: GetModifiedSinceRead(), StorableModifiedTime, vtkMRMLStorageNode::GetStoredTime()

virtual vtkTagTable* vtkMRMLStorableNode::GetUserTagTable ( ) [virtual]

Methods for user-specified metadata.

virtual int vtkMRMLStorableNode::IsA ( const char * type ) [virtual]

Reimplemented from vtkMRMLTransformableNode.

static int vtkMRMLStorableNode::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkMRMLTransformableNode.

void vtkMRMLStorableNode::operator= ( const vtkMRMLStorableNode & ) [protected]

void vtkMRMLStorableNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLBSplineTransformNode, vtkMRMLColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLDisplayableNode, vtkMRMLDoubleArrayNode, vtkMRMLFiducialListNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLGlyphableVolumeDisplayPropertiesNode, vtkMRMLGridTransformNode, vtkMRMLLinearTransformNode, vtkMRMLModelNode, vtkMRMLNonlinearTransformNode, vtkMRMLPETProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLScalarVolumeNode, vtkMRMLSceneViewNode, vtkMRMLTensorVolumeNode, vtkMRMLTransformNode, vtkMRMLUnstructuredGridNode, vtkMRMLVectorVolumeNode, vtkMRMLVolumeNode, vtkMRMLAnnotationNode, vtkMRMLFiberBundleNode, and vtkMRMLVolumePropertyNode.

virtual void vtkMRMLStorableNode::ProcessMRMLEvents	(	vtkObject *	,
		unsigned	long,
		void *
	)		`[virtual]`

virtual void vtkMRMLStorableNode::ReadXMLAttributes ( const char ** atts ) [virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLTransformableNode.

static vtkMRMLStorableNode* vtkMRMLStorableNode::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkMRMLTransformableNode.

void vtkMRMLStorableNode::SetAndObserveNthStorageNodeID	(	int	n,
		const char *	storageNodeID
	)		`[inline]`

Definition at line 86 of file vtkMRMLStorableNode.h.

void vtkMRMLStorableNode::SetAndObserveStorageNodeID ( const char * storageNodeID ) [inline]

String ID of the storage MRML node

Definition at line 76 of file vtkMRMLStorableNode.h.

void vtkMRMLStorableNode::SetSlicerDataType ( const char * type )

This is describes the type of data stored in the nodes storage node(s). It's an informatics metadata mechanism so that Slicer knows what kinds of nodes to create to receive downloaded datasets, and works around potential ambiguity of file extensions, etc. Method is called when storage nodes are created. The method gets applied to any storable data that should be saved with, and loaded with the scene, including nodes that are hidden from editors like scalar overlays.

virtual void vtkMRMLStorableNode::SetStorageNodeReferenceRererenceMRMLAttributeName ( const char * ) [protected, virtual]

virtual void vtkMRMLStorableNode::SetStorageNodeReferenceRole ( const char * ) [protected, virtual]

virtual void vtkMRMLStorableNode::UpdateScene ( vtkMRMLScene * scene ) [virtual]

virtual void vtkMRMLStorableNode::WriteXML	(	ostream &	of,
		int	indent
	)		`[virtual]`

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLTransformableNode.

Member Data Documentation

std::string vtkMRMLStorableNode::SlicerDataType [protected]

SlicerDataType records the kind of storage node that holds the data. Set in each subclass.

Definition at line 166 of file vtkMRMLStorableNode.h.

vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime [protected]

Last time when a storable property was modified. This is used to know if the node has been modified since the last time it was read or written on disk. The time stamp must be updated (Modified()) - in the derived classes - any time a "storable" property is changed. A storable property is a property that is stored on disk, not in the MRML scene: e.g. points and cells for a Model, voxel intensity or origin for a Volume...