vtkDataIOManager.h

Go to the documentation of this file.

#ifndef __vtkDataIOManager_h
#define __vtkDataIOManager_h
 
// MRML includes
#include "vtkMRML.h"
class vtkCacheManager;
class vtkDataFileFormatHelper;
class vtkDataTransfer;
class vtkMRMLNode;
 
// VTK includes
#include <vtkObject.h>
class vtkCallbackCommand;
class vtkCollection;
 
#ifndef vtkObjectPointer
# define vtkObjectPointer(xx) (reinterpret_cast<vtkObject**>((xx)))
#endif
 
class VTK_MRML_EXPORT vtkDataIOManager : public vtkObject
{
public:
  static vtkDataIOManager* New();
  vtkTypeMacro(vtkDataIOManager, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  vtkGetObjectMacro(DataTransferCollection, vtkCollection);
  void SetDataTransferCollection(vtkCollection* dataTransfer);
  vtkGetObjectMacro(CacheManager, vtkCacheManager);
  virtual void SetCacheManager(vtkCacheManager* cacheManager);
  vtkGetMacro(EnableAsynchronousIO, int);
  vtkGetMacro(InUpdateCallbackFlag, int);
  vtkSetMacro(InUpdateCallbackFlag, int);

  vtkDataFileFormatHelper* GetFileFormatHelper();
  virtual void SetFileFormatHelper(vtkDataFileFormatHelper* helper);
 
  void SetEnableAsynchronousIO(int);

  vtkDataTransfer* AddNewDataTransfer();
  vtkDataTransfer* AddNewDataTransfer(vtkMRMLNode* node);
  void AddNewDataTransfer(vtkDataTransfer* transfer, vtkMRMLNode* node);
  void AllTransfersClearedFromCache();

  void AddDataTransfer(vtkDataTransfer* transfer);
  void RemoveDataTransfer(vtkDataTransfer* transfer);
  void RemoveDataTransfer(int transferID);
  int GetNumberOfDataTransfers();
  vtkDataTransfer* GetDataTransfer(int transferID);
  void ClearDataTransfers();
  int GetUniqueTransferID();

  void QueueRead(vtkMRMLNode* node);

  void QueueWrite(vtkMRMLNode* node);

  void SetTransferStatus(vtkDataTransfer* transfer, int status);
  int GetTransferStatus(vtkDataTransfer* transfer);
 
  const char* GetTransferStatusString(vtkDataTransfer* transfer);
 
  virtual void ProcessTransferUpdates(vtkObject* caller, unsigned long event, void* callData);
 
  enum
  {
    RemoteReadEvent = 19001,
    RemoteWriteEvent,
    LocalReadEvent,
    LocalWriteEvent,
    NewTransferEvent,
    TransferUpdateEvent,
    SettingsUpdateEvent,
    DisplayManagerWindowEvent,
    RefreshDisplayEvent
  };

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

  vtkCallbackCommand* TransferUpdateCommand;
  int InUpdateCallbackFlag;
 
private:
  vtkCollection* DataTransferCollection;
  vtkCacheManager* CacheManager;
  int EnableAsynchronousIO;
 
  vtkDataFileFormatHelper* FileFormatHelper;
 
protected:
  vtkDataIOManager();
  ~vtkDataIOManager() override;
  vtkDataIOManager(const vtkDataIOManager&);
  void operator=(const vtkDataIOManager&);
};
 
#endif