vtkChacoReader Class Reference

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

#include <vtkChacoReader.h>

Inheritance diagram for vtkChacoReader:

Collaboration diagram for vtkChacoReader:

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Types inherited from vtkUnstructuredGridAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkChacoReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetBaseName (const char *)
	Specify the base name of the Chaco files.
virtual char *	GetBaseName ()
virtual void	SetGenerateGlobalElementIdArray (vtkTypeBool)
	Indicate whether this reader should create a cell array containing global IDs for the cells in the output vtkUnstructuredGrid.
virtual vtkTypeBool	GetGenerateGlobalElementIdArray ()
virtual void	GenerateGlobalElementIdArrayOn ()
virtual void	GenerateGlobalElementIdArrayOff ()
virtual void	SetGenerateGlobalNodeIdArray (vtkTypeBool)
	Indicate whether this reader should create a point array of global IDs for the points in the output vtkUnstructuredGrid.
virtual vtkTypeBool	GetGenerateGlobalNodeIdArray ()
virtual void	GenerateGlobalNodeIdArrayOn ()
virtual void	GenerateGlobalNodeIdArrayOff ()
virtual void	SetGenerateVertexWeightArrays (vtkTypeBool)
	Indicate whether this reader should create a point array for each vertex weight in the Chaco file.
virtual vtkTypeBool	GetGenerateVertexWeightArrays ()
virtual void	GenerateVertexWeightArraysOn ()
virtual void	GenerateVertexWeightArraysOff ()
virtual int	GetNumberOfVertexWeights ()
	Returns the number of weights per vertex in the Chaco file, whether or not GenerateVertexWeightArrays is ON.
const char *	GetVertexWeightArrayName (int weight)
	This method returns the name of the selected Vertex weight point array.
virtual void	SetGenerateEdgeWeightArrays (vtkTypeBool)
	Each edge in the Chaco file connects two vertices.
virtual vtkTypeBool	GetGenerateEdgeWeightArrays ()
virtual void	GenerateEdgeWeightArraysOn ()
virtual void	GenerateEdgeWeightArraysOff ()
virtual int	GetNumberOfEdgeWeights ()
	Returns the number of weights per edge in the Chaco file, whether or not GenerateEdgeWeightArrays is ON.
const char *	GetEdgeWeightArrayName (int weight)
	This method returns the name of the selected Edge weight cell array.
virtual int	GetNumberOfCellWeightArrays ()
	After this filter executes, this method returns the number of cell arrays that were created to hold the edge weights.
virtual int	GetNumberOfPointWeightArrays ()
	After this filter executes, this method returns the number of point arrays that were created to hold the vertex weights.
virtual int	GetDimensionality ()
	Access to meta data generated by RequestInformation.
virtual vtkIdType	GetNumberOfEdges ()
	Access to meta data generated by RequestInformation.
virtual vtkIdType	GetNumberOfVertices ()
	Access to meta data generated by RequestInformation.
Public Member Functions inherited from vtkUnstructuredGridAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkUnstructuredGridAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkUnstructuredGrid *	GetUnstructuredGridInput (int port)
vtkUnstructuredGrid *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkUnstructuredGrid *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkChacoReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkChacoReader *	SafeDownCast (vtkObjectBase *o)
static const char *	GetGlobalElementIdArrayName ()
static const char *	GetGlobalNodeIdArrayName ()
Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkUnstructuredGridAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
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 *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkChacoReader ()
	~vtkChacoReader () override
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 *) override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkUnstructuredGridAlgorithm ()
	~vtkUnstructuredGridAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
virtual int	RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
char *	BaseName
vtkTypeBool	GenerateGlobalElementIdArray
vtkTypeBool	GenerateGlobalNodeIdArray
vtkTypeBool	GenerateVertexWeightArrays
vtkTypeBool	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
vtkUnstructuredGrid *	DataCache
int	RemakeDataCacheFlag
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime
static vtkExecutive *	DefaultExecutivePrototype

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 28 of file vtkChacoReader.h.

Member Typedef Documentation

Superclass

typedef vtkUnstructuredGridAlgorithm vtkChacoReader::Superclass

Definition at line 32 of file vtkChacoReader.h.

Constructor & Destructor Documentation

vtkChacoReader()

vtkChacoReader::vtkChacoReader ( )

protected

~vtkChacoReader()

vtkChacoReader::~vtkChacoReader ( )

overrideprotected

Member Function Documentation

New()

static vtkChacoReader * vtkChacoReader::New ( )

static

IsTypeOf()

static vtkTypeBool vtkChacoReader::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

static vtkChacoReader * vtkChacoReader::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkChacoReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

NewInstance()

vtkChacoReader * vtkChacoReader::NewInstance

(

)

const

PrintSelf()

void vtkChacoReader::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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 vtkAlgorithm.

Reimplemented in vtkPChacoReader.

SetBaseName()

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.

GetBaseName()

virtual char * vtkChacoReader::GetBaseName ( )

virtual

SetGenerateGlobalElementIdArray()

virtual void vtkChacoReader::SetGenerateGlobalElementIdArray ( vtkTypeBool  )

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.

GetGenerateGlobalElementIdArray()

virtual vtkTypeBool vtkChacoReader::GetGenerateGlobalElementIdArray ( )

virtual

GenerateGlobalElementIdArrayOn()

virtual void vtkChacoReader::GenerateGlobalElementIdArrayOn ( )

virtual

GenerateGlobalElementIdArrayOff()

virtual void vtkChacoReader::GenerateGlobalElementIdArrayOff ( )

virtual

GetGlobalElementIdArrayName()

static const char * vtkChacoReader::GetGlobalElementIdArrayName ( )

inlinestatic

Definition at line 54 of file vtkChacoReader.h.

SetGenerateGlobalNodeIdArray()

virtual void vtkChacoReader::SetGenerateGlobalNodeIdArray ( vtkTypeBool  )

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.

GetGenerateGlobalNodeIdArray()

virtual vtkTypeBool vtkChacoReader::GetGenerateGlobalNodeIdArray ( )

virtual

GenerateGlobalNodeIdArrayOn()

virtual void vtkChacoReader::GenerateGlobalNodeIdArrayOn ( )

virtual

GenerateGlobalNodeIdArrayOff()

virtual void vtkChacoReader::GenerateGlobalNodeIdArrayOff ( )

virtual

GetGlobalNodeIdArrayName()

static const char * vtkChacoReader::GetGlobalNodeIdArrayName ( )

inlinestatic

Definition at line 68 of file vtkChacoReader.h.

SetGenerateVertexWeightArrays()

virtual void vtkChacoReader::SetGenerateVertexWeightArrays ( vtkTypeBool  )

virtual

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

Default is OFF.

GetGenerateVertexWeightArrays()

virtual vtkTypeBool vtkChacoReader::GetGenerateVertexWeightArrays ( )

virtual

GenerateVertexWeightArraysOn()

virtual void vtkChacoReader::GenerateVertexWeightArraysOn ( )

virtual

GenerateVertexWeightArraysOff()

virtual void vtkChacoReader::GenerateVertexWeightArraysOff ( )

virtual

GetNumberOfVertexWeights()

virtual int vtkChacoReader::GetNumberOfVertexWeights ( )

virtual

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

GetVertexWeightArrayName()

const char * vtkChacoReader::GetVertexWeightArrayName

(

int

weight

)

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 nullptr. Weights begin at one and go up to NumberOfVertexWeights. This is a pointer to our copy of the name, so don't "delete" it.

SetGenerateEdgeWeightArrays()

virtual void vtkChacoReader::SetGenerateEdgeWeightArrays ( vtkTypeBool  )

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.

GetGenerateEdgeWeightArrays()

virtual vtkTypeBool vtkChacoReader::GetGenerateEdgeWeightArrays ( )

virtual

GenerateEdgeWeightArraysOn()

virtual void vtkChacoReader::GenerateEdgeWeightArraysOn ( )

virtual

GenerateEdgeWeightArraysOff()

virtual void vtkChacoReader::GenerateEdgeWeightArraysOff ( )

virtual

GetNumberOfEdgeWeights()

virtual int vtkChacoReader::GetNumberOfEdgeWeights ( )

virtual

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

GetEdgeWeightArrayName()

const char * vtkChacoReader::GetEdgeWeightArrayName

(

int

weight

)

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 nullptr. Weights begin at one and go up to NumberOfEdgeWeights. This is a pointer to our copy of the name, so don't "delete" it.

GetDimensionality()

virtual int vtkChacoReader::GetDimensionality ( )

virtual

Access to meta data generated by RequestInformation.

GetNumberOfEdges()

virtual vtkIdType vtkChacoReader::GetNumberOfEdges ( )

virtual

Access to meta data generated by RequestInformation.

GetNumberOfVertices()

virtual vtkIdType vtkChacoReader::GetNumberOfVertices ( )

virtual

Access to meta data generated by RequestInformation.

GetNumberOfCellWeightArrays()

virtual int vtkChacoReader::GetNumberOfCellWeightArrays ( )

virtual

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.

GetNumberOfPointWeightArrays()

virtual int vtkChacoReader::GetNumberOfPointWeightArrays ( )

virtual

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.

BuildOutputGrid()

int vtkChacoReader::BuildOutputGrid ( vtkUnstructuredGrid *  gr )

protected

CloseCurrentFile()

void vtkChacoReader::CloseCurrentFile ( )

protected

OpenCurrentFile()

int vtkChacoReader::OpenCurrentFile ( )

protected

InputGeom()

int vtkChacoReader::InputGeom ( vtkIdType  nvtxs, int  igeom, double *  x, double *  y, double *  z  )

protected

InputGraph1()

int vtkChacoReader::InputGraph1 ( )

protected

InputGraph2()

int vtkChacoReader::InputGraph2 ( vtkIdType **  start, vtkIdType **  adjacency, double **  vweights, double **  eweights  )

protected

GetCoordsMetadata()

int vtkChacoReader::GetCoordsMetadata ( )

protected

GetGraphMetadata()

void vtkChacoReader::GetGraphMetadata ( )

protected

ReadFile()

int vtkChacoReader::ReadFile ( vtkUnstructuredGrid *  output )

protected

AddElementIds()

void vtkChacoReader::AddElementIds ( vtkUnstructuredGrid *  output )

protected

AddNodeIds()

void vtkChacoReader::AddNodeIds ( vtkUnstructuredGrid *  output )

protected

MakeWeightArrayNames()

void vtkChacoReader::MakeWeightArrayNames ( int  nv, int  ne  )

protected

SetCurrentBaseName()

virtual void vtkChacoReader::SetCurrentBaseName ( const char *  )

protectedvirtual

RequestInformation()

int vtkChacoReader::RequestInformation ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

RequestData()

int vtkChacoReader::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkPChacoReader.

Member Data Documentation

BaseName

char* vtkChacoReader::BaseName

protected

Definition at line 178 of file vtkChacoReader.h.

GenerateGlobalElementIdArray

vtkTypeBool vtkChacoReader::GenerateGlobalElementIdArray

protected

Definition at line 179 of file vtkChacoReader.h.

GenerateGlobalNodeIdArray

vtkTypeBool vtkChacoReader::GenerateGlobalNodeIdArray

protected

Definition at line 180 of file vtkChacoReader.h.

GenerateVertexWeightArrays

vtkTypeBool vtkChacoReader::GenerateVertexWeightArrays

protected

Definition at line 182 of file vtkChacoReader.h.

GenerateEdgeWeightArrays

vtkTypeBool vtkChacoReader::GenerateEdgeWeightArrays

protected

Definition at line 183 of file vtkChacoReader.h.

CurrentGeometryFP

FILE* vtkChacoReader::CurrentGeometryFP

protected

Definition at line 185 of file vtkChacoReader.h.

CurrentGraphFP

FILE* vtkChacoReader::CurrentGraphFP

protected

Definition at line 186 of file vtkChacoReader.h.

CurrentBaseName

char* vtkChacoReader::CurrentBaseName

protected

Definition at line 187 of file vtkChacoReader.h.

VarrayName

char** vtkChacoReader::VarrayName

protected

Definition at line 190 of file vtkChacoReader.h.

EarrayName

char** vtkChacoReader::EarrayName

protected

Definition at line 191 of file vtkChacoReader.h.

Dimensionality

int vtkChacoReader::Dimensionality

protected

Definition at line 198 of file vtkChacoReader.h.

NumberOfVertices

vtkIdType vtkChacoReader::NumberOfVertices

protected

Definition at line 199 of file vtkChacoReader.h.

NumberOfEdges

vtkIdType vtkChacoReader::NumberOfEdges

protected

Definition at line 200 of file vtkChacoReader.h.

NumberOfVertexWeights

int vtkChacoReader::NumberOfVertexWeights

protected

Definition at line 201 of file vtkChacoReader.h.

NumberOfEdgeWeights

int vtkChacoReader::NumberOfEdgeWeights

protected

Definition at line 202 of file vtkChacoReader.h.

GraphFileHasVertexNumbers

int vtkChacoReader::GraphFileHasVertexNumbers

protected

Definition at line 203 of file vtkChacoReader.h.

NumberOfPointWeightArrays

int vtkChacoReader::NumberOfPointWeightArrays

protected

Definition at line 207 of file vtkChacoReader.h.

NumberOfCellWeightArrays

int vtkChacoReader::NumberOfCellWeightArrays

protected

Definition at line 208 of file vtkChacoReader.h.

DataCache

vtkUnstructuredGrid* vtkChacoReader::DataCache

protected

Definition at line 213 of file vtkChacoReader.h.

RemakeDataCacheFlag

int vtkChacoReader::RemakeDataCacheFlag

protected

Definition at line 216 of file vtkChacoReader.h.

---

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

• IO/Geometry/vtkChacoReader.h