VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPBGLCollectGraph Class Reference

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

#include <vtkPBGLCollectGraph.h>

Inheritance diagram for vtkPBGLCollectGraph:
[legend]
Collaboration diagram for vtkPBGLCollectGraph:
[legend]

Public Types

typedef vtkGraphAlgorithm Superclass
 
- Public Types inherited from vtkGraphAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPBGLCollectGraphNewInstance () const
 
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 *)
 
- Public Member Functions inherited from vtkGraphAlgorithm
vtkGraphAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkGraphGetOutput ()
 
vtkGraphGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
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)
 
void SetUpdateExtent (int extent[6])
 
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)
 

Static Public Member Functions

static vtkPBGLCollectGraphNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPBGLCollectGraphSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGraphAlgorithm
static vtkGraphAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGraphAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
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 * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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)
 
- Protected Member Functions inherited from vtkGraphAlgorithm
 vtkGraphAlgorithm ()
 
 ~vtkGraphAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
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 vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
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)
 
virtual void SetErrorCode (unsigned long)
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 65 of file vtkPBGLCollectGraph.h.

Member Typedef Documentation

Definition at line 69 of file vtkPBGLCollectGraph.h.

Constructor & Destructor Documentation

vtkPBGLCollectGraph::vtkPBGLCollectGraph ( )
protected
vtkPBGLCollectGraph::~vtkPBGLCollectGraph ( )
protected

Member Function Documentation

static vtkPBGLCollectGraph* vtkPBGLCollectGraph::New ( )
static
static int vtkPBGLCollectGraph::IsTypeOf ( const char *  type)
static
virtual int vtkPBGLCollectGraph::IsA ( const char *  type)
virtual

Reimplemented from vtkGraphAlgorithm.

static vtkPBGLCollectGraph* vtkPBGLCollectGraph::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPBGLCollectGraph::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphAlgorithm.

vtkPBGLCollectGraph* vtkPBGLCollectGraph::NewInstance ( ) const
void vtkPBGLCollectGraph::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 
)
protectedvirtual

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

Reimplemented from vtkGraphAlgorithm.

virtual int vtkPBGLCollectGraph::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

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 
)
protectedvirtual

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: