Parallel]

InputPort connects the pipeline in this process to one in another processes. More...

#include <vtkInputPort.h>

Inheritance diagram for vtkInputPort:

[legend]Collaboration diagram for vtkInputPort:


Public Types
enum	Tags { DOWN_DATA_TIME_TAG = 98970, UPDATE_EXTENT_TAG = 98971, TRANSFER_NEEDED_TAG = 98972, INFORMATION_TRANSFER_TAG = 98973, DATA_TRANSFER_TAG = 98974, NEW_DATA_TIME_TAG = 98975, DATA_TYPE_TAG = 98976 }
	Arbitrary tags used by the ports for communication. More...
Public Member Functions
	vtkTypeRevisionMacro (vtkInputPort, vtkDataSetAlgorithm)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the state of this object.
void	SetRemoteProcessId (int id)
	Specify the id of the process in which the associated vtkOutputPort exists.
int	GetRemoteProcessId () const
	Give the id of the process in which the associated vtkOutputPort exist.
void	SetTag (int tag)
	The matching OutputPort is specified by the output port's process and a tag.
int	GetTag () const
	Give the tag of the remote vtkOutputPort.
unsigned long	GetMTime ()
	Give the MTime also considering the other process.
vtkMultiProcessController *	GetController ()
	Access to the controller used for communication.
virtual void	SetController (vtkMultiProcessController *controller)
	Specify the controller in use.
void	SetDoUpdateInformation (int boolean)
	If DoUpdateInformation if false (it is true by default), UpdateInformation is not performed during Update.
int	GetDoUpdateInformation () const
	Give the current state of DoUpdateInformation.
Static Public Member Functions
static vtkInputPort *	New ()
	Instantiate a new object of this type.
Protected Member Functions
	vtkInputPort ()
	~vtkInputPort ()
	vtkSetVector6Macro (LastUpdateExtent, int)
int	UpdateExtentIsOutsideOfTheExtent (vtkDataObject *output)
virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	see the vtkAlgorithm for what these methods do
Protected Attributes
vtkMultiProcessController *	Controller
int	RemoteProcessId
int	Tag
unsigned long	DataTime
unsigned long	UpStreamMTime
int	DoUpdateInformation
int	LastUpdatePiece
int	LastUpdateNumberOfPieces
int	LastUpdateGhostLevel
int	LastUpdateExtent [6]

Detailed Description

InputPort connects the pipeline in this process to one in another processes.

It communicates all the pipeline protocol so that the fact you are running in multiple processes is transparent. An input port is used as a source (input to a process). One is placed at the start of a pipeline, and has a single corresponding output port in another process (specified by RemoteProcessId).

See also:: vtkOutputPort vtkMultiProcessController

Note:: This class has been depreciated as of VTK 5.2.

Definition at line 48 of file vtkInputPort.h.

Member Enumeration Documentation

enum vtkInputPort::Tags

Arbitrary tags used by the ports for communication.

Enumerator:

DOWN_DATA_TIME_TAG
UPDATE_EXTENT_TAG
TRANSFER_NEEDED_TAG
INFORMATION_TRANSFER_TAG
DATA_TRANSFER_TAG
NEW_DATA_TIME_TAG
DATA_TYPE_TAG

Definition at line 138 of file vtkInputPort.h.

Constructor & Destructor Documentation

vtkInputPort::vtkInputPort ( ) [protected]

vtkInputPort::~vtkInputPort ( ) [protected]

Member Function Documentation

static vtkInputPort* vtkInputPort::New ( ) [static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:: The new object.

Reimplemented from vtkDataSetAlgorithm.

vtkInputPort::vtkTypeRevisionMacro	(	vtkInputPort	,
		vtkDataSetAlgorithm
	)

void vtkInputPort::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Print the state of this object.

Parameters:

	os	The output stream.
	indent	The indentation level. Used for formating output.

Reimplemented from vtkDataSetAlgorithm.

void vtkInputPort::SetRemoteProcessId ( int id )

Specify the id of the process in which the associated vtkOutputPort exists.

Parameters:

The id of the remote process.

int vtkInputPort::GetRemoteProcessId ( ) const

Give the id of the process in which the associated vtkOutputPort exist.

Returns:: The id of the remote process.

void vtkInputPort::SetTag ( int tag )

The matching OutputPort is specified by the output port's process and a tag.

There can be more than one output port per process. THE TAG MUST BE EVEN BECAUSE TWO RMIs ARE CREATED FROM IT!!!

Parameters:

tag

The id of the remote output.

int vtkInputPort::GetTag ( ) const

Give the tag of the remote vtkOutputPort.

Returns:: The remote tag.

unsigned long vtkInputPort::GetMTime ( ) [virtual]

Give the MTime also considering the other process.

Returns:: The MTime.

Reimplemented from vtkObject.

vtkMultiProcessController* vtkInputPort::GetController ( ) [inline]

Access to the controller used for communication.

By default, the global controller is used.

Returns:: The controller.

Definition at line 107 of file vtkInputPort.h.

virtual void vtkInputPort::SetController ( vtkMultiProcessController * controller ) [virtual]

Specify the controller in use.

Parameters:

controller

The controller.

void vtkInputPort::SetDoUpdateInformation ( int boolean )

If DoUpdateInformation if false (it is true by default), UpdateInformation is not performed during Update.

This can be used to avoid unnecessary communication once the data has been transferred. However, if the pipeline changes upstream, DoUpdateInformation has to be set to true again. Otherwise, Updata will not occur.

Parameters:

boolean

The argument: 0 if false, true otherwise.

int vtkInputPort::GetDoUpdateInformation ( ) const

Give the current state of DoUpdateInformation.

Returns:: The current state of DoUpdateInformation: 0 if false, true otherwise

vtkInputPort::vtkSetVector6Macro	(	LastUpdateExtent	,
		int
	)			`[protected]`

int vtkInputPort::UpdateExtentIsOutsideOfTheExtent ( vtkDataObject * output ) [protected]

virtual int vtkInputPort::RequestDataObject	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkInputPort::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkInputPort::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`