vtk
Class vtkXMLWriter

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkProcessObject
              vtk.vtkXMLWriter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

vtkXMLDataSetWriter, vtkXMLPDataWriter, vtkXMLStructuredDataWriter, vtkXMLUnstructuredDataWriter

public class vtkXMLWriter

extends vtkProcessObject

implements java.io.Serializable

vtkXMLWriter - 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. JavaBean wrapper for vtkXMLWriter object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkXMLWriter()
protected	vtkXMLWriter(int dmy)

Method Summary

void	encodeAppendedDataOff() Get/Set whether the appended data section is base64 encoded.
void	encodeAppendedDataOn() Get/Set whether the appended data section is base64 encoded.
int	getBlockSize() Get/Set the block size used in compression.
int	getByteOrder() Get/Set the byte order of data written to the file.
java.lang.String	getClassName() Return the class name as a string.
vtkDataCompressor	getCompressor() Get/Set the compressor used to compress binary and appended data before writing to the file.
int	getDataMode() Get/Set the data mode used for the file's data.
java.lang.String	getDefaultFileExtension() Get the default file extension for files written by this writer.
int	getEncodeAppendedData() Get/Set whether the appended data section is base64 encoded.
java.lang.String	getFileName() Get/Set the name of the output file.
int	getIdType() Get/Set the size of the vtkIdType values stored in the file.
vtkXMLWriter	getThisXMLWriter()
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setBlockSize(int id0) Get/Set the block size used in compression.
void	setByteOrder(int id0) Get/Set the byte order of data written to the file.
void	setByteOrderToBigEndian() Get/Set the byte order of data written to the file.
void	setByteOrderToLittleEndian() Get/Set the byte order of data written to the file.
void	setCompressor(vtkDataCompressor id0) Get/Set the compressor used to compress binary and appended data before writing to the file.
void	setDataMode(int id0) Get/Set the data mode used for the file's data.
void	setDataModeToAppended() Get/Set the data mode used for the file's data.
void	setDataModeToAscii() Get/Set the data mode used for the file's data.
void	setDataModeToBinary() Get/Set the data mode used for the file's data.
void	setEncodeAppendedData(int id0) Get/Set whether the appended data section is base64 encoded.
void	setFileName(java.lang.String id0) Get/Set the name of the output file.
void	setIdType(int id0) Get/Set the size of the vtkIdType values stored in the file.
void	setIdTypeToInt32() Get/Set the size of the vtkIdType values stored in the file.
void	setIdTypeToInt64() Get/Set the size of the vtkIdType values stored in the file.
protected void	VTKCastInit()
int	write() Invoke the writer.

Methods inherited from class vtk.vtkProcessObject

abortExecuteOff, abortExecuteOn, getAbortExecute, getErrorCode, getNumberOfInputs, getProgress, getProgressMaxValue, getProgressMinValue, getProgressText, getThisProcessObject, removeAllInputs, setAbortExecute, setProgress, setProgressText, squeezeInputArray, updateProgress

Methods inherited from class vtk.vtkObject

AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getMTime, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister, VTKInit

Methods inherited from class vtk.vtkObjectBase

addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changes

protected java.beans.PropertyChangeSupport changes

Constructor Detail

vtkXMLWriter

public vtkXMLWriter()

vtkXMLWriter

protected vtkXMLWriter(int dmy)

Method Detail

getThisXMLWriter

public vtkXMLWriter getThisXMLWriter()

getClassName

public java.lang.String getClassName()

Description copied from class: vtkObjectBase

Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

getClassName in class vtkProcessObject

isA

public int isA(java.lang.String id0)

Description copied from class: vtkObjectBase

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

isA in class vtkProcessObject

setByteOrder

public void setByteOrder(int id0)

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

getByteOrder

public int getByteOrder()

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

setByteOrderToBigEndian

public void setByteOrderToBigEndian()

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

setByteOrderToLittleEndian

public void setByteOrderToLittleEndian()

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

setIdType

public void setIdType(int id0)

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

getIdType

public int getIdType()

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

setIdTypeToInt32

public void setIdTypeToInt32()

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

setIdTypeToInt64

public void setIdTypeToInt64()

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

setFileName

public void setFileName(java.lang.String id0)

Get/Set the name of the output file.

getFileName

public java.lang.String getFileName()

Get/Set the name of the output file.

setCompressor

public void setCompressor(vtkDataCompressor id0)

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

getCompressor

public vtkDataCompressor getCompressor()

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

setBlockSize

public void setBlockSize(int id0)

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

public int getBlockSize()

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.

setDataMode

public void setDataMode(int id0)

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

getDataMode

public int getDataMode()

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

setDataModeToAscii

public void setDataModeToAscii()

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

setDataModeToBinary

public void setDataModeToBinary()

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

setDataModeToAppended

public void setDataModeToAppended()

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

setEncodeAppendedData

public void setEncodeAppendedData(int id0)

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

public int getEncodeAppendedData()

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.

encodeAppendedDataOn

public void encodeAppendedDataOn()

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.

encodeAppendedDataOff

public void encodeAppendedDataOff()

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.

getDefaultFileExtension

public java.lang.String getDefaultFileExtension()

Get the default file extension for files written by this writer.

write

public int write()

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

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkProcessObject