vtkInputPort Class Reference
#include <vtkInputPort.h>
Inheritance diagram for vtkInputPort:
[legend]Collaboration diagram for vtkInputPort:
[legend]List of all members.
Detailed Description
Receives data from another process.
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
- Created by:
-
- CVS contributions (if > 5%):
- Martin, Ken (61%)
- Geveci, Berk (33%)
- CVS logs (CVSweb):
/Parallel/vtkInputPort.cxx)/Parallel/vtkInputPort.h)
- Examples:
- vtkInputPort (Examples)
- Tests:
- vtkInputPort (Tests)
Definition at line 60 of file vtkInputPort.h.
|
Public Types |
| typedef vtkSource | Superclass |
| 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
} |
Public Member Functions |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| unsigned long | GetMTime () |
|
| vtkPolyData * | GetPolyDataOutput () |
| vtkUnstructuredGrid * | GetUnstructuredGridOutput () |
| vtkStructuredGrid * | GetStructuredGridOutput () |
| vtkRectilinearGrid * | GetRectilinearGridOutput () |
| vtkStructuredPoints * | GetStructuredPointsOutput () |
| vtkImageData * | GetImageDataOutput () |
|
| virtual void | SetRemoteProcessId (int) |
| virtual int | GetRemoteProcessId () |
| virtual void | SetTag (int) |
| virtual int | GetTag () |
|
| vtkMultiProcessController * | GetController () |
| virtual void | SetController (vtkMultiProcessController *) |
|
| virtual void | SetDoUpdateInformation (int) |
| virtual int | GetDoUpdateInformation () |
Static Public Member Functions |
| vtkInputPort * | New () |
| int | IsTypeOf (const char *type) |
| vtkInputPort * | SafeDownCast (vtkObject *o) |
Protected Member Functions |
| | vtkInputPort () |
| | ~vtkInputPort () |
| virtual void | SetLastUpdateExtent (int, int, int, int, int, int) |
| virtual void | SetLastUpdateExtent (int[6]) |
| int | UpdateExtentIsOutsideOfTheExtent (vtkDataObject *output) |
| void | ExecuteInformation () |
| void | ExecuteData (vtkDataObject *output) |
| virtual int | FillOutputPortInformation (int port, vtkInformation *info) |
Protected Attributes |
| vtkMultiProcessController * | Controller |
| int | RemoteProcessId |
| int | Tag |
| unsigned long | DataTime |
| unsigned long | UpStreamMTime |
| int | TransferNeeded |
| int | DoUpdateInformation |
| int | LastUpdatePiece |
| int | LastUpdateNumberOfPieces |
| int | LastUpdateGhostLevel |
| int | LastUpdateExtent [6] |
Member Typedef Documentation
Member Enumeration Documentation
|
|
- Enumeration values:
-
| DOWN_DATA_TIME_TAG |
|
| UPDATE_EXTENT_TAG |
|
| TRANSFER_NEEDED_TAG |
|
| INFORMATION_TRANSFER_TAG |
|
| DATA_TRANSFER_TAG |
|
| NEW_DATA_TIME_TAG |
|
Definition at line 113 of file vtkInputPort.h. |
Constructor & Destructor Documentation
| vtkInputPort::vtkInputPort |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm. |
| virtual const char* vtkInputPort::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkInputPort::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkSource. |
| virtual int vtkInputPort::IsA |
( |
const char * |
type |
) |
[virtual] |
|
|
|
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkSource. |
| void vtkInputPort::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkSource. |
|
|
Note: You have to ask for the right type, and it has to match the type of the up stream port input, or you will get an error. We have to live with the fact that the error will not occur until an update is called. |
|
|
Note: You have to ask for the right type, and it has to match the type of the up stream port input, or you will get an error. We have to live with the fact that the error will not occur until an update is called. |
|
|
Note: You have to ask for the right type, and it has to match the type of the up stream port input, or you will get an error. We have to live with the fact that the error will not occur until an update is called. |
|
|
Note: You have to ask for the right type, and it has to match the type of the up stream port input, or you will get an error. We have to live with the fact that the error will not occur until an update is called. |
|
|
Note: You have to ask for the right type, and it has to match the type of the up stream port input, or you will get an error. We have to live with the fact that the error will not occur until an update is called. |
|
|
Note: You have to ask for the right type, and it has to match the type of the up stream port input, or you will get an error. We have to live with the fact that the error will not occur until an update is called. |
| virtual void vtkInputPort::SetRemoteProcessId |
( |
int |
|
) |
[virtual] |
|
|
|
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!!! |
| virtual int vtkInputPort::GetRemoteProcessId |
( |
|
) |
[virtual] |
|
|
|
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!!! |
| virtual void vtkInputPort::SetTag |
( |
int |
|
) |
[virtual] |
|
|
|
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!!! |
| virtual int vtkInputPort::GetTag |
( |
|
) |
[virtual] |
|
|
|
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!!! |
| unsigned long vtkInputPort::GetMTime |
( |
|
) |
[virtual] |
|
|
|
Return the MTime also considering the other process
Reimplemented from vtkObject. |
|
|
Access to the controller used for communication. By default, the global controller is used.
Definition at line 96 of file vtkInputPort.h. |
|
|
Access to the controller used for communication. By default, the global controller is used. |
| virtual void vtkInputPort::SetDoUpdateInformation |
( |
int |
|
) |
[virtual] |
|
|
|
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. |
| virtual int vtkInputPort::GetDoUpdateInformation |
( |
|
) |
[virtual] |
|
|
|
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. |
| virtual void vtkInputPort::SetLastUpdateExtent |
( |
int |
, |
|
|
int |
, |
|
|
int |
, |
|
|
int |
, |
|
|
int |
, |
|
|
int |
|
|
) |
[protected, virtual] |
|
| virtual void vtkInputPort::SetLastUpdateExtent |
( |
int |
[6] |
) |
[protected, virtual] |
|
| int vtkInputPort::UpdateExtentIsOutsideOfTheExtent |
( |
vtkDataObject * |
output |
) |
[protected] |
|
| void vtkInputPort::ExecuteInformation |
( |
|
) |
[protected, virtual] |
|
| void vtkInputPort::ExecuteData |
( |
vtkDataObject * |
output |
) |
[protected, virtual] |
|
|
|
This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method
Reimplemented from vtkSource. |
| virtual int vtkInputPort::FillOutputPortInformation |
( |
int |
port, |
|
|
vtkInformation * |
info |
|
) |
[protected, virtual] |
|
|
|
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkSource. |
Member Data Documentation
The documentation for this class was generated from the following file: