Abstract base class for VTK-XML writers. More...

#include <vtkXMLWriterBase.h>

Inheritance diagram for vtkXMLWriterBase:

Collaboration diagram for vtkXMLWriterBase:

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.

vtkXMLWriterBase *	NewInstance () const

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

virtual const char *	GetDefaultFileExtension ()=0
	Get the default file extension for files written by this writer.

int	Write ()
	Invoke the writer.


virtual void	SetByteOrder (int)
	Get/Set the byte order of data written to the file.

virtual int	GetByteOrder ()
	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.


virtual void	SetHeaderType (int)
	Get/Set the binary data header word type.

virtual int	GetHeaderType ()
	Get/Set the binary data header word type.

void	SetHeaderTypeToUInt32 ()
	Get/Set the binary data header word type.

void	SetHeaderTypeToUInt64 ()
	Get/Set the binary data header word type.


virtual void	SetIdType (int)
	Get/Set the size of the vtkIdType values stored in the file.

virtual int	GetIdType ()
	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.


	vtkSetFilePathMacro (FileName)
	Get/Set the name of the output file.

	vtkGetFilePathMacro (FileName)
	Get/Set the name of the output file.


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

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

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

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

std::string	GetOutputString ()
	Enable writing to an OutputString instead of the default, a file.


virtual void	SetCompressor (vtkDataCompressor *)
	Get/Set the compressor used to compress binary and appended data before writing to the file.

virtual vtkDataCompressor *	GetCompressor ()
	Get/Set the compressor used to compress binary and appended data before writing to the file.


void	SetCompressorType (int compressorType)
	Convenience functions to set the compressor to certain known types.

void	SetCompressorTypeToNone ()
	Convenience functions to set the compressor to certain known types.

void	SetCompressorTypeToLZ4 ()
	Convenience functions to set the compressor to certain known types.

void	SetCompressorTypeToZLib ()
	Convenience functions to set the compressor to certain known types.

void	SetCompressorTypeToLZMA ()
	Convenience functions to set the compressor to certain known types.


void	SetCompressionLevel (int compressorLevel)
	Get/Set compression level.

virtual int	GetCompressionLevel ()
	Get/Set compression level.


virtual void	SetBlockSize (size_t blockSize)
	Get/Set the block size used in compression.

virtual size_t	GetBlockSize ()
	Get/Set the block size used in compression.


virtual void	SetDataMode (int)
	Get/Set the data mode used for the file's data.

virtual int	GetDataMode ()
	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	SetDataModeToAppended ()
	Get/Set the data mode used for the file's data.


virtual void	SetEncodeAppendedData (bool)
	Get/Set whether the appended data section is base64 encoded.

virtual bool	GetEncodeAppendedData ()
	Get/Set whether the appended data section is base64 encoded.

virtual void	EncodeAppendedDataOn ()
	Get/Set whether the appended data section is base64 encoded.

virtual void	EncodeAppendedDataOff ()
	Get/Set whether the appended data section is base64 encoded.

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

vtkAlgorithm *	NewInstance () const

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

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

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

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

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

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

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.

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.

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

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

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

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

void	SetProgress (double)
	`SetProgress` is deprecated.

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

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

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

void	RemoveAllInputs ()
	Remove all the input data.

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

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

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

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

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

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

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

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

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

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

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.

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

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.

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

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

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

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

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

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

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

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

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

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

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

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

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

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

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

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

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

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

static vtkXMLWriterBase *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

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

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

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

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

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

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

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLWriterBase ()

	~vtkXMLWriterBase () override

virtual int	GetDataSetMajorVersion ()

virtual int	GetDataSetMinorVersion ()

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

	vtkAlgorithm ()

	~vtkAlgorithm () override

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

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

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

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

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.

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

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

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

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

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

void	AddInputDataInternal (int port, vtkDataObject *input)

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

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

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

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

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

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

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

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

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

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

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

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

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

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

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

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.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName

bool	WriteToOutputString

std::string	OutputString

int	ByteOrder

int	HeaderType

int	IdType

int	DataMode

bool	EncodeAppendedData

vtkDataCompressor *	Compressor

size_t	BlockSize

int	CompressionLevel

bool	UsePreviousVersion

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Abstract base class for VTK-XML writers.

vtkXMLWriterBase class was created to help refactor XML writers (vtkXMLWriter and subclasses). Get/Set API on vtkXMLWriter is moved here while all the gory implementation details are left in vtkXMLWriter. This enables use to create a sibling hierarchy to vtkXMLWriter that uses a cleaner design to implement the IO capabilities. Eventually, we vtkXMLWriter and its children will be substituted by a parallel hierarchy at which point this class may merge with it's new subclass.

Definition at line 38 of file vtkXMLWriterBase.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAlgorithm vtkXMLWriterBase::Superclass

Definition at line 41 of file vtkXMLWriterBase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerate big and little endian byte order settings.

Enumerator
BigEndian
LittleEndian

Definition at line 47 of file vtkXMLWriterBase.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 59 of file vtkXMLWriterBase.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 71 of file vtkXMLWriterBase.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 82 of file vtkXMLWriterBase.h.

◆ CompressorType

enum vtkXMLWriterBase::CompressorType

Enumerator
NONE
ZLIB
LZ4
LZMA

Definition at line 148 of file vtkXMLWriterBase.h.

Constructor & Destructor Documentation

◆ vtkXMLWriterBase()

vtkXMLWriterBase::vtkXMLWriterBase ( )

protected

◆ ~vtkXMLWriterBase()

vtkXMLWriterBase::~vtkXMLWriterBase ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPhyloXMLTreeWriter, vtkXMLDataWriterHelper, vtkXMLPartitionedDataSetCollectionWriter, vtkXMLPartitionedDataSetWriter, vtkXMLPDataObjectWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLPHyperTreeGridWriter, vtkXMLPImageDataWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPPartitionedDataSetWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPTableWriter, vtkXMLPUniformGridAMRWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLWriter2, vtkXMLCompositeDataWriter, vtkXMLDataObjectWriter, vtkXMLDataSetWriter, vtkXMLHierarchicalBoxDataWriter, vtkXMLHyperTreeGridWriter, vtkXMLImageDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPolyDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLTableWriter, vtkXMLUniformGridAMRWriter, vtkXMLUnstructuredDataWriter, vtkXMLUnstructuredGridWriter, and vtkXMLWriter.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLWriterBase::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPhyloXMLTreeWriter, vtkXMLDataWriterHelper, vtkXMLPartitionedDataSetCollectionWriter, vtkXMLPartitionedDataSetWriter, vtkXMLPDataObjectWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLPHyperTreeGridWriter, vtkXMLPImageDataWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPPartitionedDataSetWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPTableWriter, vtkXMLPUniformGridAMRWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLWriter2, vtkXMLCompositeDataWriter, vtkXMLDataObjectWriter, vtkXMLDataSetWriter, vtkXMLHierarchicalBoxDataWriter, vtkXMLHyperTreeGridWriter, vtkXMLImageDataWriter, vtkXMLMultiBlockDataWriter, vtkXMLPolyDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLTableWriter, vtkXMLUniformGridAMRWriter, vtkXMLUnstructuredDataWriter, vtkXMLUnstructuredGridWriter, and vtkXMLWriter.

◆ NewInstance()

vtkXMLWriterBase * vtkXMLWriterBase::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLWriterBase::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 vtkXMLWriterBase::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 vtkXMLWriterBase::GetByteOrder ( )

virtual

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

The default is the machine's hardware byte order.

◆ SetByteOrderToBigEndian()

void vtkXMLWriterBase::SetByteOrderToBigEndian ( )

inline

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

The default is the machine's hardware byte order.

Definition at line 95 of file vtkXMLWriterBase.h.

◆ SetByteOrderToLittleEndian()

void vtkXMLWriterBase::SetByteOrderToLittleEndian ( )

inline

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

The default is the machine's hardware byte order.

Definition at line 96 of file vtkXMLWriterBase.h.

◆ SetHeaderType()

virtual void vtkXMLWriterBase::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 vtkXMLWriterBase::GetHeaderType ( )

virtual

Get/Set the binary data header word type.

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

◆ SetHeaderTypeToUInt32()

void vtkXMLWriterBase::SetHeaderTypeToUInt32 ( )

inline

Get/Set the binary data header word type.

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

Definition at line 106 of file vtkXMLWriterBase.h.

◆ SetHeaderTypeToUInt64()

void vtkXMLWriterBase::SetHeaderTypeToUInt64 ( )

inline

Get/Set the binary data header word type.

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

Definition at line 107 of file vtkXMLWriterBase.h.

◆ SetIdType()

virtual void vtkXMLWriterBase::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 vtkXMLWriterBase::GetIdType ( )

virtual

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

The default is the real size of vtkIdType.

◆ SetIdTypeToInt32()

void vtkXMLWriterBase::SetIdTypeToInt32 ( )

inline

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

The default is the real size of vtkIdType.

Definition at line 117 of file vtkXMLWriterBase.h.

◆ SetIdTypeToInt64()

void vtkXMLWriterBase::SetIdTypeToInt64 ( )

inline

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

The default is the real size of vtkIdType.

Definition at line 118 of file vtkXMLWriterBase.h.

◆ vtkSetFilePathMacro()

vtkXMLWriterBase::vtkSetFilePathMacro ( FileName )

Get/Set the name of the output file.

◆ vtkGetFilePathMacro()

vtkXMLWriterBase::vtkGetFilePathMacro ( FileName )

Get/Set the name of the output file.