VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkChacoReader Class Reference

Read a Chaco file and create a vtkUnstructuredGrid. More...

#include <vtkChacoReader.h>

Inheritance diagram for vtkChacoReader:
Inheritance graph
[legend]
Collaboration diagram for vtkChacoReader:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkChacoReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetBaseName (const char *)
virtual char * GetBaseName ()
virtual void SetGenerateGlobalElementIdArray (int)
virtual int GetGenerateGlobalElementIdArray ()
virtual void GenerateGlobalElementIdArrayOn ()
virtual void GenerateGlobalElementIdArrayOff ()
virtual void SetGenerateGlobalNodeIdArray (int)
virtual int GetGenerateGlobalNodeIdArray ()
virtual void GenerateGlobalNodeIdArrayOn ()
virtual void GenerateGlobalNodeIdArrayOff ()
virtual void SetGenerateVertexWeightArrays (int)
virtual int GetGenerateVertexWeightArrays ()
virtual void GenerateVertexWeightArraysOn ()
virtual void GenerateVertexWeightArraysOff ()
virtual int GetNumberOfVertexWeights ()
const char * GetVertexWeightArrayName (int weight)
virtual void SetGenerateEdgeWeightArrays (int)
virtual int GetGenerateEdgeWeightArrays ()
virtual void GenerateEdgeWeightArraysOn ()
virtual void GenerateEdgeWeightArraysOff ()
virtual int GetNumberOfEdgeWeights ()
const char * GetEdgeWeightArrayName (int weight)
virtual int GetNumberOfCellWeightArrays ()
virtual int GetNumberOfPointWeightArrays ()
virtual int GetDimensionality ()
virtual vtkIdType GetNumberOfEdges ()
virtual vtkIdType GetNumberOfVertices ()

Static Public Member Functions

static vtkChacoReaderNew ()
static int IsTypeOf (const char *type)
static vtkChacoReaderSafeDownCast (vtkObjectBase *o)
static const char * GetGlobalElementIdArrayName ()
static const char * GetGlobalNodeIdArrayName ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkChacoReader ()
 ~vtkChacoReader ()
int BuildOutputGrid (vtkUnstructuredGrid *gr)
void CloseCurrentFile ()
int OpenCurrentFile ()
int InputGeom (vtkIdType nvtxs, int igeom, double *x, double *y, double *z)
int InputGraph1 ()
int InputGraph2 (vtkIdType **start, vtkIdType **adjacency, double **vweights, double **eweights)
int GetCoordsMetadata ()
void GetGraphMetadata ()
int ReadFile (vtkUnstructuredGrid *output)
void AddElementIds (vtkUnstructuredGrid *output)
void AddNodeIds (vtkUnstructuredGrid *output)
void MakeWeightArrayNames (int nv, int ne)
virtual void SetCurrentBaseName (const char *)
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

char * BaseName
int GenerateGlobalElementIdArray
int GenerateGlobalNodeIdArray
int GenerateVertexWeightArrays
int GenerateEdgeWeightArrays
FILE * CurrentGeometryFP
FILE * CurrentGraphFP
char * CurrentBaseName
char ** VarrayName
char ** EarrayName
int Dimensionality
vtkIdType NumberOfVertices
vtkIdType NumberOfEdges
int NumberOfVertexWeights
int NumberOfEdgeWeights
int GraphFileHasVertexNumbers
int NumberOfPointWeightArrays
int NumberOfCellWeightArrays
vtkUnstructuredGridDataCache
int RemakeDataCacheFlag

Detailed Description

Read a Chaco file and create a vtkUnstructuredGrid.

vtkChacoReader is an unstructured grid source object that reads Chaco files. The reader DOES NOT respond to piece requests. Chaco is a graph partitioning package developed at Sandia National Laboratories in the early 1990s. (http://www.cs.sandia.gov/~bahendr/chaco.html)

Note that the Chaco "edges" become VTK "cells", and the Chaco "vertices" become VTK "points".

Tests:
vtkChacoReader (Tests)

Definition at line 41 of file vtkChacoReader.h.


Member Typedef Documentation

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

Definition at line 45 of file vtkChacoReader.h.


Constructor & Destructor Documentation


Member Function Documentation

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

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

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

static int vtkChacoReader::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 vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

virtual int vtkChacoReader::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 vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

virtual vtkObjectBase* vtkChacoReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

void vtkChacoReader::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 vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

virtual void vtkChacoReader::SetBaseName ( const char *  ) [virtual]

Specify the base name of the Chaco files. The reader will try to open BaseName.coords and BaseName.graph.

virtual char* vtkChacoReader::GetBaseName ( ) [virtual]

Indicate whether this reader should create a cell array containing global IDs for the cells in the output vtkUnstructuredGrid. These cells represent the edges that were in the Chaco file. Each edge is a vtkLine. Default is ON.

static const char* vtkChacoReader::GetGlobalElementIdArrayName ( ) [inline, static]

Definition at line 63 of file vtkChacoReader.h.

virtual void vtkChacoReader::SetGenerateGlobalNodeIdArray ( int  ) [virtual]

Indicate whether this reader should create a point array of global IDs for the points in the output vtkUnstructuredGrid. These points are the vertices that were in the Chaco file. Global point IDs start at "1" for the first vertex in BaseName.coords and go up from there. Default is ON.

virtual void vtkChacoReader::GenerateGlobalNodeIdArrayOn ( ) [virtual]
static const char* vtkChacoReader::GetGlobalNodeIdArrayName ( ) [inline, static]

Definition at line 75 of file vtkChacoReader.h.

virtual void vtkChacoReader::SetGenerateVertexWeightArrays ( int  ) [virtual]

Indicate whether this reader should create a point array for each vertex weight in the Chaco file. Default is OFF.

Returns the number of weights per vertex in the Chaco file, whether or not GenerateVertexWeightArrays is ON.

This method returns the name of the selected Vertex weight point array. If you did not turn on GenerateVertexWeightArrays, or if the weight you requested is invalid, it returns NULL. Weights begin at one and go up to NumberOfVertexWeights. This is a pointer to our copy of the name, so don't "delete" it.

virtual void vtkChacoReader::SetGenerateEdgeWeightArrays ( int  ) [virtual]

Each edge in the Chaco file connects two vertices. The file may specify one or more weights for each edge. (The weight for an edge from vertex A to vertex B equals the weight from B to A.) Indicate with the following parameter whether this reader should create a cell array for each weight for every edge. Default is OFF.

virtual void vtkChacoReader::GenerateEdgeWeightArraysOn ( ) [virtual]
virtual void vtkChacoReader::GenerateEdgeWeightArraysOff ( ) [virtual]

Returns the number of weights per edge in the Chaco file, whether or not GenerateEdgeWeightArrays is ON.

This method returns the name of the selected Edge weight cell array. If you did not turn on GenerateEdgeWeightArrays, or if the weight you requested is invalid, it returns NULL. Weights begin at one and go up to NumberOfEdgeWeights. This is a pointer to our copy of the name, so don't "delete" it.

virtual int vtkChacoReader::GetDimensionality ( ) [virtual]

Access to meta data generated by RequestInformation.

Access to meta data generated by RequestInformation.

Access to meta data generated by RequestInformation.

After this filter executes, this method returns the number of cell arrays that were created to hold the edge weights. It is equal to NumberOfEdgeWeights if GenerateEdgeWeightArrays was ON.

After this filter executes, this method returns the number of point arrays that were created to hold the vertex weights. It is equal to NumberOfVertexWeights if GenerateVertexWeightArrays was ON.

void vtkChacoReader::CloseCurrentFile ( ) [protected]
int vtkChacoReader::InputGeom ( vtkIdType  nvtxs,
int  igeom,
double x,
double y,
double z 
) [protected]
int vtkChacoReader::InputGraph2 ( vtkIdType **  start,
vtkIdType **  adjacency,
double **  vweights,
double **  eweights 
) [protected]
void vtkChacoReader::GetGraphMetadata ( ) [protected]
void vtkChacoReader::AddElementIds ( vtkUnstructuredGrid output) [protected]
void vtkChacoReader::AddNodeIds ( vtkUnstructuredGrid output) [protected]
void vtkChacoReader::MakeWeightArrayNames ( int  nv,
int  ne 
) [protected]
virtual void vtkChacoReader::SetCurrentBaseName ( const char *  ) [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

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

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

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.


Member Data Documentation

char* vtkChacoReader::BaseName [protected]

Definition at line 166 of file vtkChacoReader.h.

Definition at line 167 of file vtkChacoReader.h.

Definition at line 168 of file vtkChacoReader.h.

Definition at line 170 of file vtkChacoReader.h.

Definition at line 171 of file vtkChacoReader.h.

Definition at line 173 of file vtkChacoReader.h.

FILE* vtkChacoReader::CurrentGraphFP [protected]

Definition at line 174 of file vtkChacoReader.h.

Definition at line 175 of file vtkChacoReader.h.

char** vtkChacoReader::VarrayName [protected]

Definition at line 176 of file vtkChacoReader.h.

char** vtkChacoReader::EarrayName [protected]

Definition at line 179 of file vtkChacoReader.h.

Definition at line 186 of file vtkChacoReader.h.

Definition at line 187 of file vtkChacoReader.h.

Definition at line 188 of file vtkChacoReader.h.

Definition at line 189 of file vtkChacoReader.h.

Definition at line 190 of file vtkChacoReader.h.

Definition at line 191 of file vtkChacoReader.h.

Definition at line 195 of file vtkChacoReader.h.

Definition at line 196 of file vtkChacoReader.h.

Definition at line 201 of file vtkChacoReader.h.

Definition at line 204 of file vtkChacoReader.h.


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