VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkXMLWriter Class Reference

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

#include <vtkXMLWriter.h>

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

List of all members.

Public Types

enum  CompressorType { NONE, ZLIB }
typedef vtkAlgorithm Superclass
enum  { BigEndian, LittleEndian }
enum  { Ascii, Binary, Appended }
enum  { Int32 = 32, Int64 = 64 }
typedef vtkIdType OffsetType
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual const char * GetDefaultFileExtension ()=0
int Write ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void SetByteOrder (int)
virtual int GetByteOrder ()
void SetByteOrderToBigEndian ()
void SetByteOrderToLittleEndian ()
virtual void SetIdType (int)
virtual int GetIdType ()
void SetIdTypeToInt32 ()
void SetIdTypeToInt64 ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetCompressor (vtkDataCompressor *)
virtual vtkDataCompressorGetCompressor ()
void SetCompressorType (int compressorType)
void SetCompressorTypeToNone ()
void SetCompressorTypeToZLib ()
virtual void SetBlockSize (unsigned int blockSize)
virtual unsigned int GetBlockSize ()
virtual void SetDataMode (int)
virtual int GetDataMode ()
void SetDataModeToAscii ()
void SetDataModeToBinary ()
void SetDataModeToAppended ()
virtual void SetEncodeAppendedData (int)
virtual int GetEncodeAppendedData ()
virtual void EncodeAppendedDataOn ()
virtual void EncodeAppendedDataOff ()
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
virtual void SetTimeStep (int)
virtual int GetTimeStep ()
virtual int * GetTimeStepRange ()
virtual void GetTimeStepRange (int &, int &)
virtual void GetTimeStepRange (int[2])
virtual void SetTimeStepRange (int, int)
void SetTimeStepRange (int[2])
virtual int GetNumberOfTimeSteps ()
virtual void SetNumberOfTimeSteps (int)
void Start ()
void Stop ()
void WriteNextTime (double time)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
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)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkXMLWriterSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKeyINPUT_PORT ()
static vtkInformationIntegerKeyINPUT_CONNECTION ()
static vtkInformationIntegerKeyPRESERVES_DATASET ()
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
static vtkInformationIntegerKeyPRESERVES_RANGES ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkXMLWriter ()
 ~vtkXMLWriter ()
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 ()
int StartFile ()
virtual void WriteFileAttributes ()
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 ()
OffsetType ReserveAttributeSpace (const char *attr, int length=20)
OffsetType GetAppendedDataOffset ()
OffsetType WriteAppendedDataOffset (OffsetType streamPos, OffsetType &lastoffset, const char *attr=0)
OffsetType ForwardAppendedDataOffset (OffsetType streamPos, OffsetType offset, const char *attr=0)
OffsetType ForwardAppendedDataDouble (OffsetType 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)
void WriteArrayHeader (vtkAbstractArray *a, vtkIndent indent, const char *alternateName, int writeNumTuples, int timestep)
void WriteArrayFooter (ostream &os, vtkIndent indent, vtkAbstractArray *a, int shortFormat)
void WriteArrayInline (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=0, int writeNumTuples=0)
void WriteInlineData (vtkAbstractArray *a, vtkIndent indent)
void WriteArrayAppended (vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=0, int writeNumTuples=0, int timestep=0)
int WriteAsciiData (vtkAbstractArray *a, vtkIndent indent)
int WriteBinaryData (vtkAbstractArray *a)
int WriteBinaryDataInternal (vtkAbstractArray *a, OffsetType data_size)
void WriteArrayAppendedData (vtkAbstractArray *a, OffsetType pos, OffsetType &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)
virtual vtkAbstractArrayCreateArrayForPoints (vtkAbstractArray *inArray)
virtual vtkAbstractArrayCreateArrayForCells (vtkAbstractArray *inArray)
virtual vtkDataArrayCreateExactCoordinates (vtkDataArray *inArray, int xyz)
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=0)
void WritePCoordinates (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
int WriteBinaryDataInternal (void *data, OffsetType numWords, int wordType)
int WriteBinaryDataBlock (unsigned char *in_data, OffsetType numWords, int wordType)
void PerformByteSwap (void *data, OffsetType numWords, int wordSize)
int CreateCompressionHeader (OffsetType size)
int WriteCompressionBlock (unsigned char *data, OffsetType size)
int WriteCompressionHeader ()
OffsetType GetWordTypeSize (int dataType)
const char * GetWordTypeName (int dataType)
OffsetType GetOutputWordTypeSize (int dataType)
char ** CreateStringArray (int numStrings)
void DestroyStringArray (int numStrings, char **strings)
virtual void GetProgressRange (float *range)
virtual void SetProgressRange (float *range, int curStep, int numSteps)
virtual void SetProgressRange (float *range, int curStep, float *fractions)
virtual void SetProgressPartial (float fraction)
virtual void UpdateProgressDiscrete (float progress)
int OpenFile ()
void CloseFile ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
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)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
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)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

char * FileName
ostream * Stream
int ByteOrder
int IdType
int DataMode
int EncodeAppendedData
OffsetType AppendedDataPosition
OffsetsManagerGroupFieldDataOM
Int32IdType * Int32IdTypeBuffer
unsigned char * ByteSwapBuffer
vtkDataCompressorCompressor
unsigned int BlockSize
OffsetType CompressionBlockNumber
HeaderType * CompressionHeader
unsigned int CompressionHeaderLength
OffsetType CompressionHeaderPosition
vtkOutputStreamDataStream
float ProgressRange [2]
ofstream * OutFile
int TimeStep
int CurrentTimeIndex
int NumberOfTimeSteps
int TimeStepRange [2]
int UserContinueExecuting
unsigned long * NumberOfTimeValues
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Friends

class vtkXMLWriterHelper

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

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.

Definition at line 50 of file vtkXMLWriter.h.


Member Typedef Documentation

A type used for data sizes and offsets for stream i/o. Using vtkIdType should satisfy most users. This could be streamoff if it is deemed portable. It could also be split into OffsetType (streamoff) and PositionType (streampos).

Definition at line 69 of file vtkXMLWriter.h.


Member Enumeration Documentation

anonymous enum

Enumerate big and little endian byte order settings.

Enumerator:
BigEndian 
LittleEndian 

Definition at line 59 of file vtkXMLWriter.h.

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 78 of file vtkXMLWriter.h.

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 87 of file vtkXMLWriter.h.

Enumerator:
NONE 
ZLIB 

Definition at line 123 of file vtkXMLWriter.h.


Constructor & Destructor Documentation

vtkXMLWriter::vtkXMLWriter ( )
protected
vtkXMLWriter::~vtkXMLWriter ( )
protected

Member Function Documentation

virtual const char* vtkXMLWriter::GetClassName ( )
virtual
static int vtkXMLWriter::IsTypeOf ( const char *  name)
static
virtual int vtkXMLWriter::IsA ( const char *  name)
virtual
static vtkXMLWriter* vtkXMLWriter::SafeDownCast ( vtkObject o)
static
void vtkXMLWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
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.

virtual int vtkXMLWriter::GetByteOrder ( )
virtual

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

void vtkXMLWriter::SetByteOrderToBigEndian ( )

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

void vtkXMLWriter::SetByteOrderToLittleEndian ( )

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

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.

virtual int vtkXMLWriter::GetIdType ( )
virtual

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

void vtkXMLWriter::SetIdTypeToInt32 ( )

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

void vtkXMLWriter::SetIdTypeToInt64 ( )

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

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

Get/Set the name of the output file.

virtual char* vtkXMLWriter::GetFileName ( )
virtual

Get/Set the name of the output file.

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.

virtual vtkDataCompressor* vtkXMLWriter::GetCompressor ( )
virtual

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

void vtkXMLWriter::SetCompressorType ( int  compressorType)

Convenience functions to set the compressor to certain known types.

void vtkXMLWriter::SetCompressorTypeToNone ( )
inline

Convenience functions to set the compressor to certain known types.

Definition at line 133 of file vtkXMLWriter.h.

void vtkXMLWriter::SetCompressorTypeToZLib ( )
inline

Convenience functions to set the compressor to certain known types.

Definition at line 137 of file vtkXMLWriter.h.

virtual void vtkXMLWriter::SetBlockSize ( unsigned int  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.

virtual unsigned int vtkXMLWriter::GetBlockSize ( )
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.

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.

virtual int vtkXMLWriter::GetDataMode ( )
virtual

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

void vtkXMLWriter::SetDataModeToAscii ( )

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

void vtkXMLWriter::SetDataModeToBinary ( )

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

void vtkXMLWriter::SetDataModeToAppended ( )

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

virtual void vtkXMLWriter::SetEncodeAppendedData ( int  )
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.

virtual int vtkXMLWriter::GetEncodeAppendedData ( )
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.

virtual void vtkXMLWriter::EncodeAppendedDataOn ( )
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.

virtual void vtkXMLWriter::EncodeAppendedDataOff ( )
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.

void vtkXMLWriter::SetInput ( vtkDataObject )

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

void vtkXMLWriter::SetInput ( int  ,
vtkDataObject  
)

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

vtkDataObject* vtkXMLWriter::GetInput ( int  port)

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

vtkDataObject* vtkXMLWriter::GetInput ( )
inline
virtual const char* vtkXMLWriter::GetDefaultFileExtension ( )
pure virtual
int vtkXMLWriter::Write ( )

Invoke the writer. Returns 1 for success, 0 for failure.

virtual int vtkXMLWriter::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
virtual

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.

Reimplemented in vtkXMLStructuredDataWriter, vtkXMLCompositeDataWriter, vtkXMLUnstructuredDataWriter, and vtkXMLPUnstructuredDataWriter.

virtual void vtkXMLWriter::SetTimeStep ( int  )
virtual

Which TimeStep to write.

virtual int vtkXMLWriter::GetTimeStep ( )
virtual

Which TimeStep to write.

virtual int* vtkXMLWriter::GetTimeStepRange ( )
virtual

Which TimeStepRange to write.

virtual void vtkXMLWriter::GetTimeStepRange ( int &  ,
int &   
)
virtual

Which TimeStepRange to write.

virtual void vtkXMLWriter::GetTimeStepRange ( int  [2])
virtual

Which TimeStepRange to write.

virtual void vtkXMLWriter::SetTimeStepRange ( int  ,
int   
)
virtual

Which TimeStepRange to write.

void vtkXMLWriter::SetTimeStepRange ( int  [2])

Which TimeStepRange to write.

virtual int vtkXMLWriter::GetNumberOfTimeSteps ( )
virtual

Set the number of time steps

virtual void vtkXMLWriter::SetNumberOfTimeSteps ( int  )
virtual

Set the number of time steps

void vtkXMLWriter::Start ( )

API to interface an outside the VTK pipeline control

void vtkXMLWriter::Stop ( )

API to interface an outside the VTK pipeline control

void vtkXMLWriter::WriteNextTime ( double  time)

API to interface an outside the VTK pipeline control

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

Reimplemented in vtkXMLCompositeDataWriter.

virtual void vtkXMLWriter::SetDataStream ( vtkOutputStream )
protectedvirtual
virtual vtkOutputStream* vtkXMLWriter::GetDataStream ( )
protectedvirtual
virtual int vtkXMLWriter::WriteInternal ( )
protectedvirtual
virtual int vtkXMLWriter::WriteData ( )
inlineprotectedvirtual

Reimplemented in vtkXMLCompositeDataWriter, vtkXMLPDataWriter, and vtkXMLHyperOctreeWriter.

Definition at line 313 of file vtkXMLWriter.h.

virtual const char* vtkXMLWriter::GetDataSetName ( )
protectedpure virtual
virtual int vtkXMLWriter::GetDataSetMajorVersion ( )
protectedvirtual

Reimplemented in vtkXMLCompositeDataWriter.

virtual int vtkXMLWriter::GetDataSetMinorVersion ( )
protectedvirtual

Reimplemented in vtkXMLCompositeDataWriter.

vtkDataSet* vtkXMLWriter::GetInputAsDataSet ( )
protected
int vtkXMLWriter::StartFile ( )
protected
virtual void vtkXMLWriter::WriteFileAttributes ( )
protectedvirtual
int vtkXMLWriter::EndFile ( )
protected
void vtkXMLWriter::DeleteAFile ( )
protected
void vtkXMLWriter::DeleteAFile ( const char *  name)
protected
virtual int vtkXMLWriter::WritePrimaryElement ( ostream &  os,
vtkIndent  indent 
)
protectedvirtual
virtual void vtkXMLWriter::WritePrimaryElementAttributes ( ostream &  os,
vtkIndent  indent 
)
protectedvirtual
void vtkXMLWriter::StartAppendedData ( )
protected
void vtkXMLWriter::EndAppendedData ( )
protected
OffsetType vtkXMLWriter::ReserveAttributeSpace ( const char *  attr,
int  length = 20 
)
protected
OffsetType vtkXMLWriter::GetAppendedDataOffset ( )
protected
OffsetType vtkXMLWriter::WriteAppendedDataOffset ( OffsetType  streamPos,
OffsetType lastoffset,
const char *  attr = 0 
)
protected
OffsetType vtkXMLWriter::ForwardAppendedDataOffset ( OffsetType  streamPos,
OffsetType  offset,
const char *  attr = 0 
)
protected
OffsetType vtkXMLWriter::ForwardAppendedDataDouble ( OffsetType  streamPos,
double  value,
const char *  attr 
)
protected
int vtkXMLWriter::WriteScalarAttribute ( const char *  name,
int  data 
)
protected
int vtkXMLWriter::WriteScalarAttribute ( const char *  name,
float  data 
)
protected
int vtkXMLWriter::WriteScalarAttribute ( const char *  name,
double  data 
)
protected
int vtkXMLWriter::WriteVectorAttribute ( const char *  name,
int  length,
int *  data 
)
protected
int vtkXMLWriter::WriteVectorAttribute ( const char *  name,
int  length,
float *  data 
)
protected
int vtkXMLWriter::WriteVectorAttribute ( const char *  name,
int  length,
double *  data 
)
protected
int vtkXMLWriter::WriteDataModeAttribute ( const char *  name)
protected
int vtkXMLWriter::WriteWordTypeAttribute ( const char *  name,
int  dataType 
)
protected
int vtkXMLWriter::WriteStringAttribute ( const char *  name,
const char *  value 
)
protected
void vtkXMLWriter::WriteArrayHeader ( vtkAbstractArray a,
vtkIndent  indent,
const char *  alternateName,
int  writeNumTuples,
int  timestep 
)
protected
void vtkXMLWriter::WriteArrayFooter ( ostream &  os,
vtkIndent  indent,
vtkAbstractArray a,
int  shortFormat 
)
protected
void vtkXMLWriter::WriteArrayInline ( vtkAbstractArray a,
vtkIndent  indent,
const char *  alternateName = 0,
int  writeNumTuples = 0 
)
protected
void vtkXMLWriter::WriteInlineData ( vtkAbstractArray a,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WriteArrayAppended ( vtkAbstractArray a,
vtkIndent  indent,
OffsetsManager offs,
const char *  alternateName = 0,
int  writeNumTuples = 0,
int  timestep = 0 
)
protected
int vtkXMLWriter::WriteAsciiData ( vtkAbstractArray a,
vtkIndent  indent 
)
protected
int vtkXMLWriter::WriteBinaryData ( vtkAbstractArray a)
protected
int vtkXMLWriter::WriteBinaryDataInternal ( vtkAbstractArray a,
OffsetType  data_size 
)
protected
void vtkXMLWriter::WriteArrayAppendedData ( vtkAbstractArray a,
OffsetType  pos,
OffsetType lastoffset 
)
protected
void vtkXMLWriter::WriteFieldData ( vtkIndent  indent)
protected
void vtkXMLWriter::WriteFieldDataInline ( vtkFieldData fd,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WritePointDataInline ( vtkPointData pd,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WriteCellDataInline ( vtkCellData cd,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WriteFieldDataAppended ( vtkFieldData fd,
vtkIndent  indent,
OffsetsManagerGroup fdManager 
)
protected
void vtkXMLWriter::WriteFieldDataAppendedData ( vtkFieldData fd,
int  timestep,
OffsetsManagerGroup fdManager 
)
protected
void vtkXMLWriter::WritePointDataAppended ( vtkPointData pd,
vtkIndent  indent,
OffsetsManagerGroup pdManager 
)
protected
void vtkXMLWriter::WritePointDataAppendedData ( vtkPointData pd,
int  timestep,
OffsetsManagerGroup pdManager 
)
protected
void vtkXMLWriter::WriteCellDataAppended ( vtkCellData cd,
vtkIndent  indent,
OffsetsManagerGroup cdManager 
)
protected
void vtkXMLWriter::WriteCellDataAppendedData ( vtkCellData cd,
int  timestep,
OffsetsManagerGroup cdManager 
)
protected
void vtkXMLWriter::WriteAttributeIndices ( vtkDataSetAttributes dsa,
char **  names 
)
protected
void vtkXMLWriter::WritePointsAppended ( vtkPoints points,
vtkIndent  indent,
OffsetsManager manager 
)
protected
void vtkXMLWriter::WritePointsAppendedData ( vtkPoints points,
int  timestep,
OffsetsManager pdManager 
)
protected
void vtkXMLWriter::WritePointsInline ( vtkPoints points,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WriteCoordinatesInline ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WriteCoordinatesAppended ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
vtkIndent  indent,
OffsetsManagerGroup coordManager 
)
protected
void vtkXMLWriter::WriteCoordinatesAppendedData ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
int  timestep,
OffsetsManagerGroup coordManager 
)
protected
virtual vtkAbstractArray* vtkXMLWriter::CreateArrayForPoints ( vtkAbstractArray inArray)
protectedvirtual

Reimplemented in vtkXMLStructuredDataWriter.

virtual vtkAbstractArray* vtkXMLWriter::CreateArrayForCells ( vtkAbstractArray inArray)
protectedvirtual

Reimplemented in vtkXMLStructuredDataWriter.

virtual vtkDataArray* vtkXMLWriter::CreateExactCoordinates ( vtkDataArray inArray,
int  xyz 
)
protectedvirtual

Reimplemented in vtkXMLRectilinearGridWriter.

void vtkXMLWriter::WritePPointData ( vtkPointData pd,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WritePCellData ( vtkCellData cd,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WritePPoints ( vtkPoints points,
vtkIndent  indent 
)
protected
void vtkXMLWriter::WritePArray ( vtkAbstractArray a,
vtkIndent  indent,
const char *  alternateName = 0 
)
protected
void vtkXMLWriter::WritePCoordinates ( vtkDataArray xc,
vtkDataArray yc,
vtkDataArray zc,
vtkIndent  indent 
)
protected
int vtkXMLWriter::WriteBinaryDataInternal ( void *  data,
OffsetType  numWords,
int  wordType 
)
protected
int vtkXMLWriter::WriteBinaryDataBlock ( unsigned char *  in_data,
OffsetType  numWords,
int  wordType 
)
protected
void vtkXMLWriter::PerformByteSwap ( void *  data,
OffsetType  numWords,
int  wordSize 
)
protected
int vtkXMLWriter::CreateCompressionHeader ( OffsetType  size)
protected
int vtkXMLWriter::WriteCompressionBlock ( unsigned char *  data,
OffsetType  size 
)
protected
int vtkXMLWriter::WriteCompressionHeader ( )
protected
OffsetType vtkXMLWriter::GetWordTypeSize ( int  dataType)
protected
const char* vtkXMLWriter::GetWordTypeName ( int  dataType)
protected
OffsetType vtkXMLWriter::GetOutputWordTypeSize ( int  dataType)
protected
char** vtkXMLWriter::CreateStringArray ( int  numStrings)
protected
void vtkXMLWriter::DestroyStringArray ( int  numStrings,
char **  strings 
)
protected
virtual void vtkXMLWriter::GetProgressRange ( float *  range)
protectedvirtual
virtual void vtkXMLWriter::SetProgressRange ( float *  range,
int  curStep,
int  numSteps 
)
protectedvirtual
virtual void vtkXMLWriter::SetProgressRange ( float *  range,
int  curStep,
float *  fractions 
)
protectedvirtual
virtual void vtkXMLWriter::SetProgressPartial ( float  fraction)
protectedvirtual
virtual void vtkXMLWriter::UpdateProgressDiscrete ( float  progress)
protectedvirtual
int vtkXMLWriter::OpenFile ( )
protected
void vtkXMLWriter::CloseFile ( )
protected

Friends And Related Function Documentation

friend class vtkXMLWriterHelper
friend

Definition at line 470 of file vtkXMLWriter.h.


Member Data Documentation

char* vtkXMLWriter::FileName
protected

Definition at line 232 of file vtkXMLWriter.h.

ostream* vtkXMLWriter::Stream
protected

Definition at line 235 of file vtkXMLWriter.h.

int vtkXMLWriter::ByteOrder
protected

Definition at line 238 of file vtkXMLWriter.h.

int vtkXMLWriter::IdType
protected

Definition at line 241 of file vtkXMLWriter.h.

int vtkXMLWriter::DataMode
protected

Definition at line 245 of file vtkXMLWriter.h.

int vtkXMLWriter::EncodeAppendedData
protected

Definition at line 248 of file vtkXMLWriter.h.

OffsetType vtkXMLWriter::AppendedDataPosition
protected

Definition at line 251 of file vtkXMLWriter.h.

OffsetsManagerGroup* vtkXMLWriter::FieldDataOM
protected

Definition at line 254 of file vtkXMLWriter.h.

Int32IdType* vtkXMLWriter::Int32IdTypeBuffer
protected

Definition at line 287 of file vtkXMLWriter.h.

unsigned char* vtkXMLWriter::ByteSwapBuffer
protected

Definition at line 290 of file vtkXMLWriter.h.

vtkDataCompressor* vtkXMLWriter::Compressor
protected

Definition at line 293 of file vtkXMLWriter.h.

unsigned int vtkXMLWriter::BlockSize
protected

Definition at line 294 of file vtkXMLWriter.h.

OffsetType vtkXMLWriter::CompressionBlockNumber
protected

Definition at line 295 of file vtkXMLWriter.h.

HeaderType* vtkXMLWriter::CompressionHeader
protected

Definition at line 296 of file vtkXMLWriter.h.

unsigned int vtkXMLWriter::CompressionHeaderLength
protected

Definition at line 297 of file vtkXMLWriter.h.

OffsetType vtkXMLWriter::CompressionHeaderPosition
protected

Definition at line 298 of file vtkXMLWriter.h.

vtkOutputStream* vtkXMLWriter::DataStream
protected

Definition at line 302 of file vtkXMLWriter.h.

float vtkXMLWriter::ProgressRange[2]
protected

Definition at line 450 of file vtkXMLWriter.h.

ofstream* vtkXMLWriter::OutFile
protected

Definition at line 452 of file vtkXMLWriter.h.

int vtkXMLWriter::TimeStep
protected

Definition at line 458 of file vtkXMLWriter.h.

int vtkXMLWriter::CurrentTimeIndex
protected

Definition at line 459 of file vtkXMLWriter.h.

int vtkXMLWriter::NumberOfTimeSteps
protected

Definition at line 460 of file vtkXMLWriter.h.

int vtkXMLWriter::TimeStepRange[2]
protected

Definition at line 462 of file vtkXMLWriter.h.

int vtkXMLWriter::UserContinueExecuting
protected

Definition at line 466 of file vtkXMLWriter.h.

unsigned long* vtkXMLWriter::NumberOfTimeValues
protected

Definition at line 468 of file vtkXMLWriter.h.


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