vtkCollectGraph Class Reference

#include <vtkCollectGraph.h>

Inheritance diagram for vtkCollectGraph:

Inheritance graph
[legend]
Collaboration diagram for vtkCollectGraph:

Collaboration graph
[legend]

List of all members.


Detailed Description

Collect distributed graph.

This filter has code to collect a graph from across processes onto vertex 0. Collection can be turned on or off using the "PassThrough" flag.

Definition at line 34 of file vtkCollectGraph.h.


Public Types

enum  { DIRECTED_OUTPUT, UNDIRECTED_OUTPUT, USE_INPUT_TYPE }
typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetController (vtkMultiProcessController *)
virtual vtkMultiProcessControllerGetController ()
virtual void SetSocketController (vtkSocketController *)
virtual vtkSocketControllerGetSocketController ()
virtual void SetPassThrough (int)
virtual int GetPassThrough ()
virtual void PassThroughOn ()
virtual void PassThroughOff ()
virtual void SetOutputType (int)
virtual int GetOutputType ()

Static Public Member Functions

static vtkCollectGraphNew ()
static int IsTypeOf (const char *type)
static vtkCollectGraphSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCollectGraph ()
 ~vtkCollectGraph ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int PassThrough
int OutputType
vtkMultiProcessControllerController
vtkSocketControllerSocketController

Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 38 of file vtkCollectGraph.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
DIRECTED_OUTPUT 
UNDIRECTED_OUTPUT 
USE_INPUT_TYPE 

Definition at line 64 of file vtkCollectGraph.h.


Constructor & Destructor Documentation

vtkCollectGraph::vtkCollectGraph (  )  [protected]

vtkCollectGraph::~vtkCollectGraph (  )  [protected]


Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGraphAlgorithm.

virtual const char* vtkCollectGraph::GetClassName (  )  [virtual]

Reimplemented from vtkGraphAlgorithm.

static int vtkCollectGraph::IsTypeOf ( const char *  name  )  [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

virtual int vtkCollectGraph::IsA ( const char *  name  )  [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

static vtkCollectGraph* vtkCollectGraph::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkGraphAlgorithm.

void vtkCollectGraph::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 vtkGraphAlgorithm.

virtual void vtkCollectGraph::SetController ( vtkMultiProcessController  )  [virtual]

By defualt this filter uses the global controller, but this method can be used to set another instead.

virtual vtkMultiProcessController* vtkCollectGraph::GetController (  )  [virtual]

By defualt this filter uses the global controller, but this method can be used to set another instead.

virtual void vtkCollectGraph::SetSocketController ( vtkSocketController  )  [virtual]

When this filter is being used in client-server mode, this is the controller used to communicate between client and server. Client should not set the other controller.

virtual vtkSocketController* vtkCollectGraph::GetSocketController (  )  [virtual]

When this filter is being used in client-server mode, this is the controller used to communicate between client and server. Client should not set the other controller.

virtual void vtkCollectGraph::SetPassThrough ( int   )  [virtual]

To collect or just copy input to output. Off (collect) by default.

virtual int vtkCollectGraph::GetPassThrough (  )  [virtual]

To collect or just copy input to output. Off (collect) by default.

virtual void vtkCollectGraph::PassThroughOn (  )  [virtual]

To collect or just copy input to output. Off (collect) by default.

virtual void vtkCollectGraph::PassThroughOff (  )  [virtual]

To collect or just copy input to output. Off (collect) by default.

virtual void vtkCollectGraph::SetOutputType ( int   )  [virtual]

Directedness flag, used to signal whether the output graph is directed or undirected. DIRECTED_OUTPUT expects that this filter is generating a directed graph. UNDIRECTED_OUTPUT expects that this filter is generating an undirected graph. DIRECTED_OUTPUT and UNDIRECTED_OUTPUT flags should only be set on the client filter. Server filters should be set to USE_INPUT_TYPE since they have valid input and the directedness is determined from the input type.

virtual int vtkCollectGraph::GetOutputType (  )  [virtual]

Directedness flag, used to signal whether the output graph is directed or undirected. DIRECTED_OUTPUT expects that this filter is generating a directed graph. UNDIRECTED_OUTPUT expects that this filter is generating an undirected graph. DIRECTED_OUTPUT and UNDIRECTED_OUTPUT flags should only be set on the client filter. Server filters should be set to USE_INPUT_TYPE since they have valid input and the directedness is determined from the input type.

virtual int vtkCollectGraph::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGraphAlgorithm.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGraphAlgorithm.

virtual int vtkCollectGraph::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkGraphAlgorithm.

virtual int vtkCollectGraph::RequestDataObject ( vtkInformation ,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

By default, creates the same output type as the input type.

Reimplemented from vtkGraphAlgorithm.


Member Data Documentation

Definition at line 87 of file vtkCollectGraph.h.

int vtkCollectGraph::OutputType [protected]

Definition at line 88 of file vtkCollectGraph.h.

Definition at line 96 of file vtkCollectGraph.h.

Definition at line 97 of file vtkCollectGraph.h.


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

Generated on Mon Sep 27 18:20:04 2010 for VTK by  doxygen 1.5.6