VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkXMLPUnstructuredGridWriter Class Reference

Write PVTK XML UnstructuredGrid files. More...

#include <vtkXMLPUnstructuredGridWriter.h>

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

Public Types

typedef vtkXMLPUnstructuredDataWriter Superclass
 
- Public Types inherited from vtkXMLPUnstructuredDataWriter
typedef vtkXMLPDataWriter Superclass
 
- Public Types inherited from vtkXMLPDataWriter
typedef vtkXMLWriter Superclass
 
- Public Types inherited from vtkXMLWriter
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 }
 
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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkXMLPUnstructuredGridWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkUnstructuredGridBaseGetInput ()
 Get/Set the writer's input. More...
 
const char * GetDefaultFileExtension () override
 Get the default file extension for files written by this writer. More...
 
- Public Member Functions inherited from vtkXMLPUnstructuredDataWriter
vtkXMLPUnstructuredDataWriterNewInstance () const
 
- Public Member Functions inherited from vtkXMLPDataWriter
vtkXMLPDataWriterNewInstance () const
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Overridden to handle passing the CONTINUE_EXECUTING() flags to the executive. More...
 
virtual void SetNumberOfPieces (int)
 Get/Set the number of pieces that are being written in parallel. More...
 
virtual int GetNumberOfPieces ()
 Get/Set the number of pieces that are being written in parallel. More...
 
virtual void SetStartPiece (int)
 Get/Set the range of pieces assigned to this writer. More...
 
virtual int GetStartPiece ()
 Get/Set the range of pieces assigned to this writer. More...
 
virtual void SetEndPiece (int)
 Get/Set the range of pieces assigned to this writer. More...
 
virtual int GetEndPiece ()
 Get/Set the range of pieces assigned to this writer. More...
 
virtual void SetGhostLevel (int)
 Get/Set the ghost level used for this writer's piece. More...
 
virtual int GetGhostLevel ()
 Get/Set the ghost level used for this writer's piece. More...
 
virtual void SetUseSubdirectory (bool)
 Get/Set whether to use a subdirectory to store the pieces. More...
 
virtual bool GetUseSubdirectory ()
 Get/Set whether to use a subdirectory to store the pieces. More...
 
virtual void SetWriteSummaryFile (int flag)
 Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. More...
 
virtual int GetWriteSummaryFile ()
 Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. More...
 
virtual void WriteSummaryFileOn ()
 Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. More...
 
virtual void WriteSummaryFileOff ()
 Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files. More...
 
virtual void SetController (vtkMultiProcessController *)
 Controller used to communicate data type of blocks. More...
 
virtual vtkMultiProcessControllerGetController ()
 Controller used to communicate data type of blocks. More...
 
- Public Member Functions inherited from vtkXMLWriter
vtkXMLWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int Write ()
 Invoke the writer. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. 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 (int)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual int 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...
 
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 (int)
 Get/Set whether the appended data section is base64 encoded. More...
 
virtual int 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...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
vtkDataObjectGetInput (int port)
 Assign a data object as input. More...
 
vtkDataObjectGetInput ()
 Assign a data object as input. More...
 
virtual int GetNumberOfTimeSteps ()
 Set the number of time steps. More...
 
virtual void SetNumberOfTimeSteps (int)
 Set the number of time steps. More...
 
void Start ()
 API to interface an outside the VTK pipeline control. More...
 
void Stop ()
 API to interface an outside the VTK pipeline control. More...
 
void WriteNextTime (double time)
 API to interface an outside the VTK pipeline control. 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...
 
int 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 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 int 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 int 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]=0)
 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]=0)
 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...
 
int SetUpdateExtentToWholeExtent (int port)
 If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...
 
int SetUpdateExtentToWholeExtent ()
 Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 Set the output update extent in terms of piece and ghost levels. More...
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...
 
void SetUpdateExtent (int port, int extent[6])
 Set the output update extent for data objects that use 3D extents. More...
 
void SetUpdateExtent (int extent[6])
 Convenience function equivalent to SetUpdateExtent(0, extent) 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 (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int 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 void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
void PrintRevisions (ostream &)
 Legacy. 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 vtkXMLPUnstructuredGridWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkXMLPUnstructuredGridWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLPUnstructuredDataWriter
static int IsTypeOf (const char *type)
 
static vtkXMLPUnstructuredDataWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLPDataWriter
static int IsTypeOf (const char *type)
 
static vtkXMLPDataWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLWriter
static int IsTypeOf (const char *type)
 
static vtkXMLWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLPUnstructuredGridWriter ()
 
 ~vtkXMLPUnstructuredGridWriter () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
const char * GetDataSetName () override
 
vtkXMLUnstructuredDataWriterCreateUnstructuredPieceWriter () override
 
- Protected Member Functions inherited from vtkXMLPUnstructuredDataWriter
 vtkXMLPUnstructuredDataWriter ()
 
 ~vtkXMLPUnstructuredDataWriter () override
 
vtkPointSetGetInputAsPointSet ()
 
vtkXMLWriterCreatePieceWriter (int index) override
 
void WritePData (vtkIndent indent) override
 
- Protected Member Functions inherited from vtkXMLPDataWriter
 vtkXMLPDataWriter ()
 
 ~vtkXMLPDataWriter () override
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Overridden to make appropriate piece request from upstream. More...
 
int WriteInternal () override
 
virtual void PrepareSummaryFile ()
 
void WritePrimaryElementAttributes (ostream &os, vtkIndent indent) override
 
int WriteData () override
 
virtual void WritePPieceAttributes (int index)
 
char * CreatePieceFileName (int index, const char *path=0)
 
void SplitFileName ()
 
virtual int WritePiece (int index)
 
virtual void ProgressCallback (vtkAlgorithm *w)
 
virtual bool GetContinuingExecution ()
 Valid at end of WriteInternal to indicate if we're going to continue execution. More...
 
- Protected Member Functions inherited from vtkXMLWriter
 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 vtkOutputStreamGetDataStream ()
 
virtual int GetDataSetMajorVersion ()
 
virtual int GetDataSetMinorVersion ()
 
vtkDataSetGetInputAsDataSet ()
 
virtual int StartFile ()
 
virtual void WriteFileAttributes ()
 
virtual int EndFile ()
 
void DeleteAFile ()
 
void DeleteAFile (const char *name)
 
virtual int WritePrimaryElement (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=0)
 
void ForwardAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char *attr=0)
 
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=0, int writeNumTuples=0)
 
virtual void WriteInlineData (vtkAbstractArray *a, vtkIndent indent)
 
void WriteArrayAppended (vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=0, int writeNumTuples=0, int timestep=0)
 
int WriteAsciiData (vtkAbstractArray *a, vtkIndent indent)
 
int WriteBinaryData (vtkAbstractArray *a)
 
int WriteBinaryDataInternal (vtkAbstractArray *a)
 
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=0)
 
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)
 
int OpenStream ()
 
int OpenFile ()
 
int OpenString ()
 
void CloseStream ()
 
void CloseFile ()
 
void CloseString ()
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
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=NULL)
 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkXMLPDataWriter
static void ProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Protected Attributes inherited from vtkXMLPDataWriter
int StartPiece
 
int EndPiece
 
int NumberOfPieces
 
int GhostLevel
 
int WriteSummaryFile
 
bool UseSubdirectory
 
char * PathName
 
char * FileNameBase
 
char * FileNameExtension
 
char * PieceFileNameExtension
 
vtkCallbackCommandProgressObserver
 
vtkMultiProcessControllerController
 
- Protected Attributes inherited from vtkXMLWriter
char * FileName
 
ostream * Stream
 
int WriteToOutputString
 
std::string OutputString
 
int ByteOrder
 
int HeaderType
 
int IdType
 
int DataMode
 
int EncodeAppendedData
 
vtkTypeInt64 AppendedDataPosition
 
OffsetsManagerGroupFieldDataOM
 
Int32IdType * Int32IdTypeBuffer
 
unsigned char * ByteSwapBuffer
 
vtkDataCompressorCompressor
 
size_t BlockSize
 
size_t CompressionBlockNumber
 
vtkXMLDataHeaderCompressionHeader
 
vtkTypeInt64 CompressionHeaderPosition
 
vtkOutputStreamDataStream
 
float ProgressRange [2]
 
ofstream * OutFile
 
std::ostringstream * OutStringStream
 
int CurrentTimeIndex
 
int NumberOfTimeSteps
 
int UserContinueExecuting
 
bool UsePreviousVersion
 
vtkTypeInt64 * NumberOfTimeValues
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Write PVTK XML UnstructuredGrid files.

vtkXMLPUnstructuredGridWriter writes the PVTK XML UnstructuredGrid file format. One unstructured grid input can be written into a parallel file format with any number of pieces spread across files. The standard extension for this writer's file format is "pvtu". This writer uses vtkXMLUnstructuredGridWriter to write the individual piece files.

See also
vtkXMLUnstructuredGridWriter
Tests:
vtkXMLPUnstructuredGridWriter (Tests)

Definition at line 41 of file vtkXMLPUnstructuredGridWriter.h.

Member Typedef Documentation

Definition at line 45 of file vtkXMLPUnstructuredGridWriter.h.

Constructor & Destructor Documentation

vtkXMLPUnstructuredGridWriter::vtkXMLPUnstructuredGridWriter ( )
protected
vtkXMLPUnstructuredGridWriter::~vtkXMLPUnstructuredGridWriter ( )
overrideprotected

Member Function Documentation

static vtkXMLPUnstructuredGridWriter* vtkXMLPUnstructuredGridWriter::New ( )
static
static int vtkXMLPUnstructuredGridWriter::IsTypeOf ( const char *  type)
static
virtual int vtkXMLPUnstructuredGridWriter::IsA ( const char *  name)
virtual

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

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

Reimplemented from vtkXMLPUnstructuredDataWriter.

static vtkXMLPUnstructuredGridWriter* vtkXMLPUnstructuredGridWriter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkXMLPUnstructuredGridWriter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkXMLPUnstructuredDataWriter.

vtkXMLPUnstructuredGridWriter* vtkXMLPUnstructuredGridWriter::NewInstance ( ) const
void vtkXMLPUnstructuredGridWriter::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 vtkXMLPUnstructuredDataWriter.

vtkUnstructuredGridBase* vtkXMLPUnstructuredGridWriter::GetInput ( )

Get/Set the writer's input.

const char* vtkXMLPUnstructuredGridWriter::GetDefaultFileExtension ( )
overridevirtual

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

Implements vtkXMLWriter.

int vtkXMLPUnstructuredGridWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
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 vtkAlgorithm.

const char* vtkXMLPUnstructuredGridWriter::GetDataSetName ( )
overrideprotectedvirtual

Implements vtkXMLWriter.

vtkXMLUnstructuredDataWriter* vtkXMLPUnstructuredGridWriter::CreateUnstructuredPieceWriter ( )
overrideprotectedvirtual

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