VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkXMLWriter Class Referenceabstract

Superclass for VTK's XML file writers. More...

#include <vtkXMLWriter.h>

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

Public Types

enum  { BigEndian, LittleEndian }
 Enumerate big and little endian byte order settings. More...
 
enum  { Ascii, Binary, Appended }
 Enumerate the supported data modes. More...
 
enum  { Int32 = 32, Int64 = 64 }
 Enumerate the supported vtkIdType bit lengths. More...
 
enum  { UInt32 = 32, UInt64 = 64 }
 Enumerate the supported binary data header bit lengths. More...
 
enum  CompressorType { NONE, ZLIB, LZ4, LZMA }
 
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkXMLWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetByteOrder (int)
 Get/Set the byte order of data written to the file. More...
 
virtual int GetByteOrder ()
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
virtual void SetHeaderType (int)
 Get/Set the binary data header word type. More...
 
virtual int GetHeaderType ()
 
void SetHeaderTypeToUInt32 ()
 
void SetHeaderTypeToUInt64 ()
 
virtual void SetIdType (int)
 Get/Set the size of the vtkIdType values stored in the file. More...
 
virtual int GetIdType ()
 
void SetIdTypeToInt32 ()
 
void SetIdTypeToInt64 ()
 
virtual void SetFileName (const char *)
 Get/Set the name of the output file. More...
 
virtual char * GetFileName ()
 
virtual void SetWriteToOutputString (vtkTypeBool)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual vtkTypeBool GetWriteToOutputString ()
 
virtual void WriteToOutputStringOn ()
 
virtual void WriteToOutputStringOff ()
 
std::string GetOutputString ()
 
virtual void SetCompressor (vtkDataCompressor *)
 Get/Set the compressor used to compress binary and appended data before writing to the file. More...
 
virtual vtkDataCompressorGetCompressor ()
 
void SetCompressorType (int compressorType)
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressorTypeToNone ()
 
void SetCompressorTypeToLZ4 ()
 
void SetCompressorTypeToZLib ()
 
void SetCompressorTypeToLZMA ()
 
void SetCompressionLevel (int compressorLevel)
 
virtual int GetCompressionLevel ()
 
virtual void SetBlockSize (size_t blockSize)
 Get/Set the block size used in compression. More...
 
virtual size_t GetBlockSize ()
 
virtual void SetDataMode (int)
 Get/Set the data mode used for the file's data. More...
 
virtual int GetDataMode ()
 
void SetDataModeToAscii ()
 
void SetDataModeToBinary ()
 
void SetDataModeToAppended ()
 
virtual void SetEncodeAppendedData (vtkTypeBool)
 Get/Set whether the appended data section is base64 encoded. More...
 
virtual vtkTypeBool GetEncodeAppendedData ()
 
virtual void EncodeAppendedDataOn ()
 
virtual void EncodeAppendedDataOff ()
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
virtual const char * GetDefaultFileExtension ()=0
 Get the default file extension for files written by this writer. More...
 
int Write ()
 Invoke the writer. More...
 
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 GetNumberOfTimeSteps ()
 Set the number of time steps. More...
 
virtual void SetNumberOfTimeSteps (int)
 
void Start ()
 API to interface an outside the VTK pipeline control. More...
 
void Stop ()
 
void WriteNextTime (double time)
 
- 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...
 
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...
 
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...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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 void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkXMLWriter ()
 
 ~vtkXMLWriter () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual void SetDataStream (vtkOutputStream *)
 
virtual vtkOutputStreamGetDataStream ()
 
virtual int WriteInternal ()
 
virtual int WriteData ()
 
virtual const char * GetDataSetName ()=0
 
virtual int GetDataSetMajorVersion ()
 
virtual int GetDataSetMinorVersion ()
 
vtkDataSetGetInputAsDataSet ()
 
virtual int StartFile ()
 
virtual void WriteFileAttributes ()
 
virtual int EndFile ()
 
void DeleteAFile ()
 
void DeleteAFile (const char *name)
 
virtual int WritePrimaryElement (ostream &os, vtkIndent indent)
 
virtual void WritePrimaryElementAttributes (ostream &os, vtkIndent indent)
 
void StartAppendedData ()
 
void EndAppendedData ()
 
vtkTypeInt64 ReserveAttributeSpace (const char *attr, size_t length=20)
 
vtkTypeInt64 GetAppendedDataOffset ()
 
void WriteAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 &lastoffset, const char *attr=nullptr)
 
void ForwardAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char *attr=nullptr)
 
void ForwardAppendedDataDouble (vtkTypeInt64 streamPos, double value, const char *attr)
 
int WriteScalarAttribute (const char *name, int data)
 
int WriteScalarAttribute (const char *name, float data)
 
int WriteScalarAttribute (const char *name, double data)
 
int WriteVectorAttribute (const char *name, int length, int *data)
 
int WriteVectorAttribute (const char *name, int length, float *data)
 
int WriteVectorAttribute (const char *name, int length, double *data)
 
int WriteDataModeAttribute (const char *name)
 
int WriteWordTypeAttribute (const char *name, int dataType)
 
int WriteStringAttribute (const char *name, const char *value)
 
bool WriteInformation (vtkInformation *info, vtkIndent indent)
 
void WriteArrayHeader (vtkAbstractArray *a, vtkIndent indent, const char *alternateName, int writeNumTuples, int timestep)
 
virtual void WriteArrayFooter (ostream &os, vtkIndent indent, vtkAbstractArray *a, int shortFormat)
 
virtual void WriteArrayInline (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=nullptr, int writeNumTuples=0)
 
virtual void WriteInlineData (vtkAbstractArray *a, vtkIndent indent)
 
void WriteArrayAppended (vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=nullptr, int writeNumTuples=0, int timestep=0)
 
int WriteAsciiData (vtkAbstractArray *a, vtkIndent indent)
 
int WriteBinaryData (vtkAbstractArray *a)
 
int WriteBinaryDataInternal (vtkAbstractArray *a)
 
void WriteArrayAppendedData (vtkAbstractArray *a, vtkTypeInt64 pos, vtkTypeInt64 &lastoffset)
 
void WriteFieldData (vtkIndent indent)
 
void WriteFieldDataInline (vtkFieldData *fd, vtkIndent indent)
 
void WritePointDataInline (vtkPointData *pd, vtkIndent indent)
 
void WriteCellDataInline (vtkCellData *cd, vtkIndent indent)
 
void WriteFieldDataAppended (vtkFieldData *fd, vtkIndent indent, OffsetsManagerGroup *fdManager)
 
void WriteFieldDataAppendedData (vtkFieldData *fd, int timestep, OffsetsManagerGroup *fdManager)
 
void WritePointDataAppended (vtkPointData *pd, vtkIndent indent, OffsetsManagerGroup *pdManager)
 
void WritePointDataAppendedData (vtkPointData *pd, int timestep, OffsetsManagerGroup *pdManager)
 
void WriteCellDataAppended (vtkCellData *cd, vtkIndent indent, OffsetsManagerGroup *cdManager)
 
void WriteCellDataAppendedData (vtkCellData *cd, int timestep, OffsetsManagerGroup *cdManager)
 
void WriteAttributeIndices (vtkDataSetAttributes *dsa, char **names)
 
void WritePointsAppended (vtkPoints *points, vtkIndent indent, OffsetsManager *manager)
 
void WritePointsAppendedData (vtkPoints *points, int timestep, OffsetsManager *pdManager)
 
void WritePointsInline (vtkPoints *points, vtkIndent indent)
 
void WriteCoordinatesInline (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
 
void WriteCoordinatesAppended (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent, OffsetsManagerGroup *coordManager)
 
void WriteCoordinatesAppendedData (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, int timestep, OffsetsManagerGroup *coordManager)
 
void WritePPointData (vtkPointData *pd, vtkIndent indent)
 
void WritePCellData (vtkCellData *cd, vtkIndent indent)
 
void WritePPoints (vtkPoints *points, vtkIndent indent)
 
void WritePArray (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=nullptr)
 
void WritePCoordinates (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
 
int WriteBinaryDataBlock (unsigned char *in_data, size_t numWords, int wordType)
 
void PerformByteSwap (void *data, size_t numWords, size_t wordSize)
 
int CreateCompressionHeader (size_t size)
 
int WriteCompressionBlock (unsigned char *data, size_t size)
 
int WriteCompressionHeader ()
 
size_t GetWordTypeSize (int dataType)
 
const char * GetWordTypeName (int dataType)
 
size_t GetOutputWordTypeSize (int dataType)
 
char ** CreateStringArray (int numStrings)
 
void DestroyStringArray (int numStrings, char **strings)
 
virtual void GetProgressRange (float range[2])
 
virtual void SetProgressRange (const float range[2], int curStep, int numSteps)
 
virtual void SetProgressRange (const float range[2], int curStep, const float *fractions)
 
virtual void SetProgressPartial (float fraction)
 
virtual void UpdateProgressDiscrete (float progress)
 
void UpdateFieldData (vtkFieldData *)
 
int OpenStream ()
 
int OpenFile ()
 
int OpenString ()
 
void CloseStream ()
 
void CloseFile ()
 
void CloseString ()
 
- 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...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
ostream * Stream
 
vtkTypeBool WriteToOutputString
 
std::string OutputString
 
int ByteOrder
 
int HeaderType
 
int IdType
 
int DataMode
 
vtkTypeBool EncodeAppendedData
 
vtkTypeInt64 AppendedDataPosition
 
OffsetsManagerGroupFieldDataOM
 
Int32IdType * Int32IdTypeBuffer
 
unsigned char * ByteSwapBuffer
 
vtkDataCompressorCompressor
 
size_t BlockSize
 
size_t CompressionBlockNumber
 
vtkXMLDataHeaderCompressionHeader
 
vtkTypeInt64 CompressionHeaderPosition
 
int CompressionLevel = 5
 
vtkOutputStreamDataStream
 
float ProgressRange [2]
 
ofstream * OutFile
 
std::ostringstream * OutStringStream
 
int CurrentTimeIndex
 
int NumberOfTimeSteps
 
int UserContinueExecuting
 
bool UsePreviousVersion
 
vtkTypeInt64 * NumberOfTimeValues
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkXMLWriterHelper
 

Additional Inherited Members

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

Detailed Description

Superclass for VTK's XML file writers.

vtkXMLWriter provides methods implementing most of the functionality needed to write VTK XML file formats. Concrete subclasses provide actual writer implementations calling upon this functionality.

Thanks
CompressionLevel getters/setters exposed by Quincy Wofford (qwoff.nosp@m.ord@.nosp@m.lanl..nosp@m.gov) and John Patchett (patch.nosp@m.ett@.nosp@m.lanl..nosp@m.gov), Los Alamos National Laboratory (2017)

Definition at line 60 of file vtkXMLWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 63 of file vtkXMLWriter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerate big and little endian byte order settings.

Enumerator
BigEndian 
LittleEndian 

Definition at line 69 of file vtkXMLWriter.h.

◆ anonymous enum

anonymous enum

Enumerate the supported data modes.

Ascii = Inline ascii data. Binary = Inline binary data (base64 encoded, possibly compressed). Appended = Appended binary data (possibly compressed and/or base64).

Enumerator
Ascii 
Binary 
Appended 

Definition at line 81 of file vtkXMLWriter.h.

◆ anonymous enum

anonymous enum

Enumerate the supported vtkIdType bit lengths.

Int32 = File stores 32-bit values for vtkIdType. Int64 = File stores 64-bit values for vtkIdType.

Enumerator
Int32 
Int64 

Definition at line 93 of file vtkXMLWriter.h.

◆ anonymous enum

anonymous enum

Enumerate the supported binary data header bit lengths.

UInt32 = File stores 32-bit binary data header elements. UInt64 = File stores 64-bit binary data header elements.

Enumerator
UInt32 
UInt64 

Definition at line 104 of file vtkXMLWriter.h.

◆ CompressorType

Enumerator
NONE 
ZLIB 
LZ4 
LZMA 

Definition at line 170 of file vtkXMLWriter.h.

Constructor & Destructor Documentation

◆ vtkXMLWriter()

vtkXMLWriter::vtkXMLWriter ( )
protected

◆ ~vtkXMLWriter()

vtkXMLWriter::~vtkXMLWriter ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkXMLWriter::IsA ( const char *  name)
virtual

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLWriter::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkXMLWriter* vtkXMLWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

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

Reimplemented from vtkAlgorithm.

◆ SetByteOrder()

virtual void vtkXMLWriter::SetByteOrder ( int  )
virtual

Get/Set the byte order of data written to the file.

The default is the machine's hardware byte order.

◆ GetByteOrder()

virtual int vtkXMLWriter::GetByteOrder ( )
virtual

◆ SetByteOrderToBigEndian()

void vtkXMLWriter::SetByteOrderToBigEndian ( )

◆ SetByteOrderToLittleEndian()

void vtkXMLWriter::SetByteOrderToLittleEndian ( )

◆ SetHeaderType()

virtual void vtkXMLWriter::SetHeaderType ( int  )
virtual

Get/Set the binary data header word type.

The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

◆ GetHeaderType()

virtual int vtkXMLWriter::GetHeaderType ( )
virtual

◆ SetHeaderTypeToUInt32()

void vtkXMLWriter::SetHeaderTypeToUInt32 ( )

◆ SetHeaderTypeToUInt64()

void vtkXMLWriter::SetHeaderTypeToUInt64 ( )

◆ SetIdType()

virtual void vtkXMLWriter::SetIdType ( int  )
virtual

Get/Set the size of the vtkIdType values stored in the file.

The default is the real size of vtkIdType.

◆ GetIdType()

virtual int vtkXMLWriter::GetIdType ( )
virtual

◆ SetIdTypeToInt32()

void vtkXMLWriter::SetIdTypeToInt32 ( )

◆ SetIdTypeToInt64()

void vtkXMLWriter::SetIdTypeToInt64 ( )

◆ SetFileName()

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

Get/Set the name of the output file.

◆ GetFileName()

virtual char* vtkXMLWriter::GetFileName ( )
virtual

◆ SetWriteToOutputString()

virtual void vtkXMLWriter::SetWriteToOutputString ( vtkTypeBool  )
virtual

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

◆ GetWriteToOutputString()

virtual vtkTypeBool vtkXMLWriter::GetWriteToOutputString ( )
virtual

◆ WriteToOutputStringOn()

virtual void vtkXMLWriter::WriteToOutputStringOn ( )
virtual

◆ WriteToOutputStringOff()

virtual void vtkXMLWriter::WriteToOutputStringOff ( )
virtual

◆ GetOutputString()

std::string vtkXMLWriter::GetOutputString ( )
inline

Definition at line 158 of file vtkXMLWriter.h.

◆ SetCompressor()

virtual void vtkXMLWriter::SetCompressor ( vtkDataCompressor )
virtual

Get/Set the compressor used to compress binary and appended data before writing to the file.

Default is a vtkZLibDataCompressor.

◆ GetCompressor()

virtual vtkDataCompressor* vtkXMLWriter::GetCompressor ( )
virtual

◆ SetCompressorType()

void vtkXMLWriter::SetCompressorType ( int  compressorType)

Convenience functions to set the compressor to certain known types.

◆ SetCompressorTypeToNone()

void vtkXMLWriter::SetCompressorTypeToNone ( )
inline

Definition at line 183 of file vtkXMLWriter.h.

◆ SetCompressorTypeToLZ4()

void vtkXMLWriter::SetCompressorTypeToLZ4 ( )
inline

Definition at line 184 of file vtkXMLWriter.h.

◆ SetCompressorTypeToZLib()

void vtkXMLWriter::SetCompressorTypeToZLib ( )
inline

Definition at line 185 of file vtkXMLWriter.h.

◆ SetCompressorTypeToLZMA()

void vtkXMLWriter::SetCompressorTypeToLZMA ( )
inline

Definition at line 186 of file vtkXMLWriter.h.

◆ SetCompressionLevel()

void vtkXMLWriter::SetCompressionLevel ( int  compressorLevel)

◆ GetCompressionLevel()

virtual int vtkXMLWriter::GetCompressionLevel ( )
virtual

◆ SetBlockSize()

virtual void vtkXMLWriter::SetBlockSize ( size_t  blockSize)
virtual

Get/Set the block size used in compression.

When reading, this controls the granularity of how much extra information must be read when only part of the data are requested. The value should be a multiple of the largest scalar data type.

◆ GetBlockSize()

virtual size_t vtkXMLWriter::GetBlockSize ( )
virtual

◆ SetDataMode()

virtual void vtkXMLWriter::SetDataMode ( int  )
virtual

Get/Set the data mode used for the file's data.

The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

◆ GetDataMode()

virtual int vtkXMLWriter::GetDataMode ( )
virtual

◆ SetDataModeToAscii()

void vtkXMLWriter::SetDataModeToAscii ( )

◆ SetDataModeToBinary()

void vtkXMLWriter::SetDataModeToBinary ( )

◆ SetDataModeToAppended()

void vtkXMLWriter::SetDataModeToAppended ( )

◆ SetEncodeAppendedData()

virtual void vtkXMLWriter::SetEncodeAppendedData ( vtkTypeBool  )
virtual

Get/Set whether the appended data section is base64 encoded.

If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

◆ GetEncodeAppendedData()

virtual vtkTypeBool vtkXMLWriter::GetEncodeAppendedData ( )
virtual

◆ EncodeAppendedDataOn()

virtual void vtkXMLWriter::EncodeAppendedDataOn ( )
virtual

◆ EncodeAppendedDataOff()

virtual void vtkXMLWriter::EncodeAppendedDataOff ( )
virtual

◆ SetInputData() [1/2]

void vtkXMLWriter::SetInputData ( vtkDataObject )

Assign a data object as input.

Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

◆ SetInputData() [2/2]

void vtkXMLWriter::SetInputData ( int  ,
vtkDataObject  
)

◆ GetInput() [1/2]

vtkDataObject* vtkXMLWriter::GetInput ( int  port)

◆ GetInput() [2/2]

vtkDataObject* vtkXMLWriter::GetInput ( )
inline

Definition at line 238 of file vtkXMLWriter.h.

◆ GetDefaultFileExtension()

virtual const char* vtkXMLWriter::GetDefaultFileExtension ( )
pure virtual

◆ Write()

int vtkXMLWriter::Write ( )

Invoke the writer.

Returns 1 for success, 0 for failure.

◆ ProcessRequest()

vtkTypeBool vtkXMLWriter::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
overridevirtual

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs.

A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest.

An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest.

It returns the boolean status of the pipeline (false means failure).

Reimplemented from vtkAlgorithm.

◆ GetNumberOfTimeSteps()

virtual int vtkXMLWriter::GetNumberOfTimeSteps ( )
virtual

Set the number of time steps.

◆ SetNumberOfTimeSteps()

virtual void vtkXMLWriter::SetNumberOfTimeSteps ( int  )
virtual

◆ Start()

void vtkXMLWriter::Start ( )

API to interface an outside the VTK pipeline control.

◆ Stop()

void vtkXMLWriter::Stop ( )

◆ WriteNextTime()

void vtkXMLWriter::WriteNextTime ( double  time)

◆ RequestInformation()

virtual int vtkXMLWriter::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

◆ RequestData()

virtual int vtkXMLWriter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

Reimplemented in vtkXMLCompositeDataWriter.

◆ SetDataStream()

virtual void vtkXMLWriter::SetDataStream ( vtkOutputStream )
protectedvirtual

◆ GetDataStream()

virtual vtkOutputStream* vtkXMLWriter::GetDataStream ( )
protectedvirtual

◆ WriteInternal()

virtual int vtkXMLWriter::WriteInternal ( )
protectedvirtual

◆ WriteData()

virtual int vtkXMLWriter::WriteData ( )
inlineprotectedvirtual

◆ GetDataSetName()

virtual const char* vtkXMLWriter::GetDataSetName ( )
protectedpure virtual

◆ GetDataSetMajorVersion()

virtual int vtkXMLWriter::GetDataSetMajorVersion ( )
protectedvirtual

◆ GetDataSetMinorVersion()

virtual int vtkXMLWriter::GetDataSetMinorVersion ( )
protectedvirtual

◆ GetInputAsDataSet()

vtkDataSet* vtkXMLWriter::GetInputAsDataSet ( )
protected

◆ StartFile()

virtual int vtkXMLWriter::StartFile ( )
protectedvirtual

Reimplemented in vtkPhyloXMLTreeWriter.

◆ WriteFileAttributes()

virtual void vtkXMLWriter::WriteFileAttributes ( )
protectedvirtual

◆ EndFile()

virtual int vtkXMLWriter::EndFile ( )
protectedvirtual

Reimplemented in vtkPhyloXMLTreeWriter.

◆ DeleteAFile() [1/2]

void vtkXMLWriter::DeleteAFile ( )
protected

◆ DeleteAFile() [2/2]

void vtkXMLWriter::DeleteAFile ( const char *  name)
protected

◆ WritePrimaryElement()

virtual int vtkXMLWriter::WritePrimaryElement ( ostream &  os,
vtkIndent  indent 
)
protectedvirtual

◆ WritePrimaryElementAttributes()

virtual void vtkXMLWriter::WritePrimaryElementAttributes ( ostream &  os,
vtkIndent  indent 
)
protectedvirtual

◆ StartAppendedData()

void vtkXMLWriter::StartAppendedData ( )
protected

◆ EndAppendedData()

void vtkXMLWriter::EndAppendedData ( )
protected

◆ ReserveAttributeSpace()

vtkTypeInt64 vtkXMLWriter::ReserveAttributeSpace ( const char *  attr,
size_t  length = 20 
)
protected

◆ GetAppendedDataOffset()

vtkTypeInt64 vtkXMLWriter::GetAppendedDataOffset ( )
protected

◆ WriteAppendedDataOffset()

void vtkXMLWriter::WriteAppendedDataOffset ( vtkTypeInt64  streamPos,
vtkTypeInt64 &  lastoffset,
const char *  attr = nullptr 
)
protected

◆ ForwardAppendedDataOffset()

void vtkXMLWriter::ForwardAppendedDataOffset ( vtkTypeInt64  streamPos,
vtkTypeInt64  offset,
const char *  attr = nullptr 
)
protected

◆ ForwardAppendedDataDouble()

void vtkXMLWriter::ForwardAppendedDataDouble ( vtkTypeInt64  streamPos,
double  value,
const char *  attr 
)
protected

◆ WriteScalarAttribute() [1/3]

int vtkXMLWriter::WriteScalarAttribute ( const char *  name,
int  data 
)
protected

◆ WriteScalarAttribute() [2/3]

int vtkXMLWriter::WriteScalarAttribute ( const char *  name,
float  data 
)
protected

◆ WriteScalarAttribute() [3/3]

int vtkXMLWriter::WriteScalarAttribute ( const char *  name,
double  data 
)
protected

◆ WriteVectorAttribute() [1/3]

int vtkXMLWriter::WriteVectorAttribute ( const char *  name,
int  length,
int *  data 
)
protected

◆ WriteVectorAttribute() [2/3]

int vtkXMLWriter::WriteVectorAttribute ( const char *  name,
int  length,
float *  data 
)
protected

◆ WriteVectorAttribute() [3/3]

int vtkXMLWriter::WriteVectorAttribute ( const char *  name,
int  length,
double *  data 
)
protected

◆ WriteDataModeAttribute()

int vtkXMLWriter::WriteDataModeAttribute ( const char *  name)
protected

◆ WriteWordTypeAttribute()

int vtkXMLWriter::WriteWordTypeAttribute ( const char *  name,
int  dataType 
)
protected

◆ WriteStringAttribute()

int vtkXMLWriter::WriteStringAttribute ( const char *  name,
const char *  value 
)
protected

◆ WriteInformation()

bool vtkXMLWriter::WriteInformation ( vtkInformation info,
vtkIndent  indent 
)
protected

◆ WriteArrayHeader()

void vtkXMLWriter::WriteArrayHeader ( vtkAbstractArray a,
vtkIndent  indent,
const char *  alternateName,
int  writeNumTuples,
int  timestep 
)
protected

◆ WriteArrayFooter()

virtual void vtkXMLWriter::WriteArrayFooter ( ostream &  os,
vtkIndent  indent,
vtkAbstractArray a,
int  shortFormat 
)
protectedvirtual

◆ WriteArrayInline()

virtual void vtkXMLWriter::WriteArrayInline ( vtkAbstractArray a,
vtkIndent  indent,
const char *  alternateName = nullptr,
int  writeNumTuples = 0 
)
protectedvirtual

◆ WriteInlineData()

virtual void vtkXMLWriter::WriteInlineData ( vtkAbstractArray a,
vtkIndent  indent 
)
protectedvirtual

◆ WriteArrayAppended()

void vtkXMLWriter::WriteArrayAppended ( vtkAbstractArray a,
vtkIndent  indent,
OffsetsManager offs,
const char *  alternateName = nullptr,
int  writeNumTuples = 0,
int  timestep = 0 
)
protected

◆ WriteAsciiData()

int vtkXMLWriter::WriteAsciiData ( vtkAbstractArray a,
vtkIndent  indent 
)
protected

◆ WriteBinaryData()

int vtkXMLWriter::WriteBinaryData ( vtkAbstractArray a)
protected

◆ WriteBinaryDataInternal()

int vtkXMLWriter::WriteBinaryDataInternal ( vtkAbstractArray a)
protected

◆ WriteArrayAppendedData()

void vtkXMLWriter::WriteArrayAppendedData ( vtkAbstractArray a,
vtkTypeInt64  pos,
vtkTypeInt64 &  lastoffset 
)
protected

◆ WriteFieldData()

void vtkXMLWriter::WriteFieldData ( vtkIndent  indent)
protected

◆ WriteFieldDataInline()

void vtkXMLWriter::WriteFieldDataInline ( vtkFieldData fd,
vtkIndent  indent 
)
protected

◆ WritePointDataInline()

void vtkXMLWriter::WritePointDataInline ( vtkPointData pd,
vtkIndent  indent 
)
protected

◆ WriteCellDataInline()

void vtkXMLWriter::WriteCellDataInline ( vtkCellData cd,
vtkIndent  indent 
)
protected

◆ WriteFieldDataAppended()

void vtkXMLWriter::WriteFieldDataAppended ( vtkFieldData fd,
vtkIndent  indent,
OffsetsManagerGroup fdManager 
)
protected

◆ WriteFieldDataAppendedData()

void vtkXMLWriter::WriteFieldDataAppendedData ( vtkFieldData fd,
int  timestep,
OffsetsManagerGroup fdManager 
)
protected

◆ WritePointDataAppended()

void vtkXMLWriter::WritePointDataAppended ( vtkPointData pd,
vtkIndent  indent,
OffsetsManagerGroup pdManager 
)
protected

◆ WritePointDataAppendedData()

void vtkXMLWriter::WritePointDataAppendedData ( vtkPointData pd,
int  timestep,
OffsetsManagerGroup pdManager 
)
protected

◆ WriteCellDataAppended()

void vtkXMLWriter::WriteCellDataAppended ( vtkCellData cd,
vtkIndent  indent,
OffsetsManagerGroup cdManager 
)
protected

◆ WriteCellDataAppendedData()

void vtkXMLWriter::WriteCellDataAppendedData ( vtkCellData cd,
int  timestep,
OffsetsManagerGroup cdManager 
)
protected

◆ WriteAttributeIndices()

void vtkXMLWriter::WriteAttributeIndices ( vtkDataSetAttributes dsa,
char **  names 
)
protected

◆ WritePointsAppended()

void vtkXMLWriter::WritePointsAppended ( vtkPoints points,
vtkIndent  indent,
OffsetsManager manager 
)
protected

◆ WritePointsAppendedData()

void vtkXMLWriter::WritePointsAppendedData ( vtkPoints points,
int  timestep,
OffsetsManager pdManager 
)
protected

◆ WritePointsInline()

void vtkXMLWriter::WritePointsInline ( vtkPoints points,
vtkIndent  indent 
)
protected

◆ WriteCoordinatesInline()

void vtkXMLWriter::WriteCoordinatesInline ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
vtkIndent  indent 
)
protected

◆ WriteCoordinatesAppended()

void vtkXMLWriter::WriteCoordinatesAppended ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
vtkIndent  indent,
OffsetsManagerGroup coordManager 
)
protected

◆ WriteCoordinatesAppendedData()

void vtkXMLWriter::WriteCoordinatesAppendedData ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
int  timestep,
OffsetsManagerGroup coordManager 
)
protected

◆ WritePPointData()

void vtkXMLWriter::WritePPointData ( vtkPointData pd,
vtkIndent  indent 
)
protected

◆ WritePCellData()

void vtkXMLWriter::WritePCellData ( vtkCellData cd,
vtkIndent  indent 
)
protected

◆ WritePPoints()

void vtkXMLWriter::WritePPoints ( vtkPoints points,
vtkIndent  indent 
)
protected

◆ WritePArray()

void vtkXMLWriter::WritePArray ( vtkAbstractArray a,
vtkIndent  indent,
const char *  alternateName = nullptr 
)
protected

◆ WritePCoordinates()

void vtkXMLWriter::WritePCoordinates ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
vtkIndent  indent 
)
protected

◆ WriteBinaryDataBlock()

int vtkXMLWriter::WriteBinaryDataBlock ( unsigned char *  in_data,
size_t  numWords,
int  wordType 
)
protected

◆ PerformByteSwap()

void vtkXMLWriter::PerformByteSwap ( void *  data,
size_t  numWords,
size_t  wordSize 
)
protected

◆ CreateCompressionHeader()

int vtkXMLWriter::CreateCompressionHeader ( size_t  size)
protected

◆ WriteCompressionBlock()

int vtkXMLWriter::WriteCompressionBlock ( unsigned char *  data,
size_t  size 
)
protected

◆ WriteCompressionHeader()

int vtkXMLWriter::WriteCompressionHeader ( )
protected

◆ GetWordTypeSize()

size_t vtkXMLWriter::GetWordTypeSize ( int  dataType)
protected

◆ GetWordTypeName()

const char* vtkXMLWriter::GetWordTypeName ( int  dataType)
protected

◆ GetOutputWordTypeSize()

size_t vtkXMLWriter::GetOutputWordTypeSize ( int  dataType)
protected

◆ CreateStringArray()

char** vtkXMLWriter::CreateStringArray ( int  numStrings)
protected

◆ DestroyStringArray()

void vtkXMLWriter::DestroyStringArray ( int  numStrings,
char **  strings 
)
protected

◆ GetProgressRange()

virtual void vtkXMLWriter::GetProgressRange ( float  range[2])
protectedvirtual

◆ SetProgressRange() [1/2]

virtual void vtkXMLWriter::SetProgressRange ( const float  range[2],
int  curStep,
int  numSteps 
)
protectedvirtual

◆ SetProgressRange() [2/2]

virtual void vtkXMLWriter::SetProgressRange ( const float  range[2],
int  curStep,
const float *  fractions 
)
protectedvirtual

◆ SetProgressPartial()

virtual void vtkXMLWriter::SetProgressPartial ( float  fraction)
protectedvirtual

◆ UpdateProgressDiscrete()

virtual void vtkXMLWriter::UpdateProgressDiscrete ( float  progress)
protectedvirtual

◆ UpdateFieldData()

void vtkXMLWriter::UpdateFieldData ( vtkFieldData )
protected

◆ OpenStream()

int vtkXMLWriter::OpenStream ( )
protected

◆ OpenFile()

int vtkXMLWriter::OpenFile ( )
protected

◆ OpenString()

int vtkXMLWriter::OpenString ( )
protected

◆ CloseStream()

void vtkXMLWriter::CloseStream ( )
protected

◆ CloseFile()

void vtkXMLWriter::CloseFile ( )
protected

◆ CloseString()

void vtkXMLWriter::CloseString ( )
protected

Friends And Related Function Documentation

◆ vtkXMLWriterHelper

friend class vtkXMLWriterHelper
friend

Definition at line 513 of file vtkXMLWriter.h.

Member Data Documentation

◆ FileName

char* vtkXMLWriter::FileName
protected

Definition at line 282 of file vtkXMLWriter.h.

◆ Stream

ostream* vtkXMLWriter::Stream
protected

Definition at line 285 of file vtkXMLWriter.h.

◆ WriteToOutputString

vtkTypeBool vtkXMLWriter::WriteToOutputString
protected

Definition at line 289 of file vtkXMLWriter.h.

◆ OutputString

std::string vtkXMLWriter::OutputString
protected

Definition at line 292 of file vtkXMLWriter.h.

◆ ByteOrder

int vtkXMLWriter::ByteOrder
protected

Definition at line 295 of file vtkXMLWriter.h.

◆ HeaderType

int vtkXMLWriter::HeaderType
protected

Definition at line 298 of file vtkXMLWriter.h.

◆ IdType

int vtkXMLWriter::IdType
protected

Definition at line 301 of file vtkXMLWriter.h.

◆ DataMode

int vtkXMLWriter::DataMode
protected

Definition at line 305 of file vtkXMLWriter.h.

◆ EncodeAppendedData

vtkTypeBool vtkXMLWriter::EncodeAppendedData
protected

Definition at line 308 of file vtkXMLWriter.h.

◆ AppendedDataPosition

vtkTypeInt64 vtkXMLWriter::AppendedDataPosition
protected

Definition at line 311 of file vtkXMLWriter.h.

◆ FieldDataOM

OffsetsManagerGroup* vtkXMLWriter::FieldDataOM
protected

Definition at line 314 of file vtkXMLWriter.h.

◆ Int32IdTypeBuffer

Int32IdType* vtkXMLWriter::Int32IdTypeBuffer
protected

Definition at line 330 of file vtkXMLWriter.h.

◆ ByteSwapBuffer

unsigned char* vtkXMLWriter::ByteSwapBuffer
protected

Definition at line 333 of file vtkXMLWriter.h.

◆ Compressor

vtkDataCompressor* vtkXMLWriter::Compressor
protected

Definition at line 336 of file vtkXMLWriter.h.

◆ BlockSize

size_t vtkXMLWriter::BlockSize
protected

Definition at line 337 of file vtkXMLWriter.h.

◆ CompressionBlockNumber

size_t vtkXMLWriter::CompressionBlockNumber
protected

Definition at line 338 of file vtkXMLWriter.h.

◆ CompressionHeader

vtkXMLDataHeader* vtkXMLWriter::CompressionHeader
protected

Definition at line 339 of file vtkXMLWriter.h.

◆ CompressionHeaderPosition

vtkTypeInt64 vtkXMLWriter::CompressionHeaderPosition
protected

Definition at line 340 of file vtkXMLWriter.h.

◆ CompressionLevel

int vtkXMLWriter::CompressionLevel = 5
protected

Definition at line 343 of file vtkXMLWriter.h.

◆ DataStream

vtkOutputStream* vtkXMLWriter::DataStream
protected

Definition at line 347 of file vtkXMLWriter.h.

◆ ProgressRange

float vtkXMLWriter::ProgressRange[2]
protected

Definition at line 479 of file vtkXMLWriter.h.

◆ OutFile

ofstream* vtkXMLWriter::OutFile
protected

Definition at line 485 of file vtkXMLWriter.h.

◆ OutStringStream

std::ostringstream* vtkXMLWriter::OutStringStream
protected

Definition at line 486 of file vtkXMLWriter.h.

◆ CurrentTimeIndex

int vtkXMLWriter::CurrentTimeIndex
protected

Definition at line 496 of file vtkXMLWriter.h.

◆ NumberOfTimeSteps

int vtkXMLWriter::NumberOfTimeSteps
protected

Definition at line 497 of file vtkXMLWriter.h.

◆ UserContinueExecuting

int vtkXMLWriter::UserContinueExecuting
protected

Definition at line 501 of file vtkXMLWriter.h.

◆ UsePreviousVersion

bool vtkXMLWriter::UsePreviousVersion
protected

Definition at line 509 of file vtkXMLWriter.h.

◆ NumberOfTimeValues

vtkTypeInt64* vtkXMLWriter::NumberOfTimeValues
protected

Definition at line 511 of file vtkXMLWriter.h.


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