vtkMRMLStorageNode Class Reference

#include <vtkMRMLStorageNode.h>

Inheritance diagram for vtkMRMLStorageNode:

List of all members.

Public Types
enum	{   Idle, Pending, Scheduled, Transferring,   TransferDone, Cancelled }
Public Member Functions
unsigned int	AddFileName (const char *fileName)
unsigned int	AddURI (const char *uri)
virtual void	Copy (vtkMRMLNode *node)
virtual vtkMRMLNode *	CreateNodeInstance ()=0
int	FileNameIsInList (const char *fileName)
const char *	GetAbsoluteFilePath (const char *inputPath)
virtual const char *	GetDefaultWriteFileExtension ()
std::string	GetFullNameFromFileName ()
std::string	GetFullNameFromNthFileName (int n)
virtual const char *	GetNodeTagName ()=0
const char *	GetNthFileName (int n) const
const char *	GetNthURI (int n)
int	GetNumberOfFileNames () const
int	GetNumberOfURIs ()
const char *	GetReadStateAsString ()
const char *	GetStateAsString (int state)
virtual vtkStringArray *	GetSupportedWriteFileTypes ()
const char *	GetWriteStateAsString ()
int	IsFilePathRelative (const char *filepath)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
virtual int	ReadData (vtkMRMLNode *refNode)=0
virtual void	ReadXMLAttributes (const char **atts)
void	ResetFileNameList ()
void	ResetNthFileName (int n, const char *fileName)
void	ResetNthURI (int n, const char *uri)
void	ResetURIList ()
void	SetDataDirectory (const char *dataDirName)
void	SetReadStateCancelled ()
void	SetReadStateIdle ()
void	SetReadStatePending ()
void	SetReadStateScheduled ()
void	SetReadStateTransferDone ()
void	SetReadStateTransferring ()
void	SetURIPrefix (const char *uriPrefix)
void	SetWriteStateCancelled ()
void	SetWriteStateIdle ()
void	SetWriteStatePending ()
void	SetWriteStateScheduled ()
void	SetWriteStateTransferDone ()
void	SetWriteStateTransferring ()
void	StageReadData (vtkMRMLNode *refNode)
void	StageWriteData (vtkMRMLNode *refNode)
virtual int	SupportedFileType (const char *fileName)
	vtkBooleanMacro (UseCompression, int)
	vtkGetMacro (WriteState, int)
	vtkGetMacro (ReadState, int)
	vtkGetMacro (UseCompression, int)
	vtkGetObjectMacro (URIHandler, vtkURIHandler)
	vtkGetStringMacro (TempFileName)
	vtkGetStringMacro (WriteFileFormat)
	vtkGetStringMacro (URI)
	vtkGetStringMacro (FileName)
	vtkSetMacro (WriteState, int)
	vtkSetMacro (ReadState, int)
	vtkSetMacro (UseCompression, int)
	vtkSetObjectMacro (URIHandler, vtkURIHandler)
	vtkSetStringMacro (TempFileName)
	vtkSetStringMacro (WriteFileFormat)
	vtkSetStringMacro (URI)
	vtkSetStringMacro (FileName)
	vtkTypeMacro (vtkMRMLStorageNode, vtkMRMLNode)
virtual int	WriteData (vtkMRMLNode *refNode)=0
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static vtkMRMLStorageNode *	New ()
Protected Member Functions
virtual void	InitializeSupportedWriteFileTypes ()
void	operator= (const vtkMRMLStorageNode &)
	vtkMRMLStorageNode (const vtkMRMLStorageNode &)
	vtkMRMLStorageNode ()
	~vtkMRMLStorageNode ()
Protected Attributes
char *	FileName
std::vector< std::string >	FileNameList
int	ReadState
vtkStringArray *	SupportedWriteFileTypes
char *	TempFileName
char *	URI
vtkURIHandler *	URIHandler
std::vector< std::string >	URIList
int	UseCompression
char *	WriteFileFormat
int	WriteState

---

Member Enumeration Documentation

anonymous enum

Possible Read and Write states Idle: not currently working on any data, ready for the next transfer Pending: the data is remote, waiting for a transfer to be scheduled Scheduled: the data is remote, and is scheduled for download Transferring: data is remote, and the transfer is working to completion TransferDone: the data is on disk and ready to be read Cancelled: the user cancelled the remote data transfer

Enumerator:

Idle
Pending
Scheduled
Transferring
TransferDone
Cancelled

---

Constructor & Destructor Documentation

vtkMRMLStorageNode::vtkMRMLStorageNode

(

)

[protected]

References FileName, FileNameList, Idle, New(), ReadState, SupportedWriteFileTypes, TempFileName, URI, URIHandler, URIList, UseCompression, WriteFileFormat, and WriteState.

vtkMRMLStorageNode::~vtkMRMLStorageNode

(

)

[protected]

References FileName, SupportedWriteFileTypes, TempFileName, URI, URIHandler, and WriteFileFormat.

vtkMRMLStorageNode::vtkMRMLStorageNode

(

const vtkMRMLStorageNode &

)

[protected]

---

Member Function Documentation

unsigned int vtkMRMLStorageNode::AddFileName

(

const char *

fileName

)

Add in another file name to the list of file names

References FileNameIsInList(), and FileNameList.

Referenced by Copy(), vtkFourDImageLogic::LoadImagesByList(), vtkDataIOManagerLogic::QueueRead(), vtkMRMLVolumeArchetypeStorageNode::ReadData(), ReadXMLAttributes(), vtkFetchMILogic::RestoreFileNamesOnSelectedResources(), vtkFetchMILogic::SetCacheFileNamesOnSelectedResources(), vtkMRMLVolumeArchetypeStorageNode::UpdateFileList(), and vtkMRMLVolumeArchetypeStorageNodeTest2().

unsigned int vtkMRMLStorageNode::AddURI

(

const char *

uri

)

Add in another URI to the list of URI's

References URIList.

Referenced by Copy(), ReadXMLAttributes(), vtkFetchMILogic::RequestStorableNodesUpload(), and vtkFetchMILogic::RestoreURIsOnSelectedResources().

void vtkMRMLStorageNode::Copy

(

vtkMRMLNode *

node

)

[virtual]

Copy the node's attributes to this object

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

References AddFileName(), AddURI(), vtkMRMLNode::EndModify(), FileName, GetNthFileName(), GetNthURI(), GetNumberOfFileNames(), GetNumberOfURIs(), ReadState, ResetFileNameList(), ResetURIList(), vtkMRMLNode::StartModify(), URI, UseCompression, and WriteState.

virtual vtkMRMLNode* vtkMRMLStorageNode::CreateNodeInstance

(

)

[pure virtual]

Create instance of the default node. Like New only virtual NOTE: Subclasses should implement this method

Implements vtkMRMLNode.

Implemented in vtkMRMLStorageNodeTestHelper1, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

int vtkMRMLStorageNode::FileNameIsInList

(

const char *

fileName

)

is filename in the filename list already? returns 1 if yes, 0 if no

References FileNameList, vtkMRMLScene::GetRootDirectory(), IsFilePathRelative(), and vtkMRMLNode::Scene.

Referenced by AddFileName().

const char * vtkMRMLStorageNode::GetAbsoluteFilePath

(

const char *

inputPath

)

Calcualtes and the absolute path to the input file if the input path is relative and the scene is defined with a root directory. Sets and then return TempFileName. Returns null if the input path is null or the path is relative and the scene is not defined. Returns inputPath if it's absolute.

References vtkMRMLScene::GetRootDirectory(), vtkMRMLNode::GetScene(), and IsFilePathRelative().

Referenced by WriteXML().

virtual const char* vtkMRMLStorageNode::GetDefaultWriteFileExtension

(

)

[inline, virtual]

Return a default file extension for writting

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLAnnotationStorageNode.

Referenced by vtkFetchMILogic::CreateDefaultFilename(), vtkFetchMIResourceUploadWidget::HandleDataRenaming(), vtkMRMLScene::PrintSelf(), vtkFetchMILogic::SetCacheFileNamesOnSelectedResources(), and vtkSlicerMRMLSaveDataWidget::UpdateFromMRML().

std::string vtkMRMLStorageNode::GetFullNameFromFileName

(

)

Get the file's absolute path from the file name and the mrml scene root dir. GetFullnameFromFileName calls GetFullNameFromNthFileName with -1.

References GetFullNameFromNthFileName().

Referenced by vtkMRMLFreeSurferModelStorageNode::CopyData(), vtkMRMLFreeSurferModelOverlayStorageNode::CopyData(), vtkCacheManager::MarkNode(), vtkMRMLAnnotationStorageNode::OpenFileToRead(), vtkMRMLAnnotationStorageNode::OpenFileToWrite(), vtkMRMLVolumePropertyStorageNode::ReadData(), vtkMRMLVolumeHeaderlessStorageNode::ReadData(), vtkMRMLVolumeArchetypeStorageNode::ReadData(), vtkMRMLUnstructuredGridStorageNode::ReadData(), vtkMRMLTransformStorageNode::ReadData(), vtkMRMLNRRDStorageNode::ReadData(), vtkMRMLModelStorageNode::ReadData(), vtkMRMLFreeSurferModelStorageNode::ReadData(), vtkMRMLFreeSurferModelOverlayStorageNode::ReadData(), vtkMRMLFiducialListStorageNode::ReadData(), vtkMRMLDoubleArrayStorageNode::ReadData(), vtkMRMLColorTableStorageNode::ReadData(), vtkMRMLVolumePropertyStorageNode::WriteData(), vtkMRMLVolumeHeaderlessStorageNode::WriteData(), vtkMRMLVolumeArchetypeStorageNode::WriteData(), vtkMRMLUnstructuredGridStorageNode::WriteData(), vtkMRMLTransformStorageNode::WriteData(), vtkMRMLNRRDStorageNode::WriteData(), vtkMRMLModelStorageNode::WriteData(), vtkMRMLFreeSurferModelStorageNode::WriteData(), vtkMRMLFreeSurferModelOverlayStorageNode::WriteData(), vtkMRMLFiducialListStorageNode::WriteData(), vtkMRMLDoubleArrayStorageNode::WriteData(), and vtkMRMLColorTableStorageNode::WriteData().

std::string vtkMRMLStorageNode::GetFullNameFromNthFileName

(

int

n

)

References fileName, GetNthFileName(), GetNumberOfFileNames(), vtkMRMLScene::GetRootDirectory(), IsFilePathRelative(), and vtkMRMLNode::Scene.

Referenced by GetFullNameFromFileName(), and vtkMRMLVolumeArchetypeStorageNode::ReadData().

virtual const char* vtkMRMLStorageNode::GetNodeTagName

(

)

[pure virtual]

Get node XML tag name (like Storage, Model)

Implements vtkMRMLNode.

Implemented in vtkMRMLStorageNodeTestHelper1, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

const char * vtkMRMLStorageNode::GetNthFileName

(

int

n

)

const

return the nth file name, null if doesn't exist

References FileNameList, and GetNumberOfFileNames().

Referenced by Copy(), GetFullNameFromNthFileName(), PrintSelf(), vtkDataIOManagerLogic::QueueRead(), vtkDataIOManagerLogic::QueueWrite(), vtkFetchMILogic::RequestStorableNodesUpload(), vtkFetchMILogic::RestoreFileNamesOnSelectedResources(), vtkFetchMILogic::SetCacheFileNamesOnSelectedResources(), SetDataDirectory(), and WriteXML().

const char * vtkMRMLStorageNode::GetNthURI

(

int

n

)

Get the nth URI from the list of URI's

References GetNumberOfURIs(), and URIList.

Referenced by Copy(), PrintSelf(), vtkDataIOManagerLogic::QueueRead(), vtkDataIOManagerLogic::QueueWrite(), vtkFetchMILogic::RequestStorableNodesUpload(), vtkFetchMILogic::RestoreURIsOnSelectedResources(), vtkFetchMILogic::SaveOldURIsOnSelectedResources(), and WriteXML().

int vtkMRMLStorageNode::GetNumberOfFileNames

(

)

const [inline]

See how many file names were generated during ExecuteInformation

Referenced by Copy(), GetFullNameFromNthFileName(), GetNthFileName(), PrintSelf(), vtkDataIOManagerLogic::QueueWrite(), vtkMRMLVolumeArchetypeStorageNode::ReadData(), vtkFetchMILogic::RequestStorableNodesUpload(), ResetNthFileName(), vtkFetchMILogic::RestoreFileNamesOnSelectedResources(), vtkFetchMILogic::SetCacheFileNamesOnSelectedResources(), SetDataDirectory(), and WriteXML().

int vtkMRMLStorageNode::GetNumberOfURIs

(

)

[inline]

Return how many uri names this storage node holds in it's list

Referenced by Copy(), GetNthURI(), PrintSelf(), vtkDataIOManagerLogic::QueueRead(), vtkDataIOManagerLogic::QueueWrite(), vtkFetchMILogic::RequestStorableNodesUpload(), ResetNthURI(), vtkFetchMILogic::RestoreURIsOnSelectedResources(), vtkFetchMILogic::SaveOldURIsOnSelectedResources(), and WriteXML().

const char* vtkMRMLStorageNode::GetReadStateAsString

(

)

[inline]

Referenced by vtkSlicerVolumesLogic::AddArchetypeScalarVolume(), PrintSelf(), and vtkSlicerApplicationLogic::ProcessReadNodeData().

const char * vtkMRMLStorageNode::GetStateAsString

(

int

state

)

References Cancelled, Idle, Pending, Scheduled, TransferDone, and Transferring.

vtkStringArray * vtkMRMLStorageNode::GetSupportedWriteFileTypes

(

)

[virtual]

Get all the supported write file types Subclasses should overwrite InitializeSupportedWriteFileTypes().

References InitializeSupportedWriteFileTypes(), and SupportedWriteFileTypes.

Referenced by vtkFetchMIResourceUploadWidget::HandleDataRenaming(), and vtkSlicerMRMLSaveDataWidget::UpdateFromMRML().

const char* vtkMRMLStorageNode::GetWriteStateAsString

(

)

[inline]

Referenced by PrintSelf().

void vtkMRMLStorageNode::InitializeSupportedWriteFileTypes

(

)

[protected, virtual]

Initialize all the supported write file types Subclasses should use this method to initialize SupportedWriteFileTypes.

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, and vtkMRMLAnnotationStorageNode.

References SupportedWriteFileTypes.

Referenced by GetSupportedWriteFileTypes().

int vtkMRMLStorageNode::IsFilePathRelative

(

const char *

filepath

)

Checks is file path is a relative path by calling appropriate method on the scene depending on whether the scene pointer is valid

References vtkMRMLScene::IsFilePathRelative(), and vtkMRMLNode::Scene.

Referenced by FileNameIsInList(), GetAbsoluteFilePath(), GetFullNameFromNthFileName(), ReadXMLAttributes(), vtkMRMLVolumeArchetypeStorageNode::UpdateFileList(), and WriteXML().

static vtkMRMLStorageNode* vtkMRMLStorageNode::New

(

)

[inline, static]

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLStorageNodeTestHelper1, vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

Referenced by vtkMRMLStorageNode().

void vtkMRMLStorageNode::operator=

(

const vtkMRMLStorageNode &

)

[protected]

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

References FileName, GetNthFileName(), GetNthURI(), GetNumberOfFileNames(), GetNumberOfURIs(), GetReadStateAsString(), GetWriteStateAsString(), SupportedWriteFileTypes, TempFileName, URI, UseCompression, and WriteFileFormat.

virtual void vtkMRMLStorageNode::ProcessMRMLEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)			[virtual]

Propagate Progress Event generated in ReadData

Reimplemented from vtkMRMLNode.

virtual int vtkMRMLStorageNode::ReadData

(

vtkMRMLNode *

refNode

)

[pure virtual]

Read data and set it in the referenced node. Return 1 on success, 0 on failure. NOTE: Subclasses should implement this method

Implemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationFiducialsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

Referenced by vtkSlicerColorLogic::AddDefaultColorNodes(), vtkSlicerModelsLogic::AddModel(), vtkSlicerModelsLogic::AddScalar(), vtkSlicerFiducialsLogic::LoadFiducialList(), vtkSlicerApplicationLogic::ProcessReadNodeData(), and vtkMRMLStorableNode::UpdateScene().

void vtkMRMLStorageNode::ReadXMLAttributes

(

const char **

atts

)

[virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

References AddFileName(), AddURI(), vtkMRMLNode::EndModify(), vtkMRMLScene::GetRootDirectory(), vtkMRMLNode::GetScene(), IsFilePathRelative(), slicerget::name, ReadState, ResetFileNameList(), ResetURIList(), vtkMRMLNode::StartModify(), vtkMRMLNode::URLDecodeString(), UseCompression, and WriteState.

void vtkMRMLStorageNode::ResetFileNameList

(

)

Clear the array of file names

References FileNameList.

Referenced by Copy(), vtkFourDImageLogic::LoadImagesByList(), vtkDataIOManagerLogic::QueueRead(), ReadXMLAttributes(), vtkFetchMILogic::RestoreFileNamesOnSelectedResources(), vtkFetchMILogic::SetCacheFileNamesOnSelectedResources(), vtkMRMLVolumeArchetypeStorageNode::UpdateFileList(), and vtkMRMLVolumeArchetypeStorageNodeTest2().

void vtkMRMLStorageNode::ResetNthFileName	(	int	n,
		const char *	fileName
	)

Set the nth file in FileNameList, checks that it is already defined

References FileNameList, and GetNumberOfFileNames().

Referenced by SetDataDirectory(), and WriteXML().

void vtkMRMLStorageNode::ResetNthURI	(	int	n,
		const char *	uri
	)

Set the nth uri in URIList, checks that it is already defined

References GetNumberOfURIs(), and URIList.

void vtkMRMLStorageNode::ResetURIList

(

)

Clear the array of URIs

References URIList.

Referenced by Copy(), ReadXMLAttributes(), vtkFetchMILogic::RequestStorableNodesUpload(), and vtkFetchMILogic::RestoreURIsOnSelectedResources().

void vtkMRMLStorageNode::SetDataDirectory

(

const char *

dataDirName

)

Set a new data directory for all files

References fileName, GetNthFileName(), GetNumberOfFileNames(), and ResetNthFileName().

void vtkMRMLStorageNode::SetReadStateCancelled

(

)

[inline]

Referenced by vtkDataIOManager::QueueRead(), and vtkDataIOManagerLogic::QueueRead().

void vtkMRMLStorageNode::SetReadStateIdle

(

)

[inline]

Referenced by vtkMRMLAnnotationStorageNode::ReadData(), vtkMRMLAnnotationRulerStorageNode::ReadData(), vtkMRMLAnnotationLinesStorageNode::ReadData(), vtkMRMLAnnotationFiducialsStorageNode::ReadData(), vtkMRMLAnnotationControlPointsStorageNode::ReadData(), vtkMRMLAnnotationAngleStorageNode::ReadData(), vtkMRMLVolumePropertyStorageNode::ReadData(), vtkMRMLVolumeHeaderlessStorageNode::ReadData(), vtkMRMLVolumeArchetypeStorageNode::ReadData(), vtkMRMLUnstructuredGridStorageNode::ReadData(), vtkMRMLTransformStorageNode::ReadData(), vtkMRMLNRRDStorageNode::ReadData(), vtkMRMLModelStorageNode::ReadData(), vtkMRMLFreeSurferModelStorageNode::ReadData(), vtkMRMLFreeSurferModelOverlayStorageNode::ReadData(), vtkMRMLFiducialListStorageNode::ReadData(), vtkMRMLDoubleArrayStorageNode::ReadData(), vtkMRMLColorTableStorageNode::ReadData(), and StageReadData().

void vtkMRMLStorageNode::SetReadStatePending

(

)

[inline]

Referenced by vtkMRMLFreeSurferModelOverlayStorageNode::ReadData(), and StageReadData().

void vtkMRMLStorageNode::SetReadStateScheduled

(

)

[inline]

Referenced by vtkDataIOManager::QueueRead().

void vtkMRMLStorageNode::SetReadStateTransferDone

(

)

[inline]

Referenced by vtkDataIOManagerLogic::ApplyTransfer(), vtkDataIOManagerLogic::QueueRead(), StageReadData(), and StageWriteData().

void vtkMRMLStorageNode::SetReadStateTransferring

(

)

[inline]

Referenced by vtkDataIOManagerLogic::QueueRead().

void vtkMRMLStorageNode::SetURIPrefix

(

const char *

uriPrefix

)

Set a new URI base for all URI's

void vtkMRMLStorageNode::SetWriteStateCancelled

(

)

[inline]

Referenced by vtkFetchMILogic::SetCancelledWriteStateOnSelectedResources().

void vtkMRMLStorageNode::SetWriteStateIdle

(

)

[inline]

Referenced by vtkFetchMILogic::SetIdleWriteStateOnSelectedResources(), and StageWriteData().

void vtkMRMLStorageNode::SetWriteStatePending

(

)

[inline]

Referenced by StageWriteData().

void vtkMRMLStorageNode::SetWriteStateScheduled

(

)

[inline]

Referenced by vtkDataIOManager::QueueWrite().

void vtkMRMLStorageNode::SetWriteStateTransferDone

(

)

[inline]

Referenced by vtkDataIOManagerLogic::ApplyTransfer(), vtkDataIOManagerLogic::QueueWrite(), vtkFetchMILogic::SetTransferDoneWriteStateOnSelectedResources(), and StageWriteData().

void vtkMRMLStorageNode::SetWriteStateTransferring

(

)

[inline]

void vtkMRMLStorageNode::StageReadData

(

vtkMRMLNode *

refNode

)

If the URI is not null, fetch it and save it to the node's FileName location or load directly into the reference node.

References vtkMRMLScene::FindURIHandler(), vtkCacheManager::GetFilenameFromURI(), Idle, vtkDataIOManager::QueueRead(), vtkMRMLNode::Scene, SetReadStateIdle(), SetReadStatePending(), SetReadStateTransferDone(), SupportedFileType(), URI, and URIHandler.

Referenced by vtkMRMLAnnotationStorageNode::OpenFileToRead(), vtkMRMLVolumePropertyStorageNode::ReadData(), vtkMRMLVolumeHeaderlessStorageNode::ReadData(), vtkMRMLVolumeArchetypeStorageNode::ReadData(), vtkMRMLUnstructuredGridStorageNode::ReadData(), vtkMRMLTransformStorageNode::ReadData(), vtkMRMLNRRDStorageNode::ReadData(), vtkMRMLModelStorageNode::ReadData(), vtkMRMLFreeSurferModelStorageNode::ReadData(), vtkMRMLFreeSurferModelOverlayStorageNode::ReadData(), vtkMRMLFiducialListStorageNode::ReadData(), vtkMRMLDoubleArrayStorageNode::ReadData(), and vtkMRMLColorTableStorageNode::ReadData().

void vtkMRMLStorageNode::StageWriteData

(

vtkMRMLNode *

refNode

)

Copy data from the local file location (node->FileName) or node to the remote location specified by the URI

References vtkMRMLScene::FindURIHandler(), Idle, vtkDataIOManager::QueueWrite(), vtkMRMLNode::Scene, SetReadStateTransferDone(), SetWriteStateIdle(), SetWriteStatePending(), SetWriteStateTransferDone(), URI, and URIHandler.

Referenced by vtkMRMLFreeSurferModelStorageNode::CopyData(), vtkMRMLFreeSurferModelOverlayStorageNode::CopyData(), vtkMRMLAnnotationStorageNode::WriteData(), vtkMRMLAnnotationRulerStorageNode::WriteData(), vtkMRMLAnnotationLinesStorageNode::WriteData(), vtkMRMLAnnotationControlPointsStorageNode::WriteData(), vtkMRMLAnnotationAngleStorageNode::WriteData(), vtkMRMLVolumeHeaderlessStorageNode::WriteData(), vtkMRMLVolumeArchetypeStorageNode::WriteData(), vtkMRMLUnstructuredGridStorageNode::WriteData(), vtkMRMLNRRDStorageNode::WriteData(), vtkMRMLModelStorageNode::WriteData(), vtkMRMLFreeSurferModelStorageNode::WriteData(), vtkMRMLFreeSurferModelOverlayStorageNode::WriteData(), vtkMRMLFiducialListStorageNode::WriteData(), vtkMRMLDoubleArrayStorageNode::WriteData(), and vtkMRMLColorTableStorageNode::WriteData().

int vtkMRMLStorageNode::SupportedFileType

(

const char *

fileName

)

[virtual]

Check to see if this storage node can handle the file type in the input string. If input string is null, check URI, then check FileName. Returns 1 if is supported, 0 otherwise. Subclasses should implement this method.

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiberBundleStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, and vtkMRMLAnnotationStorageNode.

Referenced by StageReadData().

vtkMRMLStorageNode::vtkBooleanMacro	(	UseCompression	,
		int
	)

vtkMRMLStorageNode::vtkGetMacro	(	WriteState	,
		int
	)

Get/Set the state of writing

vtkMRMLStorageNode::vtkGetMacro	(	ReadState	,
		int
	)

Get/Set the state of reading

vtkMRMLStorageNode::vtkGetMacro	(	UseCompression	,
		int
	)

Use compression on write

vtkMRMLStorageNode::vtkGetObjectMacro	(	URIHandler	,
		vtkURIHandler
	)

vtkMRMLStorageNode::vtkGetStringMacro

(

TempFileName

)

vtkMRMLStorageNode::vtkGetStringMacro

(

WriteFileFormat

)

vtkMRMLStorageNode::vtkGetStringMacro

(

URI

)

vtkMRMLStorageNode::vtkGetStringMacro

(

FileName

)

vtkMRMLStorageNode::vtkSetMacro	(	WriteState	,
		int
	)

vtkMRMLStorageNode::vtkSetMacro	(	ReadState	,
		int
	)

vtkMRMLStorageNode::vtkSetMacro	(	UseCompression	,
		int
	)

vtkMRMLStorageNode::vtkSetObjectMacro	(	URIHandler	,
		vtkURIHandler
	)

vtkMRMLStorageNode::vtkSetStringMacro

(

TempFileName

)

A temporary file name used to calculate absolute paths

vtkMRMLStorageNode::vtkSetStringMacro

(

WriteFileFormat

)

Allow to set specific file format that this node will write output.

vtkMRMLStorageNode::vtkSetStringMacro

(

URI

)

Location of the remote copy of this file.

vtkMRMLStorageNode::vtkSetStringMacro

(

FileName

)

A file name or the archetype file name for a series

vtkMRMLStorageNode::vtkTypeMacro	(	vtkMRMLStorageNode	,
		vtkMRMLNode
	)

virtual int vtkMRMLStorageNode::WriteData

(

vtkMRMLNode *

refNode

)

[pure virtual]

Write data from a referenced node Return 1 on success, 0 on failure. NOTE: Subclasses should implement this method

Implemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLUnstructuredGridStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkFetchMILogic::PostStorableNodes(), vtkSlicerVolumesLogic::SaveArchetypeVolume(), vtkSlicerMRMLSaveDataWidget::SaveData(), and vtkEMSegmentLogic::WritePackagedScene().

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

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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableStorageNode, vtkMRMLDoubleArrayStorageNode, vtkMRMLFiducialListStorageNode, vtkMRMLFreeSurferModelOverlayStorageNode, vtkMRMLFreeSurferModelStorageNode, vtkMRMLModelStorageNode, vtkMRMLNRRDStorageNode, vtkMRMLTransformStorageNode, vtkMRMLVolumeArchetypeStorageNode, vtkMRMLVolumeHeaderlessStorageNode, vtkMRMLVolumePropertyStorageNode, vtkMRMLAnnotationAngleStorageNode, vtkMRMLAnnotationControlPointsStorageNode, vtkMRMLAnnotationLinesStorageNode, vtkMRMLAnnotationRulerStorageNode, and vtkMRMLAnnotationStorageNode.

References FileName, GetAbsoluteFilePath(), GetNthFileName(), GetNthURI(), GetNumberOfFileNames(), GetNumberOfURIs(), vtkMRMLNode::GetScene(), IsFilePathRelative(), slicerget::name, ReadState, ResetNthFileName(), URI, vtkMRMLNode::URLEncodeString(), UseCompression, and WriteState.

---

Member Data Documentation

char* vtkMRMLStorageNode::FileName [protected]

Referenced by Copy(), vtkMRMLVolumePropertyStorageNode::PrintSelf(), vtkMRMLTransformStorageNode::PrintSelf(), PrintSelf(), vtkMRMLModelStorageNode::PrintSelf(), vtkMRMLFiducialListStorageNode::ReadData(), vtkMRMLDoubleArrayStorageNode::ReadData(), vtkMRMLColorTableStorageNode::ReadData(), vtkMRMLAnnotationStorageNode::SupportedFileType(), vtkMRMLVolumePropertyStorageNode::SupportedFileType(), vtkMRMLVolumeHeaderlessStorageNode::SupportedFileType(), vtkMRMLVolumeArchetypeStorageNode::SupportedFileType(), vtkMRMLUnstructuredGridStorageNode::SupportedFileType(), vtkMRMLTransformStorageNode::SupportedFileType(), vtkMRMLNRRDStorageNode::SupportedFileType(), vtkMRMLModelStorageNode::SupportedFileType(), vtkMRMLFreeSurferModelStorageNode::SupportedFileType(), vtkMRMLFreeSurferModelOverlayStorageNode::SupportedFileType(), vtkMRMLFiducialListStorageNode::SupportedFileType(), vtkMRMLDoubleArrayStorageNode::SupportedFileType(), vtkMRMLColorTableStorageNode::SupportedFileType(), vtkMRMLStorageNode(), WriteXML(), and ~vtkMRMLStorageNode().

std::vector<std::string> vtkMRMLStorageNode::FileNameList [protected]

An array of file names, should contain the FileName but may not

Referenced by AddFileName(), FileNameIsInList(), GetNthFileName(), ResetFileNameList(), ResetNthFileName(), and vtkMRMLStorageNode().

int vtkMRMLStorageNode::ReadState [protected]

Referenced by Copy(), ReadXMLAttributes(), vtkMRMLStorageNode(), and WriteXML().

vtkStringArray* vtkMRMLStorageNode::SupportedWriteFileTypes [protected]

Referenced by GetSupportedWriteFileTypes(), vtkMRMLAnnotationStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLAnnotationFiducialsStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLVolumePropertyStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLVolumeHeaderlessStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLVolumeArchetypeStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLUnstructuredGridStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLTransformStorageNode::InitializeSupportedWriteFileTypes(), InitializeSupportedWriteFileTypes(), vtkMRMLNRRDStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLModelStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLFreeSurferModelStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLFiducialListStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLDoubleArrayStorageNode::InitializeSupportedWriteFileTypes(), vtkMRMLColorTableStorageNode::InitializeSupportedWriteFileTypes(), PrintSelf(), vtkMRMLStorageNode(), and ~vtkMRMLStorageNode().

char* vtkMRMLStorageNode::TempFileName [protected]

Referenced by PrintSelf(), vtkMRMLStorageNode(), and ~vtkMRMLStorageNode().

char* vtkMRMLStorageNode::URI [protected]

Referenced by Copy(), PrintSelf(), StageReadData(), StageWriteData(), vtkMRMLAnnotationStorageNode::SupportedFileType(), vtkMRMLVolumePropertyStorageNode::SupportedFileType(), vtkMRMLVolumeHeaderlessStorageNode::SupportedFileType(), vtkMRMLVolumeArchetypeStorageNode::SupportedFileType(), vtkMRMLUnstructuredGridStorageNode::SupportedFileType(), vtkMRMLTransformStorageNode::SupportedFileType(), vtkMRMLNRRDStorageNode::SupportedFileType(), vtkMRMLModelStorageNode::SupportedFileType(), vtkMRMLFreeSurferModelStorageNode::SupportedFileType(), vtkMRMLFreeSurferModelOverlayStorageNode::SupportedFileType(), vtkMRMLFiducialListStorageNode::SupportedFileType(), vtkMRMLDoubleArrayStorageNode::SupportedFileType(), vtkMRMLColorTableStorageNode::SupportedFileType(), vtkMRMLStorageNode(), WriteXML(), and ~vtkMRMLStorageNode().

vtkURIHandler* vtkMRMLStorageNode::URIHandler [protected]

Referenced by StageReadData(), StageWriteData(), vtkMRMLStorageNode(), and ~vtkMRMLStorageNode().

std::vector<std::string> vtkMRMLStorageNode::URIList [protected]

An array of URI's, should contain the URI but may not

Referenced by AddURI(), GetNthURI(), ResetNthURI(), ResetURIList(), and vtkMRMLStorageNode().

int vtkMRMLStorageNode::UseCompression [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), vtkMRMLStorageNode(), and WriteXML().

char* vtkMRMLStorageNode::WriteFileFormat [protected]

Reimplemented in vtkMRMLVolumeHeaderlessStorageNode.

Referenced by PrintSelf(), vtkMRMLVolumeArchetypeStorageNode::UpdateFileList(), vtkMRMLStorageNode(), vtkMRMLVolumeArchetypeStorageNode::WriteData(), and ~vtkMRMLStorageNode().

int vtkMRMLStorageNode::WriteState [protected]

Referenced by Copy(), ReadXMLAttributes(), vtkMRMLStorageNode(), and WriteXML().

---

The documentation for this class was generated from the following files:

• Libs/MRML/vtkMRMLStorageNode.h
• Libs/MRML/vtkMRMLStorageNode.cxx