#include "vtkIOXMLModule.h"
#include "vtkType.h"

Include dependency graph for vtkXMLWriterC.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	vtkXMLWriterC_New VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_New)
	Create a new instance of vtkXMLWriterC.

#define	vtkXMLWriterC_Delete VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Delete)
	Delete the writer object.

#define	vtkXMLWriterC_SetDataObjectType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetDataObjectType)
	Set the VTK data object type that will be written.

#define	vtkXMLWriterC_SetDataModeType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetDataModeType)
	Set the VTK writer data mode to either:

#define	vtkXMLWriterC_SetExtent VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetExtent)
	Set the extent of a structured data set.

#define	vtkXMLWriterC_SetPoints VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetPoints)
	Set the points of a point data set.

#define	vtkXMLWriterC_SetOrigin VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetOrigin)
	Set the origin of an image data set.

#define	vtkXMLWriterC_SetSpacing VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetSpacing)
	Set the spacing of an image data set.

#define	vtkXMLWriterC_SetCoordinates VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCoordinates)
	Set the coordinates along one axis of a rectilinear grid data set.

#define	vtkXMLWriterC_SetCellsWithType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellsWithType)
	Set a cell array on the data object to be written.

#define	vtkXMLWriterC_SetCellsWithTypes VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellsWithTypes)
	Set a cell array on the data object to be written.

#define	vtkXMLWriterC_SetPointData VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetPointData)
	Set a point or cell data array by name.

#define	vtkXMLWriterC_SetCellData VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellData)

#define	vtkXMLWriterC_SetFileName VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetFileName)
	Set the name of the file into which the data are to be written.

#define	vtkXMLWriterC_Write VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Write)
	Write the data to a file immediately.

#define	vtkXMLWriterC_SetNumberOfTimeSteps VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetNumberOfTimeSteps)
	Set the number of time steps that will be written between upcoming Start and Stop calls.

#define	vtkXMLWriterC_Start VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Start)
	Start writing a time-series to the output file.

#define	vtkXMLWriterC_WriteNextTimeStep VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_WriteNextTimeStep)
	Write one time step of a time-series to the output file.

#define	vtkXMLWriterC_Stop VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Stop)
	Stop writing a time-series to the output file.

Typedefs
typedef struct vtkXMLWriterC_s	vtkXMLWriterC
	vtkXMLWriterC is an opaque structure holding the state of an individual writer object.

Functions
VTKIOXML_EXPORT void	vtkXMLWriterC_Delete (vtkXMLWriterC *self)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetDataObjectType (vtkXMLWriterC *self, int objType)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetDataModeType (vtkXMLWriterC *self, int datamodetype)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetExtent (vtkXMLWriterC *self, int extent[6])

VTKIOXML_EXPORT void	vtkXMLWriterC_SetPoints (vtkXMLWriterC self, int dataType, void data, vtkIdType numPoints)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetOrigin (vtkXMLWriterC *self, double origin[3])

VTKIOXML_EXPORT void	vtkXMLWriterC_SetSpacing (vtkXMLWriterC *self, double spacing[3])

VTKIOXML_EXPORT void	vtkXMLWriterC_SetCoordinates (vtkXMLWriterC self, int axis, int dataType, void data, vtkIdType numCoordinates)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetCellsWithType (vtkXMLWriterC self, int cellType, vtkIdType ncells, vtkIdType cells, vtkIdType cellsSize)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetCellsWithTypes (vtkXMLWriterC self, int cellTypes, vtkIdType ncells, vtkIdType *cells, vtkIdType cellsSize)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetPointData (vtkXMLWriterC self, const char name, int dataType, void data, vtkIdType numTuples, int numComponents, const char role)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetCellData (vtkXMLWriterC self, const char name, int dataType, void data, vtkIdType numTuples, int numComponents, const char role)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetFileName (vtkXMLWriterC self, const char fileName)

VTKIOXML_EXPORT int	vtkXMLWriterC_Write (vtkXMLWriterC *self)

VTKIOXML_EXPORT void	vtkXMLWriterC_SetNumberOfTimeSteps (vtkXMLWriterC *self, int numTimeSteps)

VTKIOXML_EXPORT void	vtkXMLWriterC_Start (vtkXMLWriterC *self)

VTKIOXML_EXPORT void	vtkXMLWriterC_WriteNextTimeStep (vtkXMLWriterC *self, double timeValue)

VTKIOXML_EXPORT void	vtkXMLWriterC_Stop (vtkXMLWriterC *self)

Macro Definition Documentation

◆ vtkXMLWriterC_New

VTKIOXML_EXPORT vtkXMLWriterC * vtkXMLWriterC_New VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_New)

Create a new instance of vtkXMLWriterC.

Returns the object or nullptr on failure.

Definition at line 24 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_Delete

#define vtkXMLWriterC_Delete VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Delete)

Delete the writer object.

This should not be called between Start and Stop calls.

Definition at line 33 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetDataObjectType

#define vtkXMLWriterC_SetDataObjectType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetDataObjectType)

Set the VTK data object type that will be written.

This initializes an empty data object of the given type.

This must be set before setting geometry or data information can can be set only once per writer object.

Definition at line 44 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetDataModeType

#define vtkXMLWriterC_SetDataModeType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetDataModeType)

Set the VTK writer data mode to either:

Ascii
Binary
Appended (default)

This may be used only after SetDataObjectType has been called.

Definition at line 56 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetExtent

#define vtkXMLWriterC_SetExtent VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetExtent)

Set the extent of a structured data set.

This may be used only after SetDataObjectType has been called with a structured data object type.

Definition at line 66 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetPoints

#define vtkXMLWriterC_SetPoints VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetPoints)

Set the points of a point data set.

For structured data, the number of points must match number of points indicated by the extent.

Use dataType to specify the scalar type used in the given array. The data array must have numPoints*3 entries specifying 3-D points.

This may not be used for data objects with implicit points. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 82 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetOrigin

#define vtkXMLWriterC_SetOrigin VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetOrigin)

Set the origin of an image data set.

This may only be used for image data. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 92 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetSpacing

#define vtkXMLWriterC_SetSpacing VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetSpacing)

Set the spacing of an image data set.

This may only be used for image data. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 102 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetCoordinates

#define vtkXMLWriterC_SetCoordinates VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCoordinates)

Set the coordinates along one axis of a rectilinear grid data set.

Specify axis 0 for X, 1 for Y, and 2 for Z. Use dataType to specify the scalar type used in the given data array. Use numCoordinates to specify the number of such values in the array. The number of values must match that specified by the extent for the given axis.

This may only be used for rectilinear grids. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 118 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetCellsWithType

#define vtkXMLWriterC_SetCellsWithType VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellsWithType)

Set a cell array on the data object to be written.

All cells must have the same type.

For unstructured grid data objects, the cellType can be any type. For polygonal data objects, the cellType must be VTK_VERTEX, VTK_POLY_VERTEX, VTK_LINE, VTK_POLY_LINE, VTK_TRIANGLE, VTK_TRIANGLE_STRIP, or cyclically connected simple cell type such as VTK_POLYGON.

The cells array must have cellsSize entries. Each cell uses N+1 entries where N is the number of points in the cell. The layout of the array for each cell is "[N,id1,id2,...,idN]". The total number of cells must be ncells.

This may only be used for unstructured grid and polygonal data types. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 142 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetCellsWithTypes

#define vtkXMLWriterC_SetCellsWithTypes VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellsWithTypes)

Set a cell array on the data object to be written.

Each cell can have its own type.

The cellTypes array specifies the type of each cell, and has ncells entries. The cells array must have cellsSize entries. Each cell uses N+1 entries where N is the number of points in the cell. The layout of the array for each cell is "[N,id1,id2,...,idN]". The total number of cells must be ncells.

This may only be used for unstructured grid data objects. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 161 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetPointData

#define vtkXMLWriterC_SetPointData VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetPointData)

Set a point or cell data array by name.

The name of the array is required and should describe the purpose of the data. Use dataType to specify the scalar type used in the given data array. Use numTuples to specify the number of tuples and numComponents to specify the number of scalar components in each tuple.

The data array must have exactly numTuples*numComponents entries. For SetPointData, numTuples must be equal to the number of points indicated by SetExtent and/or SetPoints. For SetCellData, numTuples must be equal to the total number of cells set by SetCells.

The role can be one of "SCALARS", "VECTORS", "NORMALS", "TENSORS", or "TCOORDS" and specifies that the array should be designated as the active array for the named role. Other values for role are ignored.

This may be used for all data types. It may not be called before SetDataObjectType but may be called between Start and Stop calls.

Definition at line 189 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetCellData

#define vtkXMLWriterC_SetCellData VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetCellData)

Definition at line 194 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetFileName

#define vtkXMLWriterC_SetFileName VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetFileName)

Set the name of the file into which the data are to be written.

This may be used for all data types. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 205 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_Write

#define vtkXMLWriterC_Write VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Write)

Write the data to a file immediately.

This is not used when writing time-series data. Returns 1 for success and 0 for failure.

This may only be called after SetFileName and SetDataObjectType.

Definition at line 215 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_SetNumberOfTimeSteps

#define vtkXMLWriterC_SetNumberOfTimeSteps VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_SetNumberOfTimeSteps)

Set the number of time steps that will be written between upcoming Start and Stop calls.

This is used when writing time-series data.

This may be used for all data types. It may not be called before SetDataObjectType or between Start and Stop calls.

Definition at line 226 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_Start

#define vtkXMLWriterC_Start VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Start)

Start writing a time-series to the output file.

This may only be called after SetFileName, SetDataObjectType, and SetNumberOfTimeSteps. It may not be called a second time until after an intervening call to Stop.

Definition at line 238 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_WriteNextTimeStep

#define vtkXMLWriterC_WriteNextTimeStep VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_WriteNextTimeStep)

Write one time step of a time-series to the output file.

The current data set by SetPointData and SetCellData will be written.

Use timeValue to specify the time associated with the time step being written.

This may only be called after Start has been called. It should be called NumberOfTimeSteps times before calling Stop.

Definition at line 252 of file vtkXMLWriterC.h.

◆ vtkXMLWriterC_Stop

#define vtkXMLWriterC_Stop VTK_ABI_NAMESPACE_MANGLE(vtkXMLWriterC_Stop)

Stop writing a time-series to the output file.

This may only be called after Start and NumberOfTimeSteps calls to WriteNextTimeStep.

Definition at line 262 of file vtkXMLWriterC.h.

Typedef Documentation

◆ vtkXMLWriterC

typedef struct vtkXMLWriterC_s vtkXMLWriterC

vtkXMLWriterC is an opaque structure holding the state of an individual writer object.

It can be used to write VTK XML files.

Definition at line 18 of file vtkXMLWriterC.h.

Function Documentation

◆ vtkXMLWriterC_Delete()

VTKIOXML_EXPORT void vtkXMLWriterC_Delete ( vtkXMLWriterC * self )

◆ vtkXMLWriterC_SetDataObjectType()

VTKIOXML_EXPORT void vtkXMLWriterC_SetDataObjectType	(	vtkXMLWriterC *	self,
		int	objType
	)

◆ vtkXMLWriterC_SetDataModeType()

VTKIOXML_EXPORT void vtkXMLWriterC_SetDataModeType	(	vtkXMLWriterC *	self,
		int	datamodetype
	)

◆ vtkXMLWriterC_SetExtent()

VTKIOXML_EXPORT void vtkXMLWriterC_SetExtent	(	vtkXMLWriterC *	self,
		int	extent[6]
	)

◆ vtkXMLWriterC_SetPoints()

VTKIOXML_EXPORT void vtkXMLWriterC_SetPoints	(	vtkXMLWriterC *	self,
		int	dataType,
		void *	data,
		vtkIdType	numPoints
	)

◆ vtkXMLWriterC_SetOrigin()

VTKIOXML_EXPORT void vtkXMLWriterC_SetOrigin	(	vtkXMLWriterC *	self,
		double	origin[3]
	)

◆ vtkXMLWriterC_SetSpacing()

VTKIOXML_EXPORT void vtkXMLWriterC_SetSpacing	(	vtkXMLWriterC *	self,
		double	spacing[3]
	)

◆ vtkXMLWriterC_SetCoordinates()

VTKIOXML_EXPORT void vtkXMLWriterC_SetCoordinates	(	vtkXMLWriterC *	self,
		int	axis,
		int	dataType,
		void *	data,
		vtkIdType	numCoordinates
	)

◆ vtkXMLWriterC_SetCellsWithType()

VTKIOXML_EXPORT void vtkXMLWriterC_SetCellsWithType	(	vtkXMLWriterC *	self,
		int	cellType,
		vtkIdType	ncells,
		vtkIdType *	cells,
		vtkIdType	cellsSize
	)

◆ vtkXMLWriterC_SetCellsWithTypes()

VTKIOXML_EXPORT void vtkXMLWriterC_SetCellsWithTypes	(	vtkXMLWriterC *	self,
		int *	cellTypes,
		vtkIdType	ncells,
		vtkIdType *	cells,
		vtkIdType	cellsSize
	)

◆ vtkXMLWriterC_SetPointData()

VTKIOXML_EXPORT void vtkXMLWriterC_SetPointData	(	vtkXMLWriterC *	self,
		const char *	name,
		int	dataType,
		void *	data,
		vtkIdType	numTuples,
		int	numComponents,
		const char *	role
	)

◆ vtkXMLWriterC_SetCellData()

VTKIOXML_EXPORT void vtkXMLWriterC_SetCellData	(	vtkXMLWriterC *	self,
		const char *	name,
		int	dataType,
		void *	data,
		vtkIdType	numTuples,
		int	numComponents,
		const char *	role
	)

◆ vtkXMLWriterC_SetFileName()

VTKIOXML_EXPORT void vtkXMLWriterC_SetFileName	(	vtkXMLWriterC *	self,
		const char *	fileName
	)

◆ vtkXMLWriterC_Write()

VTKIOXML_EXPORT int vtkXMLWriterC_Write ( vtkXMLWriterC * self )

◆ vtkXMLWriterC_SetNumberOfTimeSteps()

VTKIOXML_EXPORT void vtkXMLWriterC_SetNumberOfTimeSteps	(	vtkXMLWriterC *	self,
		int	numTimeSteps
	)

◆ vtkXMLWriterC_Start()

VTKIOXML_EXPORT void vtkXMLWriterC_Start ( vtkXMLWriterC * self )

◆ vtkXMLWriterC_WriteNextTimeStep()

VTKIOXML_EXPORT void vtkXMLWriterC_WriteNextTimeStep	(	vtkXMLWriterC *	self,
		double	timeValue
	)

◆ vtkXMLWriterC_Stop()

VTKIOXML_EXPORT void vtkXMLWriterC_Stop ( vtkXMLWriterC * self )

Macros

Typedefs

Functions