vtkPBGLCollectGraph Class Reference

#include <vtkPBGLCollectGraph.h>

Inheritance diagram for vtkPBGLCollectGraph:

Inheritance graph
[legend]
Collaboration diagram for vtkPBGLCollectGraph:

Collaboration graph
[legend]

List of all members.


Detailed Description

Collects all of the pieces of a distributed vtkGraph into a single, non-distributed vtkGraph.

This VTK class takes in a distributed vtkGraph and collects all of its vertices and edges into a single, non-distributed vtkGraph, which can either be stored on a single processor (all other processors will receive empty vtkGraphs) or can be replicated across all processors.

When using this filter, be careful about collecting a very large distributed graph, because the processors receiving the resulting non-distributed vtkGraph may not have enough memory to represent the entire graph. This filter is most likely to be useful after a distributed vtkGraph algorithm has identified some small subset of the graph for further inspection, at which point it might make sense to collect that graph for, e.g., visualization.

See also:
vtkGraph
Examples:
vtkPBGLCollectGraph (Examples)
Tests:
vtkPBGLCollectGraph (Tests)

Definition at line 64 of file vtkPBGLCollectGraph.h.


Public Types

typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetTargetProcessor ()
virtual void SetTargetProcessor (int)
virtual bool GetReplicateGraph ()
virtual void SetReplicateGraph (bool)
virtual void ReplicateGraphOn ()
virtual void ReplicateGraphOff ()
virtual bool GetCopyVertexData ()
virtual void SetCopyVertexData (bool)
virtual void CopyVertexDataOn ()
virtual void CopyVertexDataOff ()
virtual bool GetCopyEdgeData ()
virtual void SetCopyEdgeData (bool)
virtual void CopyEdgeDataOn ()
virtual void CopyEdgeDataOff ()
virtual bool GetCreateOriginProcessArray ()
virtual void SetCreateOriginProcessArray (bool)
virtual void CreateOriginProcessArrayOn ()
virtual void CreateOriginProcessArrayOff ()
virtual void SetOriginProcessArrayName (const char *)

Static Public Member Functions

static vtkPBGLCollectGraphNew ()
static int IsTypeOf (const char *type)
static vtkPBGLCollectGraphSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPBGLCollectGraph ()
 ~vtkPBGLCollectGraph ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
void CopyStructureOfDataSetAttributes (vtkDataSetAttributes *inAttrs, vtkDataSetAttributes *outAttrs, vtkIdType numberOfTuples)

Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 68 of file vtkPBGLCollectGraph.h.


Constructor & Destructor Documentation

vtkPBGLCollectGraph::vtkPBGLCollectGraph (  )  [protected]

vtkPBGLCollectGraph::~vtkPBGLCollectGraph (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkGraphAlgorithm.

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

Reimplemented from vtkGraphAlgorithm.

static int vtkPBGLCollectGraph::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 vtkPBGLCollectGraph::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 vtkPBGLCollectGraph* vtkPBGLCollectGraph::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkGraphAlgorithm.

void vtkPBGLCollectGraph::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 int vtkPBGLCollectGraph::GetTargetProcessor (  )  [virtual]

The rank of the target processor, where the non-distributed vtkGraph will be created. All other target processors will receive an empty, non-distributed vtkGraph. Only valid when ReplicateGraph is false (the default). The default target processor is rank 0.

virtual void vtkPBGLCollectGraph::SetTargetProcessor ( int   )  [virtual]

The rank of the target processor, where the non-distributed vtkGraph will be created. All other target processors will receive an empty, non-distributed vtkGraph. Only valid when ReplicateGraph is false (the default). The default target processor is rank 0.

virtual bool vtkPBGLCollectGraph::GetReplicateGraph (  )  [virtual]

When true, the non-distributed vtkGraph generated by this filter will be replicated across all of the processors. Otherwise, the non-distributed vtkGraph will only be available on the processor with rank TargetProcessor. Defaults to false.

virtual void vtkPBGLCollectGraph::SetReplicateGraph ( bool   )  [virtual]

When true, the non-distributed vtkGraph generated by this filter will be replicated across all of the processors. Otherwise, the non-distributed vtkGraph will only be available on the processor with rank TargetProcessor. Defaults to false.

virtual void vtkPBGLCollectGraph::ReplicateGraphOn (  )  [virtual]

When true, the non-distributed vtkGraph generated by this filter will be replicated across all of the processors. Otherwise, the non-distributed vtkGraph will only be available on the processor with rank TargetProcessor. Defaults to false.

virtual void vtkPBGLCollectGraph::ReplicateGraphOff (  )  [virtual]

When true, the non-distributed vtkGraph generated by this filter will be replicated across all of the processors. Otherwise, the non-distributed vtkGraph will only be available on the processor with rank TargetProcessor. Defaults to false.

virtual bool vtkPBGLCollectGraph::GetCopyVertexData (  )  [virtual]

When true, vertex data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual void vtkPBGLCollectGraph::SetCopyVertexData ( bool   )  [virtual]

When true, vertex data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual void vtkPBGLCollectGraph::CopyVertexDataOn (  )  [virtual]

When true, vertex data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual void vtkPBGLCollectGraph::CopyVertexDataOff (  )  [virtual]

When true, vertex data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual bool vtkPBGLCollectGraph::GetCopyEdgeData (  )  [virtual]

When true, edge data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual void vtkPBGLCollectGraph::SetCopyEdgeData ( bool   )  [virtual]

When true, edge data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual void vtkPBGLCollectGraph::CopyEdgeDataOn (  )  [virtual]

When true, edge data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual void vtkPBGLCollectGraph::CopyEdgeDataOff (  )  [virtual]

When true, edge data will be copied from the distributed graph to the resulting non-distributed graph. Defaults to true.

virtual bool vtkPBGLCollectGraph::GetCreateOriginProcessArray (  )  [virtual]

When true, a new attribute array will be added to the output graph that stores the mpi process id from which each vertex was stored in the distributed vtkGraph.

virtual void vtkPBGLCollectGraph::SetCreateOriginProcessArray ( bool   )  [virtual]

When true, a new attribute array will be added to the output graph that stores the mpi process id from which each vertex was stored in the distributed vtkGraph.

virtual void vtkPBGLCollectGraph::CreateOriginProcessArrayOn (  )  [virtual]

When true, a new attribute array will be added to the output graph that stores the mpi process id from which each vertex was stored in the distributed vtkGraph.

virtual void vtkPBGLCollectGraph::CreateOriginProcessArrayOff (  )  [virtual]

When true, a new attribute array will be added to the output graph that stores the mpi process id from which each vertex was stored in the distributed vtkGraph.

virtual void vtkPBGLCollectGraph::SetOriginProcessArrayName ( const char *   )  [virtual]

Sets the name of the array storing the process-id's for each vertex. If not set, defaults to "ProcessorID"

virtual int vtkPBGLCollectGraph::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 vtkPBGLCollectGraph::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkGraphAlgorithm.

virtual int vtkPBGLCollectGraph::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 vtkGraphAlgorithm.

void vtkPBGLCollectGraph::CopyStructureOfDataSetAttributes ( vtkDataSetAttributes inAttrs,
vtkDataSetAttributes outAttrs,
vtkIdType  numberOfTuples 
) [protected]

Copy the structure of the incoming data set attributes (inAttrs) to the output data set attributes (outAttrs), where the latter has the given number of tuples.


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

Generated on Mon Sep 27 18:39:33 2010 for VTK by  doxygen 1.5.6