VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDataWriter Class Reference

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

#include <vtkDataWriter.h>

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

Public Types

typedef vtkWriter Superclass
 
- 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

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
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 NULL, 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 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...
 
virtual void SetFileName (const char *)
 Specify file name of vtk polygon data file to write. More...
 
virtual char * GetFileName ()
 Specify file name of vtk polygon data file to write. More...
 
virtual void SetWriteToOutputString (int)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual int 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 int 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 file type (ASCII or BINARY) for vtk data file. More...
 
virtual int GetFileType ()
 Specify file type (ASCII or BINARY) for vtk data file. More...
 
void SetFileTypeToASCII ()
 Specify file type (ASCII or BINARY) for vtk data file. More...
 
void SetFileTypeToBinary ()
 Specify file type (ASCII or BINARY) for 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
vtkWriterNewInstance () const
 
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...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (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
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int 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...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (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 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...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
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...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int 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 int 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]=0)
 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]=0)
 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...
 
int SetUpdateExtentToWholeExtent (int port)
 If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...
 
int SetUpdateExtentToWholeExtent ()
 Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 Set the output update extent in terms of piece and ghost levels. More...
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...
 
void SetUpdateExtent (int port, int extent[6])
 Set the output update extent for data objects that use 3D extents. More...
 
void SetUpdateExtent (int extent[6])
 Convenience function equivalent to SetUpdateExtent(0, extent) More...
 
virtual vtkInformationGetInformation ()
 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 (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int 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 void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 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 RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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 int IsTypeOf (const char *type)
 
static vtkDataWriterSafeDownCast (vtkObjectBase *o)
 
static vtkDataWriterNew ()
 Created 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 int IsTypeOf (const char *type)
 
static vtkWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataWriter ()
 
 ~vtkDataWriter ()
 
void WriteData ()
 
int WriteArray (ostream *fp, int dataType, vtkAbstractArray *data, const char *format, int num, int numComp)
 
int WriteScalarData (ostream *fp, vtkDataArray *s, int num)
 
int WriteVectorData (ostream *fp, vtkDataArray *v, int num)
 
int WriteNormalData (ostream *fp, vtkDataArray *n, int num)
 
int WriteTCoordData (ostream *fp, vtkDataArray *tc, int num)
 
int WriteTensorData (ostream *fp, vtkDataArray *t, int num)
 
int WriteGlobalIdData (ostream *fp, vtkDataArray *g, int num)
 
int WritePedigreeIdData (ostream *fp, vtkAbstractArray *p, int num)
 
int WriteEdgeFlagsData (ostream *fp, vtkDataArray *edgeFlags, int num)
 
bool CanWriteInformationKey (vtkInformation *info, vtkInformationKey *key)
 
int WriteInformation (ostream *fp, vtkInformation *info)
 Format is detailed here. More...
 
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 
 ~vtkWriter ()
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 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)
 
- Protected Member Functions inherited from vtkAlgorithm
 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...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 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...
 
vtkDataArrayGetInputArrayToProcess (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...
 
vtkDataArrayGetInputArrayToProcess (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...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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=NULL)
 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 CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int WriteToOutputString
 
char * OutputString
 
int OutputStringLength
 
char * FileName
 
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
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 text for various formats.

See also
vtkDataSetWriter vtkPolyDataWriter vtkStructuredGridWriter vtkStructuredPointsWriter vtkUnstructuredGridWriter vtkFieldDataWriter vtkRectilinearGridWriter

Definition at line 45 of file vtkDataWriter.h.

Member Typedef Documentation

Definition at line 48 of file vtkDataWriter.h.

Constructor & Destructor Documentation

vtkDataWriter::vtkDataWriter ( )
protected
vtkDataWriter::~vtkDataWriter ( )
protected

Member Function Documentation

static int vtkDataWriter::IsTypeOf ( const char *  type)
static
virtual int vtkDataWriter::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 vtkWriter.

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

static vtkDataWriter* vtkDataWriter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataWriter::NewInstanceInternal ( ) const
protectedvirtual
vtkDataWriter* vtkDataWriter::NewInstance ( ) const
void vtkDataWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkWriter.

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

static vtkDataWriter* vtkDataWriter::New ( )
static

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

virtual void vtkDataWriter::SetFileName ( const char *  )
virtual

Specify file name of vtk polygon data file to write.

virtual char* vtkDataWriter::GetFileName ( )
virtual

Specify file name of vtk polygon data file to write.

virtual void vtkDataWriter::SetWriteToOutputString ( int  )
virtual

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

virtual int vtkDataWriter::GetWriteToOutputString ( )
virtual

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

virtual void vtkDataWriter::WriteToOutputStringOn ( )
virtual

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

virtual void vtkDataWriter::WriteToOutputStringOff ( )
virtual

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

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

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

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 82 of file vtkDataWriter.h.

vtkStdString vtkDataWriter::GetOutputStdString ( )

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

char* vtkDataWriter::RegisterAndGetOutputString ( )

This convenience method returns the string, sets the IVAR to NULL, 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.

virtual void vtkDataWriter::SetHeader ( const char *  )
virtual

Specify the header for the vtk data file.

virtual char* vtkDataWriter::GetHeader ( )
virtual

Specify the header for the vtk data file.

virtual void vtkDataWriter::SetWriteArrayMetaData ( bool  )
virtual

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

Default is true.

virtual bool vtkDataWriter::GetWriteArrayMetaData ( )
virtual

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

Default is true.

virtual void vtkDataWriter::WriteArrayMetaDataOn ( )
virtual

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

Default is true.

virtual void vtkDataWriter::WriteArrayMetaDataOff ( )
virtual

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

Default is true.

virtual void vtkDataWriter::SetFileType ( int  )
virtual

Specify file type (ASCII or BINARY) for vtk data file.

virtual int vtkDataWriter::GetFileType ( )
virtual

Specify file type (ASCII or BINARY) for vtk data file.

void vtkDataWriter::SetFileTypeToASCII ( )
inline

Specify file type (ASCII or BINARY) for vtk data file.

Definition at line 125 of file vtkDataWriter.h.

void vtkDataWriter::SetFileTypeToBinary ( )
inline

Specify file type (ASCII or BINARY) for vtk data file.

Definition at line 126 of file vtkDataWriter.h.

virtual void vtkDataWriter::SetScalarsName ( const char *  )
virtual

Give a name to the scalar data.

If not specified, uses default name "scalars".

virtual char* vtkDataWriter::GetScalarsName ( )
virtual

Give a name to the scalar data.

If not specified, uses default name "scalars".

virtual void vtkDataWriter::SetVectorsName ( const char *  )
virtual

Give a name to the vector data.

If not specified, uses default name "vectors".

virtual char* vtkDataWriter::GetVectorsName ( )
virtual

Give a name to the vector data.

If not specified, uses default name "vectors".

virtual void vtkDataWriter::SetTensorsName ( const char *  )
virtual

Give a name to the tensors data.

If not specified, uses default name "tensors".

virtual char* vtkDataWriter::GetTensorsName ( )
virtual

Give a name to the tensors data.

If not specified, uses default name "tensors".

virtual void vtkDataWriter::SetNormalsName ( const char *  )
virtual

Give a name to the normals data.

If not specified, uses default name "normals".

virtual char* vtkDataWriter::GetNormalsName ( )
virtual

Give a name to the normals data.

If not specified, uses default name "normals".

virtual void vtkDataWriter::SetTCoordsName ( const char *  )
virtual

Give a name to the texture coordinates data.

If not specified, uses default name "textureCoords".

virtual char* vtkDataWriter::GetTCoordsName ( )
virtual

Give a name to the texture coordinates data.

If not specified, uses default name "textureCoords".

virtual void vtkDataWriter::SetGlobalIdsName ( const char *  )
virtual

Give a name to the global ids data.

If not specified, uses default name "global_ids".

virtual char* vtkDataWriter::GetGlobalIdsName ( )
virtual

Give a name to the global ids data.

If not specified, uses default name "global_ids".

virtual void vtkDataWriter::SetPedigreeIdsName ( const char *  )
virtual

Give a name to the pedigree ids data.

If not specified, uses default name "pedigree_ids".

virtual char* vtkDataWriter::GetPedigreeIdsName ( )
virtual

Give a name to the pedigree ids data.

If not specified, uses default name "pedigree_ids".

virtual void vtkDataWriter::SetEdgeFlagsName ( const char *  )
virtual

Give a name to the edge flags data.

If not specified, uses default name "edge_flags".

virtual char* vtkDataWriter::GetEdgeFlagsName ( )
virtual

Give a name to the edge flags data.

If not specified, uses default name "edge_flags".

virtual void vtkDataWriter::SetLookupTableName ( const char *  )
virtual

Give a name to the lookup table.

If not specified, uses default name "lookupTable".

virtual char* vtkDataWriter::GetLookupTableName ( )
virtual

Give a name to the lookup table.

If not specified, uses default name "lookupTable".

virtual void vtkDataWriter::SetFieldDataName ( const char *  )
virtual

Give a name to the field data.

If not specified, uses default name "field".

virtual char* vtkDataWriter::GetFieldDataName ( )
virtual

Give a name to the field data.

If not specified, uses default name "field".

virtual ostream* vtkDataWriter::OpenVTKFile ( )
virtual

Open a vtk data file.

Returns NULL if error.

int vtkDataWriter::WriteHeader ( ostream *  fp)

Write the header of a vtk data file.

Returns 0 if error.

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

Write out the points of the data set.

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

Write out coordinates for rectilinear grids.

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

Write out the cells of the data set.

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

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

Returns 0 if error.

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

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

Returns 0 if error.

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

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

Returns 0 if error.

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

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

Returns 0 if error.

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

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

Returns 0 if error.

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

Write out the field data.

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

void vtkDataWriter::CloseVTKFile ( ostream *  fp)

Close a vtk file.

void vtkDataWriter::WriteData ( )
protectedvirtual
int vtkDataWriter::WriteArray ( ostream *  fp,
int  dataType,
vtkAbstractArray data,
const char *  format,
int  num,
int  numComp 
)
protected
int vtkDataWriter::WriteScalarData ( ostream *  fp,
vtkDataArray s,
int  num 
)
protected
int vtkDataWriter::WriteVectorData ( ostream *  fp,
vtkDataArray v,
int  num 
)
protected
int vtkDataWriter::WriteNormalData ( ostream *  fp,
vtkDataArray n,
int  num 
)
protected
int vtkDataWriter::WriteTCoordData ( ostream *  fp,
vtkDataArray tc,
int  num 
)
protected
int vtkDataWriter::WriteTensorData ( ostream *  fp,
vtkDataArray t,
int  num 
)
protected
int vtkDataWriter::WriteGlobalIdData ( ostream *  fp,
vtkDataArray g,
int  num 
)
protected
int vtkDataWriter::WritePedigreeIdData ( ostream *  fp,
vtkAbstractArray p,
int  num 
)
protected
int vtkDataWriter::WriteEdgeFlagsData ( ostream *  fp,
vtkDataArray edgeFlags,
int  num 
)
protected
bool vtkDataWriter::CanWriteInformationKey ( vtkInformation info,
vtkInformationKey key 
)
protected
int vtkDataWriter::WriteInformation ( ostream *  fp,
vtkInformation info 
)
protected

Format is detailed here.

Member Data Documentation

int vtkDataWriter::WriteToOutputString
protected

Definition at line 295 of file vtkDataWriter.h.

char* vtkDataWriter::OutputString
protected

Definition at line 296 of file vtkDataWriter.h.

int vtkDataWriter::OutputStringLength
protected

Definition at line 297 of file vtkDataWriter.h.

char* vtkDataWriter::FileName
protected

Definition at line 301 of file vtkDataWriter.h.

char* vtkDataWriter::Header
protected

Definition at line 302 of file vtkDataWriter.h.

int vtkDataWriter::FileType
protected

Definition at line 303 of file vtkDataWriter.h.

bool vtkDataWriter::WriteArrayMetaData
protected

Definition at line 305 of file vtkDataWriter.h.

char* vtkDataWriter::ScalarsName
protected

Definition at line 307 of file vtkDataWriter.h.

char* vtkDataWriter::VectorsName
protected

Definition at line 308 of file vtkDataWriter.h.

char* vtkDataWriter::TensorsName
protected

Definition at line 309 of file vtkDataWriter.h.

char* vtkDataWriter::TCoordsName
protected

Definition at line 310 of file vtkDataWriter.h.

char* vtkDataWriter::NormalsName
protected

Definition at line 311 of file vtkDataWriter.h.

char* vtkDataWriter::LookupTableName
protected

Definition at line 312 of file vtkDataWriter.h.

char* vtkDataWriter::FieldDataName
protected

Definition at line 313 of file vtkDataWriter.h.

char* vtkDataWriter::GlobalIdsName
protected

Definition at line 314 of file vtkDataWriter.h.

char* vtkDataWriter::PedigreeIdsName
protected

Definition at line 315 of file vtkDataWriter.h.

char* vtkDataWriter::EdgeFlagsName
protected

Definition at line 316 of file vtkDataWriter.h.


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