VTK
9.4.20241218
|
writer for vtkMultiBlockDataSet. More...
#include <vtkXMLMultiBlockDataWriter.h>
Public Types | |
typedef vtkXMLCompositeDataWriter | Superclass |
Public Types inherited from vtkXMLCompositeDataWriter | |
typedef vtkXMLWriter | Superclass |
Public Types inherited from vtkXMLWriter | |
typedef vtkXMLWriterBase | Superclass |
Public Types inherited from vtkXMLWriterBase | |
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. | |
vtkXMLMultiBlockDataWriter * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
const char * | GetDefaultFileExtension () override |
Get the default file extension for files written by this writer. | |
Public Member Functions inherited from vtkXMLCompositeDataWriter | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkXMLCompositeDataWriter * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
const char * | GetDefaultFileExtension () override |
Get the default file extension for files written by this writer. | |
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
See the vtkAlgorithm for a description of what these do. | |
virtual int | GetGhostLevel () |
Get/Set the number of pieces into which the inputs are split. | |
virtual void | SetGhostLevel (int) |
Get/Set the number of pieces into which the inputs are split. | |
virtual int | GetWriteMetaFile () |
Get/Set whether this instance will write the meta-file. | |
virtual void | SetWriteMetaFile (int flag) |
Get/Set whether this instance will write the meta-file. | |
Public Member Functions inherited from vtkXMLWriter | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkXMLWriter * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override |
Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. | |
void | SetInputData (vtkDataObject *) |
Assign a data object as input. | |
void | SetInputData (int, vtkDataObject *) |
Assign a data object as input. | |
vtkDataObject * | GetInput (int port) |
Assign a data object as input. | |
vtkDataObject * | GetInput () |
Assign a data object as input. | |
virtual int | GetNumberOfTimeSteps () |
Set the number of time steps. | |
virtual void | SetNumberOfTimeSteps (int) |
Set the number of time steps. | |
void | Start () |
API to interface an outside the VTK pipeline control. | |
void | Stop () |
API to interface an outside the VTK pipeline control. | |
void | WriteNextTime (double time) |
API to interface an outside the VTK pipeline control. | |
Public Member Functions inherited from vtkXMLWriterBase | |
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. | |
VTK_UNBLOCKTHREADS 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. | |
virtual bool | GetWriteTimeValue () |
Control whether to write "TimeValue" field data. | |
virtual void | SetWriteTimeValue (bool) |
Control whether to write "TimeValue" field data. | |
virtual void | WriteTimeValueOn () |
Control whether to write "TimeValue" field data. | |
virtual void | WriteTimeValueOff () |
Control whether to write "TimeValue" field data. | |
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. | |
vtkTypeBool | 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 | SetAbortExecuteAndUpdateTime () |
Set AbortExecute Flag and update LastAbortTime. | |
void | UpdateProgress (double amount) |
Update the progress of the process object. | |
bool | CheckAbort () |
Checks to see if this filter should abort. | |
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 VTK_UNBLOCKTHREADS int | UpdateExtent (const int extents[6]) |
Convenience method to update an algorithm after passing requests to its first output port. | |
virtual VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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. | |
void | RemoveNoPriorTemporalAccessInformationKey () |
Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm . | |
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. | |
bool | UsesGarbageCollector () const 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 | SetContainerAlgorithm (vtkAlgorithm *containerAlg) |
Set/get a Container algorithm for this algorithm. | |
vtkAlgorithm * | GetContainerAlgorithm () |
Set/get a Container algorithm for this algorithm. | |
virtual void | SetAbortOutput (bool) |
Set/Get an internal variable used to communicate between the algorithm and executive. | |
virtual bool | GetAbortOutput () |
Set/Get an internal variable used to communicate between the algorithm and executive. | |
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. | |
void | SetInputArrayToProcess (const char *name, int fieldAssociation) |
Set the input data arrays that this algorithm will process. | |
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 | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
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 VTK_UNBLOCKTHREADS void | Update (int port) |
Bring this algorithm's outputs up-to-date. | |
virtual VTK_UNBLOCKTHREADS void | Update () |
Bring this algorithm's outputs up-to-date. | |
virtual void | SetReleaseDataFlag (vtkTypeBool) |
Turn release data flag on or off for all output ports. | |
virtual vtkTypeBool | 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. | |
void | SetNoPriorTemporalAccessInformationKey (int key) |
Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() . | |
void | SetNoPriorTemporalAccessInformationKey () |
Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() . | |
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) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
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. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
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. | |
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 vtkXMLMultiBlockDataWriter * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkXMLMultiBlockDataWriter * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkXMLCompositeDataWriter | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkXMLCompositeDataWriter * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkXMLWriter | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkXMLWriter * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkXMLWriterBase | |
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 vtkInformationIntegerKey * | ABORTED () |
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 (vtkTypeBool 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 vtkTypeBool | 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 |
vtkXMLMultiBlockDataWriter () | |
~vtkXMLMultiBlockDataWriter () override | |
int | FillInputPortInformation (int port, vtkInformation *info) override |
Fill the input port information objects for this algorithm. | |
int | WriteComposite (vtkCompositeDataSet *compositeData, vtkXMLDataElement *parent, int &writerIdx) override |
Internal method called recursively to create the xml tree for the children of compositeData as well as write the actual data set files. | |
Protected Member Functions inherited from vtkXMLCompositeDataWriter | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkXMLCompositeDataWriter () | |
~vtkXMLCompositeDataWriter () override | |
int | GetDataSetMajorVersion () override |
Methods to define the file's major and minor version numbers. | |
int | GetDataSetMinorVersion () override |
vtkStdString | CreatePieceFileName (int Piece) |
Create a filename for the given index. | |
int | FillInputPortInformation (int port, vtkInformation *info) override |
Fill the input port information objects for this algorithm. | |
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
int | WriteData () override |
const char * | GetDataSetName () override |
vtkExecutive * | CreateDefaultExecutive () override |
Create a default executive. | |
virtual void | FillDataTypes (vtkCompositeDataSet *) |
Determine the data types for each of the leaf nodes. | |
unsigned int | GetNumberOfDataTypes () |
Returns the number of leaf nodes (also includes empty leaf nodes). | |
int * | GetDataTypesPointer () |
Returns the array pointer to the array of leaf nodes. | |
void | CreateWriters (vtkCompositeDataSet *) |
vtkXMLWriter * | GetWriter (int index) |
void | SplitFileName () |
VTK_FILEPATH const char * | GetFilePrefix () |
VTK_FILEPATH const char * | GetFilePath () |
const char * | GetDefaultFileExtensionForDataSet (int dataset_type) |
Returns the default extension to use for the given dataset type. | |
int | WriteMetaFileIfRequested () |
Write the collection file if it is requested. | |
virtual void | MakeDirectory (const char *name) |
void | RemoveADirectory (const char *name) |
virtual void | ProgressCallback (vtkAlgorithm *w) |
virtual int | WriteComposite (vtkCompositeDataSet *compositeData, vtkXMLDataElement *element, int &writerIdx)=0 |
Internal method called recursively to create the xml tree for the children of compositeData as well as write the actual data set files. | |
virtual int | WriteNonCompositeData (vtkDataObject *dObj, vtkXMLDataElement *element, int &writerIdx, const char *fileName) |
Internal method to write a non vtkCompositeDataSet subclass as well as add in the file name to the metadata file. | |
virtual void | RemoveWrittenFiles (const char *SubDirectory) |
Utility function to remove any already written files in case writer failed. | |
Protected Member Functions inherited from vtkXMLWriter | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkXMLWriter () | |
~vtkXMLWriter () override | |
virtual int | RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
virtual int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
virtual void | SetDataStream (vtkOutputStream *) |
virtual vtkOutputStream * | GetDataStream () |
virtual int | WriteInternal () |
virtual int | WriteData () |
virtual const char * | GetDataSetName ()=0 |
vtkDataSet * | GetInputAsDataSet () |
virtual int | StartFile () |
virtual void | WriteFileAttributes () |
virtual int | EndFile () |
void | DeleteAFile () |
void | DeleteAFile (const char *name) |
virtual int | WritePrimaryElement (ostream &os, vtkIndent indent) |
virtual void | WritePrimaryElementAttributes (ostream &os, vtkIndent indent) |
void | StartAppendedData () |
void | EndAppendedData () |
vtkTypeInt64 | ReserveAttributeSpace (const char *attr, size_t length=20) |
vtkTypeInt64 | GetAppendedDataOffset () |
void | WriteAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 &lastoffset, const char *attr=nullptr) |
void | ForwardAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char *attr=nullptr) |
void | ForwardAppendedDataDouble (vtkTypeInt64 streamPos, double value, const char *attr) |
int | WriteScalarAttribute (const char *name, int data) |
int | WriteScalarAttribute (const char *name, float data) |
int | WriteScalarAttribute (const char *name, double data) |
int | WriteVectorAttribute (const char *name, int length, int *data) |
int | WriteVectorAttribute (const char *name, int length, float *data) |
int | WriteVectorAttribute (const char *name, int length, double *data) |
int | WriteDataModeAttribute (const char *name) |
int | WriteWordTypeAttribute (const char *name, int dataType) |
int | WriteStringAttribute (const char *name, const char *value) |
bool | WriteInformation (vtkInformation *info, vtkIndent indent) |
void | WriteArrayHeader (vtkAbstractArray *a, vtkIndent indent, const char *alternateName, int writeNumTuples, int timestep) |
virtual void | WriteArrayFooter (ostream &os, vtkIndent indent, vtkAbstractArray *a, int shortFormat) |
virtual void | WriteArrayInline (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=nullptr, int writeNumTuples=0) |
virtual void | WriteInlineData (vtkAbstractArray *a, vtkIndent indent) |
void | WriteArrayAppended (vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=nullptr, int writeNumTuples=0, int timestep=0) |
int | WriteAsciiData (vtkAbstractArray *a, vtkIndent indent) |
int | WriteBinaryData (vtkAbstractArray *a) |
int | WriteBinaryDataInternal (vtkAbstractArray *a) |
void | WriteArrayAppendedData (vtkAbstractArray *a, vtkTypeInt64 pos, vtkTypeInt64 &lastoffset) |
void | WriteFieldData (vtkIndent indent) |
void | WriteFieldDataInline (vtkFieldData *fd, vtkIndent indent) |
void | WritePointDataInline (vtkPointData *pd, vtkIndent indent) |
void | WriteCellDataInline (vtkCellData *cd, vtkIndent indent) |
void | WriteFieldDataAppended (vtkFieldData *fd, vtkIndent indent, OffsetsManagerGroup *fdManager) |
void | WriteFieldDataAppendedData (vtkFieldData *fd, int timestep, OffsetsManagerGroup *fdManager) |
void | WritePointDataAppended (vtkPointData *pd, vtkIndent indent, OffsetsManagerGroup *pdManager) |
void | WritePointDataAppendedData (vtkPointData *pd, int timestep, OffsetsManagerGroup *pdManager) |
void | WriteCellDataAppended (vtkCellData *cd, vtkIndent indent, OffsetsManagerGroup *cdManager) |
void | WriteCellDataAppendedData (vtkCellData *cd, int timestep, OffsetsManagerGroup *cdManager) |
void | WriteAttributeIndices (vtkDataSetAttributes *dsa, char **names) |
void | WritePointsAppended (vtkPoints *points, vtkIndent indent, OffsetsManager *manager) |
void | WritePointsAppendedData (vtkPoints *points, int timestep, OffsetsManager *pdManager) |
void | WritePointsInline (vtkPoints *points, vtkIndent indent) |
void | WriteCoordinatesInline (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent) |
void | WriteCoordinatesAppended (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent, OffsetsManagerGroup *coordManager) |
void | WriteCoordinatesAppendedData (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, int timestep, OffsetsManagerGroup *coordManager) |
void | WritePPointData (vtkPointData *pd, vtkIndent indent) |
void | WritePCellData (vtkCellData *cd, vtkIndent indent) |
void | WritePPoints (vtkPoints *points, vtkIndent indent) |
void | WritePArray (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=nullptr) |
void | WritePCoordinates (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent) |
int | WriteBinaryDataBlock (unsigned char *in_data, size_t numWords, int wordType) |
void | PerformByteSwap (void *data, size_t numWords, size_t wordSize) |
int | CreateCompressionHeader (size_t size) |
int | WriteCompressionBlock (unsigned char *data, size_t size) |
int | WriteCompressionHeader () |
size_t | GetWordTypeSize (int dataType) |
const char * | GetWordTypeName (int dataType) |
size_t | GetOutputWordTypeSize (int dataType) |
char ** | CreateStringArray (int numStrings) |
void | DestroyStringArray (int numStrings, char **strings) |
virtual void | GetProgressRange (float range[2]) |
virtual void | SetProgressRange (const float range[2], int curStep, int numSteps) |
virtual void | SetProgressRange (const float range[2], int curStep, const float *fractions) |
virtual void | SetProgressPartial (float fraction) |
virtual void | UpdateProgressDiscrete (float progress) |
void | UpdateFieldData (vtkFieldData *) |
int | OpenStream () |
int | OpenFile () |
int | OpenString () |
void | CloseStream () |
void | CloseFile () |
void | CloseString () |
Protected Member Functions inherited from vtkXMLWriterBase | |
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 | |
bool | CheckUpstreamAbort () |
Checks to see if an upstream filter has been aborted. | |
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 association 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 *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
writer for vtkMultiBlockDataSet.
vtkXMLMultiBlockDataWriter is a vtkXMLCompositeDataWriter subclass to handle vtkMultiBlockDataSet.
Definition at line 60 of file vtkXMLMultiBlockDataWriter.h.
Definition at line 64 of file vtkXMLMultiBlockDataWriter.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkXMLCompositeDataWriter.
Reimplemented in vtkXMLPMultiBlockDataWriter.
|
static |
|
protectedvirtual |
Reimplemented from vtkXMLCompositeDataWriter.
Reimplemented in vtkXMLPMultiBlockDataWriter.
vtkXMLMultiBlockDataWriter * vtkXMLMultiBlockDataWriter::NewInstance | ( | ) | const |
|
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 vtkXMLCompositeDataWriter.
Reimplemented in vtkXMLPMultiBlockDataWriter.
|
inlineoverridevirtual |
Get the default file extension for files written by this writer.
Reimplemented from vtkXMLCompositeDataWriter.
Definition at line 70 of file vtkXMLMultiBlockDataWriter.h.
|
overrideprotectedvirtual |
Fill the input port information objects for this algorithm.
This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkXMLCompositeDataWriter.
|
overrideprotectedvirtual |
Internal method called recursively to create the xml tree for the children of compositeData as well as write the actual data set files.
element will only have added nested information. writerIdx is the global piece index used to create unique filenames for each file written. This function returns 0 if no files were written from compositeData.
Implements vtkXMLCompositeDataWriter.
Reimplemented in vtkXMLPMultiBlockDataWriter.