VTK  9.0.20210616
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXMLWriterBase Class Referenceabstract

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

#include <vtkXMLWriterBase.h>

Inheritance diagram for vtkXMLWriterBase:
[legend]
Collaboration diagram for vtkXMLWriterBase:
[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...
 
vtkXMLWriterBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual const char * GetDefaultFileExtension ()=0
 Get the default file extension for files written by this writer. More...
 
int Write ()
 Invoke the writer. More...
 
virtual void SetByteOrder (int)
 Get/Set the byte order of data written to the file. More...
 
virtual int GetByteOrder ()
 Get/Set the byte order of data written to the file. More...
 
void SetByteOrderToBigEndian ()
 Get/Set the byte order of data written to the file. More...
 
void SetByteOrderToLittleEndian ()
 Get/Set the byte order of data written to the file. More...
 
virtual void SetHeaderType (int)
 Get/Set the binary data header word type. More...
 
virtual int GetHeaderType ()
 Get/Set the binary data header word type. More...
 
void SetHeaderTypeToUInt32 ()
 Get/Set the binary data header word type. More...
 
void SetHeaderTypeToUInt64 ()
 Get/Set the binary data header word type. More...
 
virtual void SetIdType (int)
 Get/Set the size of the vtkIdType values stored in the file. More...
 
virtual int GetIdType ()
 Get/Set the size of the vtkIdType values stored in the file. More...
 
void SetIdTypeToInt32 ()
 Get/Set the size of the vtkIdType values stored in the file. More...
 
void SetIdTypeToInt64 ()
 Get/Set the size of the vtkIdType values stored in the file. More...
 
virtual void SetFileName (const char *)
 Get/Set the name of the output file. More...
 
virtual char * GetFileName ()
 Get/Set the name of the output file. More...
 
virtual void SetWriteToOutputString (bool)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual bool GetWriteToOutputString ()
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual void WriteToOutputStringOn ()
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual void WriteToOutputStringOff ()
 Enable writing to an OutputString instead of the default, a file. More...
 
std::string GetOutputString ()
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual void SetCompressor (vtkDataCompressor *)
 Get/Set the compressor used to compress binary and appended data before writing to the file. More...
 
virtual vtkDataCompressorGetCompressor ()
 Get/Set the compressor used to compress binary and appended data before writing to the file. More...
 
void SetCompressorType (int compressorType)
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressorTypeToNone ()
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressorTypeToLZ4 ()
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressorTypeToZLib ()
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressorTypeToLZMA ()
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressionLevel (int compressorLevel)
 Get/Set compression level. More...
 
virtual int GetCompressionLevel ()
 Get/Set compression level. More...
 
virtual void SetBlockSize (size_t blockSize)
 Get/Set the block size used in compression. More...
 
virtual size_t GetBlockSize ()
 Get/Set the block size used in compression. More...
 
virtual void SetDataMode (int)
 Get/Set the data mode used for the file's data. More...
 
virtual int GetDataMode ()
 Get/Set the data mode used for the file's data. More...
 
void SetDataModeToAscii ()
 Get/Set the data mode used for the file's data. More...
 
void SetDataModeToBinary ()
 Get/Set the data mode used for the file's data. More...
 
void SetDataModeToAppended ()
 Get/Set the data mode used for the file's data. More...
 
virtual void SetEncodeAppendedData (bool)
 Get/Set whether the appended data section is base64 encoded. More...
 
virtual bool GetEncodeAppendedData ()
 Get/Set whether the appended data section is base64 encoded. More...
 
virtual void EncodeAppendedDataOn ()
 Get/Set whether the appended data section is base64 encoded. More...
 
virtual void EncodeAppendedDataOff ()
 Get/Set whether the appended data section is base64 encoded. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. 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...
 
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 SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual 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 vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a 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 ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual 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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLWriterBaseSafeDownCast (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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLWriterBase ()
 
 ~vtkXMLWriterBase () override
 
virtual int GetDataSetMajorVersion ()
 
virtual int GetDataSetMinorVersion ()
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 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
 
vtkDataCompressorCompressor
 
size_t BlockSize
 
int CompressionLevel
 
bool UsePreviousVersion
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
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 vtkInformationIntegerKeyPORT_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 vtkExecutiveDefaultExecutivePrototype
 

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

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

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLWriterBase::NewInstanceInternal ( ) const
protectedvirtual

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

◆ SetFileName()

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

Get/Set the name of the output file.

◆ GetFileName()

virtual char* vtkXMLWriterBase::GetFileName ( )
virtual

Get/Set the name of the output file.

◆ SetWriteToOutputString()

virtual void vtkXMLWriterBase::SetWriteToOutputString ( bool  )
virtual

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

◆ GetWriteToOutputString()

virtual bool vtkXMLWriterBase::GetWriteToOutputString ( )
virtual

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

◆ WriteToOutputStringOn()

virtual void vtkXMLWriterBase::WriteToOutputStringOn ( )
virtual

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

◆ WriteToOutputStringOff()

virtual void vtkXMLWriterBase::WriteToOutputStringOff ( )
virtual

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

◆ GetOutputString()

std::string vtkXMLWriterBase::GetOutputString ( )
inline

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

Definition at line 136 of file vtkXMLWriterBase.h.

◆ SetCompressor()

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

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

Default is a vtkZLibDataCompressor.

◆ SetCompressorType()

void vtkXMLWriterBase::SetCompressorType ( int  compressorType)

Convenience functions to set the compressor to certain known types.

◆ SetCompressorTypeToNone()

void vtkXMLWriterBase::SetCompressorTypeToNone ( )
inline

Convenience functions to set the compressor to certain known types.

Definition at line 161 of file vtkXMLWriterBase.h.

◆ SetCompressorTypeToLZ4()

void vtkXMLWriterBase::SetCompressorTypeToLZ4 ( )
inline

Convenience functions to set the compressor to certain known types.

Definition at line 162 of file vtkXMLWriterBase.h.

◆ SetCompressorTypeToZLib()

void vtkXMLWriterBase::SetCompressorTypeToZLib ( )
inline

Convenience functions to set the compressor to certain known types.

Definition at line 163 of file vtkXMLWriterBase.h.

◆ SetCompressorTypeToLZMA()

void vtkXMLWriterBase::SetCompressorTypeToLZMA ( )
inline

Convenience functions to set the compressor to certain known types.

Definition at line 164 of file vtkXMLWriterBase.h.

◆ SetCompressionLevel()

void vtkXMLWriterBase::SetCompressionLevel ( int  compressorLevel)

Get/Set compression level.

1 (worst compression, fastest) ... 9 (best compression, slowest).

◆ GetCompressionLevel()

virtual int vtkXMLWriterBase::GetCompressionLevel ( )
virtual

Get/Set compression level.

1 (worst compression, fastest) ... 9 (best compression, slowest).

◆ SetBlockSize()

virtual void vtkXMLWriterBase::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 vtkXMLWriterBase::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.

◆ SetDataMode()

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

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

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

◆ SetDataModeToAscii()

void vtkXMLWriterBase::SetDataModeToAscii ( )
inline

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

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

Definition at line 195 of file vtkXMLWriterBase.h.

◆ SetDataModeToBinary()

void vtkXMLWriterBase::SetDataModeToBinary ( )
inline

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

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

Definition at line 196 of file vtkXMLWriterBase.h.

◆ SetDataModeToAppended()

void vtkXMLWriterBase::SetDataModeToAppended ( )
inline

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

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

Definition at line 197 of file vtkXMLWriterBase.h.

◆ SetEncodeAppendedData()

virtual void vtkXMLWriterBase::SetEncodeAppendedData ( bool  )
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 bool vtkXMLWriterBase::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.

◆ EncodeAppendedDataOn()

virtual void vtkXMLWriterBase::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.

◆ EncodeAppendedDataOff()

virtual void vtkXMLWriterBase::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.

◆ GetDefaultFileExtension()

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

◆ Write()

int vtkXMLWriterBase::Write ( )

Invoke the writer.

Returns 1 for success, 0 for failure.

◆ GetDataSetMajorVersion()

virtual int vtkXMLWriterBase::GetDataSetMajorVersion ( )
protectedvirtual

◆ GetDataSetMinorVersion()

virtual int vtkXMLWriterBase::GetDataSetMinorVersion ( )
protectedvirtual

Member Data Documentation

◆ FileName

char* vtkXMLWriterBase::FileName
protected

Definition at line 232 of file vtkXMLWriterBase.h.

◆ WriteToOutputString

bool vtkXMLWriterBase::WriteToOutputString
protected

Definition at line 236 of file vtkXMLWriterBase.h.

◆ OutputString

std::string vtkXMLWriterBase::OutputString
protected

Definition at line 239 of file vtkXMLWriterBase.h.

◆ ByteOrder

int vtkXMLWriterBase::ByteOrder
protected

Definition at line 242 of file vtkXMLWriterBase.h.

◆ HeaderType

int vtkXMLWriterBase::HeaderType
protected

Definition at line 245 of file vtkXMLWriterBase.h.

◆ IdType

int vtkXMLWriterBase::IdType
protected

Definition at line 248 of file vtkXMLWriterBase.h.

◆ DataMode

int vtkXMLWriterBase::DataMode
protected

Definition at line 252 of file vtkXMLWriterBase.h.

◆ EncodeAppendedData

bool vtkXMLWriterBase::EncodeAppendedData
protected

Definition at line 255 of file vtkXMLWriterBase.h.

◆ Compressor

vtkDataCompressor* vtkXMLWriterBase::Compressor
protected

Definition at line 258 of file vtkXMLWriterBase.h.

◆ BlockSize

size_t vtkXMLWriterBase::BlockSize
protected

Definition at line 259 of file vtkXMLWriterBase.h.

◆ CompressionLevel

int vtkXMLWriterBase::CompressionLevel
protected

Definition at line 263 of file vtkXMLWriterBase.h.

◆ UsePreviousVersion

bool vtkXMLWriterBase::UsePreviousVersion
protected

Definition at line 271 of file vtkXMLWriterBase.h.


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