helper class for objects that write VTK data files More...

#include <vtkDataWriter.h>

Inheritance diagram for vtkDataWriter:

Collaboration diagram for vtkDataWriter:

Public Types
enum	VTKFileVersion { VTK_LEGACY_READER_VERSION_4_2 = 42 , VTK_LEGACY_READER_VERSION_5_1 = 51 }

Public Types inherited from vtkWriter
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
vtkStdString	GetOutputStdString ()
	When WriteToOutputString is on, this method returns a copy of the output string in a vtkStdString. More...

char *	RegisterAndGetOutputString ()
	This convenience method returns the string, sets the IVAR to nullptr, so that the user is responsible for deleting the string. More...

virtual ostream *	OpenVTKFile ()
	Open a vtk data file. More...

int	WriteHeader (ostream *fp)
	Write the header of a vtk data file. More...

int	WritePoints (ostream fp, vtkPoints p)
	Write out the points of the data set. More...

int	WriteCoordinates (ostream fp, vtkDataArray coords, int axes)
	Write out coordinates for rectilinear grids. More...

int	WriteCells (ostream fp, vtkCellArray cells, const char *label)
	Write out the cells of the data set. More...

int	WriteCellsLegacy (ostream fp, vtkCellArray cells, const char *label)
	Write out the cells of the data set. More...

int	WriteCellData (ostream fp, vtkDataSet ds)
	Write the cell data (e.g., scalars, vectors, ...) of a vtk dataset. More...

int	WritePointData (ostream fp, vtkDataSet ds)
	Write the point data (e.g., scalars, vectors, ...) of a vtk dataset. More...

int	WriteEdgeData (ostream fp, vtkGraph g)
	Write the edge data (e.g., scalars, vectors, ...) of a vtk graph. More...

int	WriteVertexData (ostream fp, vtkGraph g)
	Write the vertex data (e.g., scalars, vectors, ...) of a vtk graph. More...

int	WriteRowData (ostream fp, vtkTable g)
	Write the row data (e.g., scalars, vectors, ...) of a vtk table. More...

int	WriteFieldData (ostream fp, vtkFieldData f)
	Write out the field data. More...

int	WriteDataSetData (ostream fp, vtkDataSet ds)
	Write out the data associated with the dataset (i.e. More...

void	CloseVTKFile (ostream *fp)
	Close a vtk file. More...


	vtkSetFilePathMacro (FileName)
	Specify the file name of VTK data file to write. More...

	vtkGetFilePathMacro (FileName)
	Specify the file name of VTK data file to write. More...


void	SetFileVersion (int)
	Specify the VTK file version to write. More...

virtual int	GetFileVersion ()
	Specify the VTK file version to write. More...

virtual int	GetFileMajorVersion ()
	Specify the VTK file version to write. More...

virtual int	GetFileMinorVersion ()
	Specify the VTK file version to write. More...


virtual void	SetWriteToOutputString (vtkTypeBool)
	Enable writing to an OutputString instead of the default, a file. More...

virtual vtkTypeBool	GetWriteToOutputString ()
	Enable writing to an OutputString instead of the default, a file. More...

virtual void	WriteToOutputStringOn ()
	Enable writing to an OutputString instead of the default, a file. More...

virtual void	WriteToOutputStringOff ()
	Enable writing to an OutputString instead of the default, a file. More...


virtual vtkIdType	GetOutputStringLength ()
	When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...

virtual char *	GetOutputString ()
	When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...

unsigned char *	GetBinaryOutputString ()
	When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...


virtual void	SetHeader (const char *)
	Specify the header for the VTK data file. More...

virtual char *	GetHeader ()
	Specify the header for the VTK data file. More...


virtual void	SetWriteArrayMetaData (bool)
	If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...

virtual bool	GetWriteArrayMetaData ()
	If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...

virtual void	WriteArrayMetaDataOn ()
	If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...

virtual void	WriteArrayMetaDataOff ()
	If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...


virtual void	SetFileType (int)
	Specify the file type (ASCII or BINARY) of the VTK data file. More...

virtual int	GetFileType ()
	Specify the file type (ASCII or BINARY) of the VTK data file. More...

void	SetFileTypeToASCII ()
	Specify the file type (ASCII or BINARY) of the VTK data file. More...

void	SetFileTypeToBinary ()
	Specify the file type (ASCII or BINARY) of the VTK data file. More...


virtual void	SetScalarsName (const char *)
	Give a name to the scalar data. More...

virtual char *	GetScalarsName ()
	Give a name to the scalar data. More...


virtual void	SetVectorsName (const char *)
	Give a name to the vector data. More...

virtual char *	GetVectorsName ()
	Give a name to the vector data. More...


virtual void	SetTensorsName (const char *)
	Give a name to the tensors data. More...

virtual char *	GetTensorsName ()
	Give a name to the tensors data. More...


virtual void	SetNormalsName (const char *)
	Give a name to the normals data. More...

virtual char *	GetNormalsName ()
	Give a name to the normals data. More...


virtual void	SetTCoordsName (const char *)
	Give a name to the texture coordinates data. More...

virtual char *	GetTCoordsName ()
	Give a name to the texture coordinates data. More...


virtual void	SetGlobalIdsName (const char *)
	Give a name to the global ids data. More...

virtual char *	GetGlobalIdsName ()
	Give a name to the global ids data. More...


virtual void	SetPedigreeIdsName (const char *)
	Give a name to the pedigree ids data. More...

virtual char *	GetPedigreeIdsName ()
	Give a name to the pedigree ids data. More...


virtual void	SetEdgeFlagsName (const char *)
	Give a name to the edge flags data. More...

virtual char *	GetEdgeFlagsName ()
	Give a name to the edge flags data. More...


virtual void	SetLookupTableName (const char *)
	Give a name to the lookup table. More...

virtual char *	GetLookupTableName ()
	Give a name to the lookup table. More...


virtual void	SetFieldDataName (const char *)
	Give a name to the field data. More...

virtual char *	GetFieldDataName ()
	Give a name to the field data. More...

Public Member Functions inherited from vtkWriter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual int	Write ()
	Write data to output. More...

void	EncodeString (char resname, const char name, bool doublePercent)
	Encode the string so that the reader will not have problems. More...

void	EncodeWriteString (ostream out, const char name, bool doublePercent)
	Encode the string so that the reader will not have problems. More...

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

void	SetInputData (vtkDataObject *input)
	Set/get the input to this writer. More...

void	SetInputData (int index, vtkDataObject *input)
	Set/get the input to this writer. More...

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

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

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

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

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	SetProgress (double)
	`SetProgress` is deprecated. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

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

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

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). More...

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

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

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

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

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual double	GetProgress ()
	Get the execution progress of a process object. More...

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

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

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

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

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

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

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkDataWriter *	New ()
	Create object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates. More...

Static Public Member Functions inherited from vtkWriter
static vtkTypeBool	IsTypeOf (const char *type)

static vtkWriter *	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. More...

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

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

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

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
	vtkDataWriter ()

	~vtkDataWriter () override

void	WriteData () override

int	WriteArray (ostream fp, int dataType, vtkAbstractArray data, const char *format, vtkIdType num, vtkIdType numComp)

int	WriteScalarData (ostream fp, vtkDataArray s, vtkIdType num)

int	WriteVectorData (ostream fp, vtkDataArray v, vtkIdType num)

int	WriteNormalData (ostream fp, vtkDataArray n, vtkIdType num)

int	WriteTCoordData (ostream fp, vtkDataArray tc, vtkIdType num)

int	WriteTensorData (ostream fp, vtkDataArray t, vtkIdType num)

int	WriteGlobalIdData (ostream fp, vtkDataArray g, vtkIdType num)

int	WritePedigreeIdData (ostream fp, vtkAbstractArray p, vtkIdType num)

int	WriteEdgeFlagsData (ostream fp, vtkDataArray edgeFlags, vtkIdType num)

bool	CanWriteInformationKey (vtkInformation info, vtkInformationKey key)

int	WriteInformation (ostream fp, vtkInformation info)
	Format is detailed here. More...

Protected Member Functions inherited from vtkWriter
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWriter ()

	~vtkWriter () override

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	WriteData ()=0

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm. More...

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm. More...

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

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

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

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

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

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

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

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

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

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

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	WriteToOutputString

char *	OutputString

vtkIdType	OutputStringLength

char *	FileName

int	FileVersion

int	FileMajorVersion

int	FileMinorVersion

char *	Header

int	FileType

bool	WriteArrayMetaData

char *	ScalarsName

char *	VectorsName

char *	TensorsName

char *	TCoordsName

char *	NormalsName

char *	LookupTableName

char *	FieldDataName

char *	GlobalIdsName

char *	PedigreeIdsName

char *	EdgeFlagsName

std::locale	CurrentLocale

Protected Attributes inherited from vtkWriter
vtkTimeStamp	WriteTime

Protected Attributes inherited from vtkAlgorithm
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. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkWriter	Superclass
	Standard methods for type information and printing. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing. More...

static vtkDataWriter *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing. More...

vtkDataWriter *	NewInstance () const
	Standard methods for type information and printing. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing. More...

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

helper class for objects that write VTK data files

vtkDataWriter is a helper class that opens and writes the VTK header and point data (e.g., scalars, vectors, normals, etc.) from a vtk data file. See the VTK textbook and online resources for various formats.

See also: vtkDataSetWriter vtkPolyDataWriter vtkStructuredGridWriter vtkStructuredPointsWriter vtkUnstructuredGridWriter vtkFieldDataWriter vtkRectilinearGridWriter

Definition at line 47 of file vtkDataWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWriter vtkDataWriter::Superclass

Standard methods for type information and printing.

Definition at line 54 of file vtkDataWriter.h.

Member Enumeration Documentation

◆ VTKFileVersion

enum vtkDataWriter::VTKFileVersion

Enumerator
VTK_LEGACY_READER_VERSION_4_2
VTK_LEGACY_READER_VERSION_5_1

Definition at line 77 of file vtkDataWriter.h.

Constructor & Destructor Documentation

◆ vtkDataWriter()

vtkDataWriter::vtkDataWriter ( )

protected

◆ ~vtkDataWriter()

vtkDataWriter::~vtkDataWriter ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

virtual vtkTypeBool vtkDataWriter::IsA ( const char * type )

virtual

Standard methods for type information and printing.

Reimplemented from vtkWriter.

Reimplemented in vtkCGMWriter, vtkDIMACSGraphWriter, vtkNewickTreeWriter, vtkCompositeDataWriter, vtkDataSetWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSimplePointsWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, and vtkPDataSetWriter.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDataWriter::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkWriter.

Reimplemented in vtkCGMWriter, vtkDIMACSGraphWriter, vtkNewickTreeWriter, vtkCompositeDataWriter, vtkDataSetWriter, vtkGenericDataObjectWriter, vtkGraphWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSimplePointsWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, and vtkPDataSetWriter.

◆ NewInstance()

vtkDataWriter * vtkDataWriter::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkWriter.

Reimplemented in vtkGenericDataObjectWriter, vtkGraphWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSimplePointsWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, vtkUnstructuredGridWriter, and vtkPDataSetWriter.

◆ New()

static vtkDataWriter * vtkDataWriter::New ( )

static

Create object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates.

◆ vtkSetFilePathMacro()

vtkDataWriter::vtkSetFilePathMacro ( FileName )

Specify the file name of VTK data file to write.

◆ vtkGetFilePathMacro()

vtkDataWriter::vtkGetFilePathMacro ( FileName )

Specify the file name of VTK data file to write.

◆ SetFileVersion()

void vtkDataWriter::SetFileVersion ( int )

Specify the VTK file version to write.

See the enum documentaion above (VTKFileVersion) for additional information about supported versions. It is possible to get the file major and minor versions separately. See also vtkDataReader for related methods. (Note, the parsing of the FileVersion into major and minor version is as follows: the least significant digit is the minor version; the remaining digits are the major version.

◆ GetFileVersion()

virtual int vtkDataWriter::GetFileVersion ( )

virtual

Specify the VTK file version to write.

See the enum documentaion above (VTKFileVersion) for additional information about supported versions. It is possible to get the file major and minor versions separately. See also vtkDataReader for related methods. (Note, the parsing of the FileVersion into major and minor version is as follows: the least significant digit is the minor version; the remaining digits are the major version.

◆ GetFileMajorVersion()

virtual int vtkDataWriter::GetFileMajorVersion ( )

virtual

Specify the VTK file version to write.

See the enum documentaion above (VTKFileVersion) for additional information about supported versions. It is possible to get the file major and minor versions separately. See also vtkDataReader for related methods. (Note, the parsing of the FileVersion into major and minor version is as follows: the least significant digit is the minor version; the remaining digits are the major version.

◆ GetFileMinorVersion()

virtual int vtkDataWriter::GetFileMinorVersion ( )

virtual

Specify the VTK file version to write.

See the enum documentaion above (VTKFileVersion) for additional information about supported versions. It is possible to get the file major and minor versions separately. See also vtkDataReader for related methods. (Note, the parsing of the FileVersion into major and minor version is as follows: the least significant digit is the minor version; the remaining digits are the major version.

◆ SetWriteToOutputString()

virtual void vtkDataWriter::SetWriteToOutputString ( vtkTypeBool )

virtual

Enable writing to an OutputString instead of the default, a file.

◆ GetWriteToOutputString()

virtual vtkTypeBool vtkDataWriter::GetWriteToOutputString ( )

virtual

Enable writing to an OutputString instead of the default, a file.

◆ WriteToOutputStringOn()

virtual void vtkDataWriter::WriteToOutputStringOn ( )

virtual

Enable writing to an OutputString instead of the default, a file.

◆ WriteToOutputStringOff()

virtual void vtkDataWriter::WriteToOutputStringOff ( )

virtual

Enable writing to an OutputString instead of the default, a file.

◆ GetOutputStringLength()

virtual vtkIdType vtkDataWriter::GetOutputStringLength ( )

virtual

When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.

The string is deleted during the next call to write ...

◆ GetOutputString()

virtual char * vtkDataWriter::GetOutputString ( )

virtual

When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.

The string is deleted during the next call to write ...

◆ GetBinaryOutputString()

unsigned char * vtkDataWriter::GetBinaryOutputString ( )

inline

When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods.

The string is deleted during the next call to write ...

Definition at line 116 of file vtkDataWriter.h.

◆ GetOutputStdString()

vtkStdString vtkDataWriter::GetOutputStdString ( )

When WriteToOutputString is on, this method returns a copy of the output string in a vtkStdString.

◆ RegisterAndGetOutputString()

char * vtkDataWriter::RegisterAndGetOutputString ( )

This convenience method returns the string, sets the IVAR to nullptr, so that the user is responsible for deleting the string.

I am not sure what the name should be, so it may change in the future.

◆ SetHeader()

virtual void vtkDataWriter::SetHeader ( const char * )

virtual

Specify the header for the VTK data file.

◆ GetHeader()

virtual char * vtkDataWriter::GetHeader ( )

virtual

Specify the header for the VTK data file.

◆ SetWriteArrayMetaData()

virtual void vtkDataWriter::SetWriteArrayMetaData ( bool )

virtual

If true, vtkInformation objects attached to arrays and array component nameswill be written to the output.

The default is true.

◆ GetWriteArrayMetaData()

virtual bool vtkDataWriter::GetWriteArrayMetaData ( )

virtual

If true, vtkInformation objects attached to arrays and array component nameswill be written to the output.

The default is true.

◆ WriteArrayMetaDataOn()

virtual void vtkDataWriter::WriteArrayMetaDataOn ( )

virtual

If true, vtkInformation objects attached to arrays and array component nameswill be written to the output.

The default is true.

◆ WriteArrayMetaDataOff()

virtual void vtkDataWriter::WriteArrayMetaDataOff ( )

virtual

If true, vtkInformation objects attached to arrays and array component nameswill be written to the output.

The default is true.

◆ SetFileType()

virtual void vtkDataWriter::SetFileType ( int )

virtual

Specify the file type (ASCII or BINARY) of the VTK data file.

◆ GetFileType()

virtual int vtkDataWriter::GetFileType ( )

virtual

Specify the file type (ASCII or BINARY) of the VTK data file.

◆ SetFileTypeToASCII()

void vtkDataWriter::SetFileTypeToASCII ( )

inline

Specify the file type (ASCII or BINARY) of the VTK data file.

Definition at line 159 of file vtkDataWriter.h.

◆ SetFileTypeToBinary()

void vtkDataWriter::SetFileTypeToBinary ( )

inline

Specify the file type (ASCII or BINARY) of the VTK data file.

Definition at line 160 of file vtkDataWriter.h.

◆ SetScalarsName()

virtual void vtkDataWriter::SetScalarsName ( const char * )

virtual

Give a name to the scalar data.

If not specified, uses default name "scalars".

◆ GetScalarsName()

virtual char * vtkDataWriter::GetScalarsName ( )

virtual

Give a name to the scalar data.

If not specified, uses default name "scalars".

◆ SetVectorsName()

virtual void vtkDataWriter::SetVectorsName ( const char * )

virtual

Give a name to the vector data.

If not specified, uses default name "vectors".

◆ GetVectorsName()

virtual char * vtkDataWriter::GetVectorsName ( )

virtual

Give a name to the vector data.

If not specified, uses default name "vectors".

◆ SetTensorsName()

virtual void vtkDataWriter::SetTensorsName ( const char * )

virtual

Give a name to the tensors data.

If not specified, uses default name "tensors".

◆ GetTensorsName()

virtual char * vtkDataWriter::GetTensorsName ( )

virtual

Give a name to the tensors data.

If not specified, uses default name "tensors".

◆ SetNormalsName()

virtual void vtkDataWriter::SetNormalsName ( const char * )

virtual

Give a name to the normals data.

If not specified, uses default name "normals".

◆ GetNormalsName()

virtual char * vtkDataWriter::GetNormalsName ( )

virtual

Give a name to the normals data.

If not specified, uses default name "normals".

◆ SetTCoordsName()

virtual void vtkDataWriter::SetTCoordsName ( const char * )

virtual

Give a name to the texture coordinates data.

If not specified, uses default name "textureCoords".

◆ GetTCoordsName()

virtual char * vtkDataWriter::GetTCoordsName ( )

virtual

Give a name to the texture coordinates data.

If not specified, uses default name "textureCoords".

◆ SetGlobalIdsName()

virtual void vtkDataWriter::SetGlobalIdsName ( const char * )

virtual

Give a name to the global ids data.

If not specified, uses default name "global_ids".

◆ GetGlobalIdsName()

virtual char * vtkDataWriter::GetGlobalIdsName ( )

virtual

Give a name to the global ids data.

If not specified, uses default name "global_ids".

◆ SetPedigreeIdsName()

virtual void vtkDataWriter::SetPedigreeIdsName ( const char * )

virtual

Give a name to the pedigree ids data.

If not specified, uses default name "pedigree_ids".

◆ GetPedigreeIdsName()

virtual char * vtkDataWriter::GetPedigreeIdsName ( )

virtual

Give a name to the pedigree ids data.

If not specified, uses default name "pedigree_ids".

◆ SetEdgeFlagsName()

virtual void vtkDataWriter::SetEdgeFlagsName ( const char * )

virtual

Give a name to the edge flags data.

If not specified, uses default name "edge_flags".

◆ GetEdgeFlagsName()

virtual char * vtkDataWriter::GetEdgeFlagsName ( )

virtual

Give a name to the edge flags data.

If not specified, uses default name "edge_flags".

◆ SetLookupTableName()

virtual void vtkDataWriter::SetLookupTableName ( const char * )

virtual

Give a name to the lookup table.

If not specified, uses default name "lookupTable".

◆ GetLookupTableName()

virtual char * vtkDataWriter::GetLookupTableName ( )

virtual

Give a name to the lookup table.

If not specified, uses default name "lookupTable".

◆ SetFieldDataName()

virtual void vtkDataWriter::SetFieldDataName ( const char * )

virtual

Give a name to the field data.

If not specified, uses default name "field".

◆ GetFieldDataName()

virtual char * vtkDataWriter::GetFieldDataName ( )

virtual

Give a name to the field data.

If not specified, uses default name "field".

◆ OpenVTKFile()

virtual ostream * vtkDataWriter::OpenVTKFile ( )

virtual

Open a vtk data file.

Returns nullptr if error.

◆ WriteHeader()

int vtkDataWriter::WriteHeader ( ostream * fp )

Write the header of a vtk data file.

Returns 0 if error.

◆ WritePoints()

int vtkDataWriter::WritePoints	(	ostream *	fp,
		vtkPoints *	p
	)

Write out the points of the data set.

◆ WriteCoordinates()

int vtkDataWriter::WriteCoordinates	(	ostream *	fp,
		vtkDataArray *	coords,
		int	axes
	)

Write out coordinates for rectilinear grids.

◆ WriteCells()

int vtkDataWriter::WriteCells	(	ostream *	fp,
		vtkCellArray *	cells,
		const char *	label
	)

Write out the cells of the data set.

◆ WriteCellsLegacy()

int vtkDataWriter::WriteCellsLegacy	(	ostream *	fp,
		vtkCellArray *	cells,
		const char *	label
	)

Write out the cells of the data set.

Note: Legacy implementation for file version < 5.0.

◆ WriteCellData()

int vtkDataWriter::WriteCellData	(	ostream *	fp,
		vtkDataSet *	ds
	)

Write the cell data (e.g., scalars, vectors, ...) of a vtk dataset.

Returns 0 if error.

◆ WritePointData()

int vtkDataWriter::WritePointData	(	ostream *	fp,
		vtkDataSet *	ds
	)

Write the point data (e.g., scalars, vectors, ...) of a vtk dataset.

Returns 0 if error.

◆ WriteEdgeData()

int vtkDataWriter::WriteEdgeData	(	ostream *	fp,
		vtkGraph *	g
	)

Write the edge data (e.g., scalars, vectors, ...) of a vtk graph.

Returns 0 if error.

◆ WriteVertexData()

int vtkDataWriter::WriteVertexData	(	ostream *	fp,
		vtkGraph *	g
	)

Write the vertex data (e.g., scalars, vectors, ...) of a vtk graph.

Returns 0 if error.

◆ WriteRowData()

int vtkDataWriter::WriteRowData	(	ostream *	fp,
		vtkTable *	g
	)

Write the row data (e.g., scalars, vectors, ...) of a vtk table.

Returns 0 if error.

◆ WriteFieldData()

int vtkDataWriter::WriteFieldData	(	ostream *	fp,
		vtkFieldData *	f
	)

Write out the field data.

◆ WriteDataSetData()

int vtkDataWriter::WriteDataSetData	(	ostream *	fp,
		vtkDataSet *	ds
	)

Write out the data associated with the dataset (i.e.

field data owned by the dataset itself - distinct from that owned by the cells or points).

◆ CloseVTKFile()

void vtkDataWriter::CloseVTKFile ( ostream * fp )

Close a vtk file.

◆ WriteData()

void vtkDataWriter::WriteData ( )

overrideprotectedvirtual

Implements vtkWriter.

Reimplemented in vtkGenericDataObjectWriter, vtkGraphWriter, vtkPolyDataWriter, vtkRectilinearGridWriter, vtkSimplePointsWriter, vtkStructuredGridWriter, vtkStructuredPointsWriter, vtkTableWriter, vtkTreeWriter, and vtkUnstructuredGridWriter.

◆ WriteArray()

int vtkDataWriter::WriteArray	(	ostream *	fp,
		int	dataType,
		vtkAbstractArray *	data,
		const char *	format,
		vtkIdType	num,
		vtkIdType	numComp
	)

protected

◆ WriteScalarData()

int vtkDataWriter::WriteScalarData	(	ostream *	fp,
		vtkDataArray *	s,
		vtkIdType	num
	)

protected

◆ WriteVectorData()

int vtkDataWriter::WriteVectorData	(	ostream *	fp,
		vtkDataArray *	v,
		vtkIdType	num
	)

protected

◆ WriteNormalData()

int vtkDataWriter::WriteNormalData	(	ostream *	fp,
		vtkDataArray *	n,
		vtkIdType	num
	)

protected

◆ WriteTCoordData()

int vtkDataWriter::WriteTCoordData	(	ostream *	fp,
		vtkDataArray *	tc,
		vtkIdType	num
	)

protected

◆ WriteTensorData()

int vtkDataWriter::WriteTensorData	(	ostream *	fp,
		vtkDataArray *	t,
		vtkIdType	num
	)

protected

◆ WriteGlobalIdData()

int vtkDataWriter::WriteGlobalIdData	(	ostream *	fp,
		vtkDataArray *	g,
		vtkIdType	num
	)

protected

◆ WritePedigreeIdData()

int vtkDataWriter::WritePedigreeIdData	(	ostream *	fp,
		vtkAbstractArray *	p,
		vtkIdType	num
	)

protected

◆ WriteEdgeFlagsData()

int vtkDataWriter::WriteEdgeFlagsData	(	ostream *	fp,
		vtkDataArray *	edgeFlags,
		vtkIdType	num
	)

protected

◆ CanWriteInformationKey()

bool vtkDataWriter::CanWriteInformationKey	(	vtkInformation *	info,
		vtkInformationKey *	key
	)

protected

◆ WriteInformation()

int vtkDataWriter::WriteInformation	(	ostream *	fp,
		vtkInformation *	info
	)

protected

Format is detailed here.

Member Data Documentation

◆ WriteToOutputString

vtkTypeBool vtkDataWriter::WriteToOutputString

protected

Definition at line 334 of file vtkDataWriter.h.

◆ OutputString

char* vtkDataWriter::OutputString

protected

Definition at line 335 of file vtkDataWriter.h.

◆ OutputStringLength

vtkIdType vtkDataWriter::OutputStringLength

protected

Definition at line 336 of file vtkDataWriter.h.

◆ FileName

char* vtkDataWriter::FileName

protected

Definition at line 340 of file vtkDataWriter.h.

◆ FileVersion

int vtkDataWriter::FileVersion

protected

Definition at line 341 of file vtkDataWriter.h.

◆ FileMajorVersion

int vtkDataWriter::FileMajorVersion

protected

Definition at line 342 of file vtkDataWriter.h.

◆ FileMinorVersion

int vtkDataWriter::FileMinorVersion

protected

Definition at line 343 of file vtkDataWriter.h.

◆ Header

char* vtkDataWriter::Header

protected

Definition at line 344 of file vtkDataWriter.h.

◆ FileType

int vtkDataWriter::FileType

protected

Definition at line 345 of file vtkDataWriter.h.

◆ WriteArrayMetaData

bool vtkDataWriter::WriteArrayMetaData

protected

Definition at line 347 of file vtkDataWriter.h.

◆ ScalarsName

char* vtkDataWriter::ScalarsName

protected

Definition at line 349 of file vtkDataWriter.h.

◆ VectorsName

char* vtkDataWriter::VectorsName

protected

Definition at line 350 of file vtkDataWriter.h.

◆ TensorsName

char* vtkDataWriter::TensorsName

protected

Definition at line 351 of file vtkDataWriter.h.

◆ TCoordsName

char* vtkDataWriter::TCoordsName

protected

Definition at line 352 of file vtkDataWriter.h.

◆ NormalsName

char* vtkDataWriter::NormalsName

protected

Definition at line 353 of file vtkDataWriter.h.

◆ LookupTableName

char* vtkDataWriter::LookupTableName

protected

Definition at line 354 of file vtkDataWriter.h.

◆ FieldDataName

char* vtkDataWriter::FieldDataName

protected

Definition at line 355 of file vtkDataWriter.h.

◆ GlobalIdsName

char* vtkDataWriter::GlobalIdsName

protected

Definition at line 356 of file vtkDataWriter.h.

◆ PedigreeIdsName

char* vtkDataWriter::PedigreeIdsName

protected

Definition at line 357 of file vtkDataWriter.h.

◆ EdgeFlagsName

char* vtkDataWriter::EdgeFlagsName

protected

Definition at line 358 of file vtkDataWriter.h.

◆ CurrentLocale

std::locale vtkDataWriter::CurrentLocale

protected

Definition at line 360 of file vtkDataWriter.h.

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

IO/Legacy/vtkDataWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ VTKFileVersion

Constructor & Destructor Documentation

◆ vtkDataWriter()

◆ ~vtkDataWriter()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ vtkSetFilePathMacro()

◆ vtkGetFilePathMacro()

◆ SetFileVersion()

◆ GetFileVersion()

◆ GetFileMajorVersion()

◆ GetFileMinorVersion()

◆ SetWriteToOutputString()

◆ GetWriteToOutputString()

◆ WriteToOutputStringOn()

◆ WriteToOutputStringOff()

◆ GetOutputStringLength()

◆ GetOutputString()

◆ GetBinaryOutputString()

◆ GetOutputStdString()

◆ RegisterAndGetOutputString()

◆ SetHeader()

◆ GetHeader()

◆ SetWriteArrayMetaData()

◆ GetWriteArrayMetaData()

◆ WriteArrayMetaDataOn()

◆ WriteArrayMetaDataOff()

◆ SetFileType()

◆ GetFileType()

◆ SetFileTypeToASCII()

◆ SetFileTypeToBinary()

◆ SetScalarsName()

◆ GetScalarsName()

◆ SetVectorsName()

◆ GetVectorsName()

◆ SetTensorsName()

◆ GetTensorsName()

◆ SetNormalsName()

◆ GetNormalsName()

◆ SetTCoordsName()

◆ GetTCoordsName()

◆ SetGlobalIdsName()

◆ GetGlobalIdsName()

◆ SetPedigreeIdsName()

◆ GetPedigreeIdsName()

◆ SetEdgeFlagsName()

◆ GetEdgeFlagsName()

◆ SetLookupTableName()

◆ GetLookupTableName()

◆ SetFieldDataName()

◆ GetFieldDataName()

◆ OpenVTKFile()

◆ WriteHeader()

◆ WritePoints()

◆ WriteCoordinates()

◆ WriteCells()

◆ WriteCellsLegacy()

◆ WriteCellData()

◆ WritePointData()

◆ WriteEdgeData()

◆ WriteVertexData()

◆ WriteRowData()

◆ WriteFieldData()

◆ WriteDataSetData()