Helper to write data on client or data-server-root. More...

#include <vtkRemoteWriterHelper.h>

Inheritance diagram for vtkRemoteWriterHelper:

Collaboration diagram for vtkRemoteWriterHelper:

[legend]

Public Types
enum	{ START = 0, WRITE = 1, END = 2 }
	Writer States. More...

typedef vtkDataObjectAlgorithm	Superclass

Public Types inherited from vtkDataObjectAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision

enum	DesiredOutputPrecision

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

	vtkRemoteWriterHelper (const vtkRemoteWriterHelper &)=delete

void	operator= (const vtkRemoteWriterHelper &)=delete

int	Write ()
	Write the data. More...


void	SetWriter (vtkAlgorithm *writer)
	Get/Set the Image writer. More...

virtual vtkAlgorithm *	GetWriter ()
	Get/Set the Image writer. More...


virtual void	SetOutputDestination (vtkTypeUInt32)
	Get/Set the process on which the data must be written. More...

virtual vtkTypeUInt32	GetOutputDestination ()
	Get/Set the process on which the data must be written. More...


virtual void	SetTryWritingInBackground (bool)
	If set to true, this helper will attempt writing the file in the background in parallel. More...

virtual bool	GetTryWritingInBackground ()
	If set to true, this helper will attempt writing the file in the background in parallel. More...

virtual void	TryWritingInBackgroundOn ()
	If set to true, this helper will attempt writing the file in the background in parallel. More...

virtual void	TryWritingInBackgroundOff ()
	If set to true, this helper will attempt writing the file in the background in parallel. More...


virtual void	SetState (int)
	Set the state of the writer. More...

virtual int	GetState ()
	Set the state of the writer. More...


void	SetInterpreter (vtkClientServerInterpreter *interp)
	Set the interpreter to use to call methods on the writer. More...

virtual vtkClientServerInterpreter *	GetInterpreter ()
	Set the interpreter to use to call methods on the writer. More...

Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetOutput ()

vtkDataObject *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

vtkDataObject *	GetOutput ()

vtkDataObject *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdateExtent (const int extents[6])

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

void	SetUpdateExtent (int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkRemoteWriterHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkRemoteWriterHelper *	SafeDownCast (vtkObject *o)

static void	Wait (const std::string &fileName)
	Wait until `fileName` has finished being written. More...

static void	Wait ()
	Wait for all jobs saving screenshot to finish. More...

Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObjectAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkRemoteWriterHelper ()

	~vtkRemoteWriterHelper () override

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	FillInputPortInformation (int port, vtkInformation *info) override

void	WriteLocally (vtkDataObject *input)
	Internal method that setup the file name and delegates `Write` in this->Writer. More...

Protected Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObjectAlgorithm ()

	~vtkDataObjectAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetErrorCode (unsigned long)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeUInt32	OutputDestination = vtkPVSession::CLIENT

int	State = WRITE

vtkAlgorithm *	Writer = nullptr

vtkClientServerInterpreter *	Interpreter = nullptr

bool	TryWritingInBackground = false

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Helper to write data on client or data-server-root.

vtkRemoteWriterHelper is designed to be used to write data that is being generated on the client-side either directly on the client or on the data-server root node. This is useful for saving data such as screenshots, state files, etc. that are generated on the client-side but sometimes needs to be saved remotely on the data-server root node instead.

To use, simply create the ("misc", "RemoteWriterHelper") proxy. The proxy creates this class on client and data-server. Next, using the client-side object, pass the input data to the client-instance and then set OutputDestination property as needed. The actual writer to use must be set using the "Writer" property. Now, when you call UpdatePipeline, the vtkRemoteWriterHelper will transfer data if needed and then invoke the writer's Write method on the target process.

Definition at line 33 of file vtkRemoteWriterHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkRemoteWriterHelper::Superclass

Definition at line 37 of file vtkRemoteWriterHelper.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Writer States.

START and END are used only by vtkGenericMovieWriter subclasses, while WRITE is used by any writer.

Enumerator
START
WRITE
END

Definition at line 77 of file vtkRemoteWriterHelper.h.

Constructor & Destructor Documentation

◆ vtkRemoteWriterHelper() [1/2]

vtkRemoteWriterHelper::vtkRemoteWriterHelper ( const vtkRemoteWriterHelper & )

delete

◆ vtkRemoteWriterHelper() [2/2]

vtkRemoteWriterHelper::vtkRemoteWriterHelper ( )

protected

◆ ~vtkRemoteWriterHelper()

vtkRemoteWriterHelper::~vtkRemoteWriterHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkRemoteWriterHelper* vtkRemoteWriterHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkRemoteWriterHelper::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkDataObjectAlgorithm.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ SetWriter()

void vtkRemoteWriterHelper::SetWriter ( vtkAlgorithm * writer )

Get/Set the Image writer.

◆ GetWriter()

virtual vtkAlgorithm* vtkRemoteWriterHelper::GetWriter ( )

virtual

Get/Set the Image writer.

◆ SetOutputDestination()

virtual void vtkRemoteWriterHelper::SetOutputDestination ( vtkTypeUInt32 )

virtual

Get/Set the process on which the data must be written.

Currently supported values are vtkPVSession::CLIENT and vtkPVSession::DATA_SERVER_ROOT (or vtkPVSession::DATA_SERVER). vtkPVSession::DATA_SERVER and vtkPVSession::DATA_SERVER_ROOT are treated identically since the data is only written on the root node.

◆ GetOutputDestination()

virtual vtkTypeUInt32 vtkRemoteWriterHelper::GetOutputDestination ( )

virtual

Get/Set the process on which the data must be written.

Currently supported values are vtkPVSession::CLIENT and vtkPVSession::DATA_SERVER_ROOT (or vtkPVSession::DATA_SERVER). vtkPVSession::DATA_SERVER and vtkPVSession::DATA_SERVER_ROOT are treated identically since the data is only written on the root node.

◆ SetTryWritingInBackground()

virtual void vtkRemoteWriterHelper::SetTryWritingInBackground ( bool )

virtual

If set to true, this helper will attempt writing the file in the background in parallel.

As of today, only images can go this path (.jpeg, .png, etc.). Otherwise, writing a file will happen serially in all circumstances.

◆ GetTryWritingInBackground()

virtual bool vtkRemoteWriterHelper::GetTryWritingInBackground ( )

virtual

If set to true, this helper will attempt writing the file in the background in parallel.

As of today, only images can go this path (.jpeg, .png, etc.). Otherwise, writing a file will happen serially in all circumstances.

◆ TryWritingInBackgroundOn()

virtual void vtkRemoteWriterHelper::TryWritingInBackgroundOn ( )

virtual

If set to true, this helper will attempt writing the file in the background in parallel.

As of today, only images can go this path (.jpeg, .png, etc.). Otherwise, writing a file will happen serially in all circumstances.

◆ TryWritingInBackgroundOff()

virtual void vtkRemoteWriterHelper::TryWritingInBackgroundOff ( )

virtual

If set to true, this helper will attempt writing the file in the background in parallel.

As of today, only images can go this path (.jpeg, .png, etc.). Otherwise, writing a file will happen serially in all circumstances.

◆ SetState()

virtual void vtkRemoteWriterHelper::SetState ( int )

virtual

Set the state of the writer.

Make sure that the given writer has a Start and End functions if you want to use START and END states.

The default is WRITE.

◆ GetState()

virtual int vtkRemoteWriterHelper::GetState ( )

virtual

Set the state of the writer.

Make sure that the given writer has a Start and End functions if you want to use START and END states.

The default is WRITE.

◆ SetInterpreter()

void vtkRemoteWriterHelper::SetInterpreter ( vtkClientServerInterpreter * interp )

Set the interpreter to use to call methods on the writer.

Initialized to vtkClientServerInterpreterInitializer::GetGlobalInterpreter() in the constructor.

◆ GetInterpreter()

virtual vtkClientServerInterpreter* vtkRemoteWriterHelper::GetInterpreter ( )

virtual

Set the interpreter to use to call methods on the writer.

Initialized to vtkClientServerInterpreterInitializer::GetGlobalInterpreter() in the constructor.

◆ operator=()

void vtkRemoteWriterHelper::operator= ( const vtkRemoteWriterHelper & )

delete

◆ Wait() [1/2]

static void vtkRemoteWriterHelper::Wait ( const std::string & fileName )

static

Wait until fileName has finished being written.

If the file has been written in the background in parallel, this thread might hang if the file is not finished being written. Otherwise, there is no waiting.

Parameters

fileName File name to wait for. It can be provided with its absolute or relative path regardless.

◆ Wait() [2/2]

static void vtkRemoteWriterHelper::Wait ( )

static

Wait for all jobs saving screenshot to finish.

◆ Write()

int vtkRemoteWriterHelper::Write ( )

Write the data.

◆ RequestData()

int vtkRemoteWriterHelper::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ FillInputPortInformation()

int vtkRemoteWriterHelper::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ WriteLocally()

void vtkRemoteWriterHelper::WriteLocally ( vtkDataObject * input )

protected

Internal method that setup the file name and delegates Write in this->Writer.

Member Data Documentation

◆ OutputDestination

vtkTypeUInt32 vtkRemoteWriterHelper::OutputDestination = vtkPVSession::CLIENT

protected

Definition at line 143 of file vtkRemoteWriterHelper.h.

◆ State

int vtkRemoteWriterHelper::State = WRITE

protected

Definition at line 144 of file vtkRemoteWriterHelper.h.

◆ Writer

vtkAlgorithm* vtkRemoteWriterHelper::Writer = nullptr

protected

Definition at line 145 of file vtkRemoteWriterHelper.h.

◆ Interpreter

vtkClientServerInterpreter* vtkRemoteWriterHelper::Interpreter = nullptr

protected

Definition at line 146 of file vtkRemoteWriterHelper.h.

◆ TryWritingInBackground

bool vtkRemoteWriterHelper::TryWritingInBackground = false

protected

Definition at line 147 of file vtkRemoteWriterHelper.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkRemoteWriterHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkRemoteWriterHelper() [1/2]

◆ vtkRemoteWriterHelper() [2/2]

◆ ~vtkRemoteWriterHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetWriter()

◆ GetWriter()

◆ SetOutputDestination()

◆ GetOutputDestination()

◆ SetTryWritingInBackground()

◆ GetTryWritingInBackground()

◆ TryWritingInBackgroundOn()

◆ TryWritingInBackgroundOff()

◆ SetState()

◆ GetState()

◆ SetInterpreter()

◆ GetInterpreter()

◆ operator=()

◆ Wait() [1/2]

◆ Wait() [2/2]

◆ Write()

◆ RequestData()

◆ FillInputPortInformation()

◆ WriteLocally()

Member Data Documentation

◆ OutputDestination

◆ State

◆ Writer

◆ Interpreter

◆ TryWritingInBackground