vtkDataIOManager Class Reference

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

Inheritance diagram for vtkDataIOManager:

Collaboration diagram for vtkDataIOManager:

Public Types
enum	{   RemoteReadEvent = 19001 , RemoteWriteEvent , LocalReadEvent , LocalWriteEvent ,   NewTransferEvent , TransferUpdateEvent , SettingsUpdateEvent , DisplayManagerWindowEvent ,   RefreshDisplayEvent }
typedef vtkObject	Superclass

Public Member Functions
void	AddDataTransfer (vtkDataTransfer *transfer)
	Adds a new data transfer object to the collection.
vtkDataTransfer *	AddNewDataTransfer ()
	Creates and adds a new data transfer object to the collection.
void	AddNewDataTransfer (vtkDataTransfer *transfer, vtkMRMLNode *node)
vtkDataTransfer *	AddNewDataTransfer (vtkMRMLNode *node)
void	AllTransfersClearedFromCache ()
void	ClearDataTransfers ()
virtual vtkCacheManager *	GetCacheManager ()
virtual const char *	GetClassName ()
vtkDataTransfer *	GetDataTransfer (int transferID)
	Returns an individual data transfer by id.
virtual vtkCollection *	GetDataTransferCollection ()
virtual int	GetEnableAsynchronousIO ()
vtkDataFileFormatHelper *	GetFileFormatHelper ()
	Get/Set the DataFileFormatHelper object.
virtual int	GetInUpdateCallbackFlag ()
int	GetNumberOfDataTransfers ()
int	GetTransferStatus (vtkDataTransfer *transfer)
const char *	GetTransferStatusString (vtkDataTransfer *transfer)
int	GetUniqueTransferID ()
	Gets a unique id to assign to a new data transfer.
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	ProcessTransferUpdates (vtkObject *caller, unsigned long event, void *callData)
void	QueueRead (vtkMRMLNode *node)
void	QueueWrite (vtkMRMLNode *node)
void	RemoveDataTransfer (int transferID)
void	RemoveDataTransfer (vtkDataTransfer *transfer)
	Removes a data transfer object from the collection.
virtual void	SetCacheManager (vtkCacheManager *cacheManager)
void	SetDataTransferCollection (vtkCollection *dataTransfer)
void	SetEnableAsynchronousIO (int)
virtual void	SetFileFormatHelper (vtkDataFileFormatHelper *helper)
virtual void	SetInUpdateCallbackFlag (int)
void	SetTransferStatus (vtkDataTransfer *transfer, int status)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkDataIOManager *	New ()
	The Usual vtk class functions.
static vtkDataIOManager *	SafeDownCast (vtkObject *o)
static void	TransferUpdateCallback (vtkObject *__caller, unsigned long eid, void *__clientData, void *callData)
	function that gets called when a data transfer has been updated.

Public Attributes
int	InUpdateCallbackFlag
vtkCallbackCommand *	TransferUpdateCommand
	Holder for update callback.

Protected Member Functions
void	operator= (const vtkDataIOManager &)
	vtkDataIOManager ()
	vtkDataIOManager (const vtkDataIOManager &)
	~vtkDataIOManager () override

Detailed Description

Definition at line 20 of file vtkDataIOManager.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkDataIOManager::Superclass

Definition at line 26 of file vtkDataIOManager.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
RemoteReadEvent
RemoteWriteEvent
LocalReadEvent
LocalWriteEvent
NewTransferEvent
TransferUpdateEvent
SettingsUpdateEvent
DisplayManagerWindowEvent
RefreshDisplayEvent

Definition at line 90 of file vtkDataIOManager.h.

Constructor & Destructor Documentation

vtkDataIOManager() [1/2]

vtkDataIOManager::vtkDataIOManager ( )

protected

~vtkDataIOManager()

vtkDataIOManager::~vtkDataIOManager ( )

overrideprotected

vtkDataIOManager() [2/2]

vtkDataIOManager::vtkDataIOManager ( const vtkDataIOManager & )

protected

Member Function Documentation

AddDataTransfer()

void vtkDataIOManager::AddDataTransfer

(

vtkDataTransfer *

transfer

)

Adds a new data transfer object to the collection.

AddNewDataTransfer() [1/3]

vtkDataTransfer * vtkDataIOManager::AddNewDataTransfer

(

)

Creates and adds a new data transfer object to the collection.

AddNewDataTransfer() [2/3]

void vtkDataIOManager::AddNewDataTransfer	(	vtkDataTransfer *	transfer,
		vtkMRMLNode *	node )

AddNewDataTransfer() [3/3]

vtkDataTransfer * vtkDataIOManager::AddNewDataTransfer

(

vtkMRMLNode *

node

)

AllTransfersClearedFromCache()

void vtkDataIOManager::AllTransfersClearedFromCache

(

)

ClearDataTransfers()

void vtkDataIOManager::ClearDataTransfers

(

)

Clears all data transfers from the collection; called after the cache is cleared.

GetCacheManager()

virtual vtkCacheManager * vtkDataIOManager::GetCacheManager ( )

virtual

GetClassName()

virtual const char * vtkDataIOManager::GetClassName ( )

virtual

GetDataTransfer()

vtkDataTransfer * vtkDataIOManager::GetDataTransfer

(

int

transferID

)

Returns an individual data transfer by id.

GetDataTransferCollection()

virtual vtkCollection * vtkDataIOManager::GetDataTransferCollection ( )

virtual

GetEnableAsynchronousIO()

virtual int vtkDataIOManager::GetEnableAsynchronousIO ( )

virtual

GetFileFormatHelper()

vtkDataFileFormatHelper * vtkDataIOManager::GetFileFormatHelper

(

)

Get/Set the DataFileFormatHelper object.

GetInUpdateCallbackFlag()

virtual int vtkDataIOManager::GetInUpdateCallbackFlag ( )

virtual

GetNumberOfDataTransfers()

int vtkDataIOManager::GetNumberOfDataTransfers

(

)

GetTransferStatus()

int vtkDataIOManager::GetTransferStatus

(

vtkDataTransfer *

transfer

)

GetTransferStatusString()

const char * vtkDataIOManager::GetTransferStatusString

(

vtkDataTransfer *

transfer

)

GetUniqueTransferID()

int vtkDataIOManager::GetUniqueTransferID

(

)

Gets a unique id to assign to a new data transfer.

IsA()

virtual int vtkDataIOManager::IsA ( const char * type )

virtual

IsTypeOf()

static int vtkDataIOManager::IsTypeOf ( const char * type )

static

New()

static vtkDataIOManager * vtkDataIOManager::New ( )

static

The Usual vtk class functions.

operator=()

void vtkDataIOManager::operator= ( const vtkDataIOManager & )

protected

PrintSelf()

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

override

ProcessTransferUpdates()

virtual void vtkDataIOManager::ProcessTransferUpdates ( vtkObject * caller, unsigned long event, void * callData )

virtual

QueueRead()

void vtkDataIOManager::QueueRead

(

vtkMRMLNode *

node

)

Invokes a RemoteReadEvent on the node so that logic can take care of scheduling and applying it

QueueWrite()

void vtkDataIOManager::QueueWrite

(

vtkMRMLNode *

node

)

Invokes a RemoteWriteEvent on the node so that logic can take care of scheduling and applying it

RemoveDataTransfer() [1/2]

void vtkDataIOManager::RemoveDataTransfer

(

int

transferID

)

RemoveDataTransfer() [2/2]

void vtkDataIOManager::RemoveDataTransfer

(

vtkDataTransfer *

transfer

)

Removes a data transfer object from the collection.

SafeDownCast()

static vtkDataIOManager * vtkDataIOManager::SafeDownCast ( vtkObject * o )

static

SetCacheManager()

virtual void vtkDataIOManager::SetCacheManager ( vtkCacheManager * cacheManager )

virtual

SetDataTransferCollection()

void vtkDataIOManager::SetDataTransferCollection

(

vtkCollection *

dataTransfer

)

SetEnableAsynchronousIO()

void vtkDataIOManager::SetEnableAsynchronousIO

(

int

)

SetFileFormatHelper()

virtual void vtkDataIOManager::SetFileFormatHelper ( vtkDataFileFormatHelper * helper )

virtual

SetInUpdateCallbackFlag()

virtual void vtkDataIOManager::SetInUpdateCallbackFlag ( int )

virtual

SetTransferStatus()

void vtkDataIOManager::SetTransferStatus	(	vtkDataTransfer *	transfer,
		int	status )

Set the status of a data transfer (Idle, Scheduled, Cancelled Running, Completed). The "modify" parameter indicates whether the object can be modified by the call.

TransferUpdateCallback()

static void vtkDataIOManager::TransferUpdateCallback ( vtkObject * __caller, unsigned long eid, void * __clientData, void * callData )

static

function that gets called when a data transfer has been updated.

Member Data Documentation

InUpdateCallbackFlag

int vtkDataIOManager::InUpdateCallbackFlag

Definition at line 109 of file vtkDataIOManager.h.

TransferUpdateCommand

vtkCallbackCommand* vtkDataIOManager::TransferUpdateCommand

Holder for update callback.

Definition at line 108 of file vtkDataIOManager.h.

---

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

• Libs/MRML/Core/vtkDataIOManager.h