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

Write data in a parallel XML format. More...

#include <vtkXMLPDataObjectWriter.h>

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

Public Types

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, LZMA }
 
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkXMLPDataObjectWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetNumberOfPieces (int)
 Get/Set the number of pieces that are being written in parallel. More...
 
virtual int GetNumberOfPieces ()
 
virtual void SetStartPiece (int)
 Get/Set the range of pieces assigned to this writer. More...
 
virtual int GetStartPiece ()
 
virtual void SetEndPiece (int)
 
virtual int GetEndPiece ()
 
virtual void SetGhostLevel (int)
 Get/Set the ghost level used for this writer's piece. More...
 
virtual int GetGhostLevel ()
 
virtual void SetUseSubdirectory (bool)
 Get/Set whether to use a subdirectory to store the pieces. More...
 
virtual bool GetUseSubdirectory ()
 
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 ()
 
virtual void WriteSummaryFileOn ()
 
virtual void WriteSummaryFileOff ()
 
virtual void SetController (vtkMultiProcessController *)
 Controller used to communicate data type of blocks. More...
 
virtual vtkMultiProcessControllerGetController ()
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Overridden to handle passing the CONTINUE_EXECUTING() flags to the executive. 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...
 
virtual void SetByteOrder (int)
 Get/Set the byte order of data written to the file. More...
 
virtual int GetByteOrder ()
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
virtual void SetHeaderType (int)
 Get/Set the binary data header word type. More...
 
virtual int GetHeaderType ()
 
void SetHeaderTypeToUInt32 ()
 
void SetHeaderTypeToUInt64 ()
 
virtual void SetIdType (int)
 Get/Set the size of the vtkIdType values stored in the file. More...
 
virtual int GetIdType ()
 
void SetIdTypeToInt32 ()
 
void SetIdTypeToInt64 ()
 
virtual void SetFileName (const char *)
 Get/Set the name of the output file. More...
 
virtual char * GetFileName ()
 
virtual void SetWriteToOutputString (vtkTypeBool)
 Enable writing to an OutputString instead of the default, a file. More...
 
virtual vtkTypeBool GetWriteToOutputString ()
 
virtual void WriteToOutputStringOn ()
 
virtual void WriteToOutputStringOff ()
 
std::string GetOutputString ()
 
virtual void SetCompressor (vtkDataCompressor *)
 Get/Set the compressor used to compress binary and appended data before writing to the file. More...
 
virtual vtkDataCompressorGetCompressor ()
 
void SetCompressorType (int compressorType)
 Convenience functions to set the compressor to certain known types. More...
 
void SetCompressorTypeToNone ()
 
void SetCompressorTypeToLZ4 ()
 
void SetCompressorTypeToZLib ()
 
void SetCompressorTypeToLZMA ()
 
void SetCompressionLevel (int compressorLevel)
 
virtual int GetCompressionLevel ()
 
virtual void SetBlockSize (size_t blockSize)
 Get/Set the block size used in compression. More...
 
virtual size_t GetBlockSize ()
 
virtual void SetDataMode (int)
 Get/Set the data mode used for the file's data. More...
 
virtual int GetDataMode ()
 
void SetDataModeToAscii ()
 
void SetDataModeToBinary ()
 
void SetDataModeToAppended ()
 
virtual void SetEncodeAppendedData (vtkTypeBool)
 Get/Set whether the appended data section is base64 encoded. More...
 
virtual vtkTypeBool GetEncodeAppendedData ()
 
virtual void EncodeAppendedDataOn ()
 
virtual void EncodeAppendedDataOff ()
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
virtual const char * GetDefaultFileExtension ()=0
 Get the default file extension for files written by this writer. More...
 
int Write ()
 Invoke the writer. More...
 
vtkTypeBool 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 int GetNumberOfTimeSteps ()
 Set the number of time steps. More...
 
virtual void SetNumberOfTimeSteps (int)
 
void Start ()
 API to interface an outside the VTK pipeline control. More...
 
void Stop ()
 
void WriteNextTime (double time)
 
- 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...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLPDataObjectWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLWriter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkXMLPDataObjectWriter ()
 
 ~vtkXMLPDataObjectWriter () override
 
int WriteInternal () override
 Override writing method from superclass. More...
 
int WriteData () override
 Write data from the input dataset. More...
 
virtual void WritePData (vtkIndent indent)=0
 Write Data associated with the input dataset. More...
 
virtual int WritePiece (int index)=0
 Write a piece of the dataset on disk. More...
 
virtual int WritePieceInternal ()=0
 Method called by WriteInternal(). More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Overridden to make appropriate piece request from upstream. More...
 
virtual void PrepareSummaryFile ()
 Collect information between ranks before writing the summary file. More...
 
virtual void WritePPieceAttributes (int index)
 Write the attributes of the piece at the given index. More...
 
char * CreatePieceFileName (int index, const char *path=nullptr)
 Methods for creating a filename for each piece in the dataset. More...
 
void SplitFileName ()
 
virtual bool GetContinuingExecution ()
 Valid at end of WriteInternal to indicate if we're going to continue execution. More...
 
virtual int GetCurrentPiece ()
 Get the current piece to write. More...
 
virtual void ProgressCallback (vtkAlgorithm *w)
 Progress callback from internal writer. More...
 
void DeleteFiles ()
 Method used to delete all written files. More...
 
virtual void SetupPieceFileNameExtension ()
 Initializes PieceFileNameExtension. 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 const char * GetDataSetName ()=0
 
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)
 
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 vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void ProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
 Callback registered with the InternalProgressObserver. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkCallbackCommandInternalProgressObserver
 The observer to report progress from the internal writer. More...
 
vtkMultiProcessControllerController
 
int StartPiece
 
int EndPiece
 
int NumberOfPieces
 
int GhostLevel
 
int WriteSummaryFile
 
bool UseSubdirectory
 
char * PathName
 
char * FileNameBase
 
char * FileNameExtension
 
char * PieceFileNameExtension
 
unsigned char * PieceWrittenFlags
 Flags used to keep track of which pieces were written out. More...
 
- Protected Attributes inherited from vtkXMLWriter
char * FileName
 
ostream * Stream
 
vtkTypeBool WriteToOutputString
 
std::string OutputString
 
int ByteOrder
 
int HeaderType
 
int IdType
 
int DataMode
 
vtkTypeBool EncodeAppendedData
 
vtkTypeInt64 AppendedDataPosition
 
OffsetsManagerGroupFieldDataOM
 
Int32IdType * Int32IdTypeBuffer
 
unsigned char * ByteSwapBuffer
 
vtkDataCompressorCompressor
 
size_t BlockSize
 
size_t CompressionBlockNumber
 
vtkXMLDataHeaderCompressionHeader
 
vtkTypeInt64 CompressionHeaderPosition
 
int CompressionLevel = 5
 
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
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Write data in a parallel XML format.

vtkXMLPDataWriter is the superclass for all XML parallel data object writers. It provides functionality needed for writing parallel formats, such as the selection of which writer writes the summary file and what range of pieces are assigned to each serial writer.

See also
vtkXMLDataObjectWriter

Definition at line 37 of file vtkXMLPDataObjectWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkXMLPDataObjectWriter.h.

Constructor & Destructor Documentation

◆ vtkXMLPDataObjectWriter()

vtkXMLPDataObjectWriter::vtkXMLPDataObjectWriter ( )
protected

◆ ~vtkXMLPDataObjectWriter()

vtkXMLPDataObjectWriter::~vtkXMLPDataObjectWriter ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkXMLPDataObjectWriter::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 vtkXMLWriter.

Reimplemented in vtkXMLPTableWriter, vtkXMLPHyperTreeGridWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPStructuredDataWriter, and vtkXMLPUnstructuredDataWriter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkXMLPDataObjectWriter::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkXMLPDataObjectWriter* vtkXMLPDataObjectWriter::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLPDataObjectWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPTableWriter, vtkXMLPHyperTreeGridWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPStructuredDataWriter, and vtkXMLPUnstructuredDataWriter.

◆ SetNumberOfPieces()

virtual void vtkXMLPDataObjectWriter::SetNumberOfPieces ( int  )
virtual

Get/Set the number of pieces that are being written in parallel.

◆ GetNumberOfPieces()

virtual int vtkXMLPDataObjectWriter::GetNumberOfPieces ( )
virtual

◆ SetStartPiece()

virtual void vtkXMLPDataObjectWriter::SetStartPiece ( int  )
virtual

Get/Set the range of pieces assigned to this writer.

◆ GetStartPiece()

virtual int vtkXMLPDataObjectWriter::GetStartPiece ( )
virtual

◆ SetEndPiece()

virtual void vtkXMLPDataObjectWriter::SetEndPiece ( int  )
virtual

◆ GetEndPiece()

virtual int vtkXMLPDataObjectWriter::GetEndPiece ( )
virtual

◆ SetGhostLevel()

virtual void vtkXMLPDataObjectWriter::SetGhostLevel ( int  )
virtual

Get/Set the ghost level used for this writer's piece.

◆ GetGhostLevel()

virtual int vtkXMLPDataObjectWriter::GetGhostLevel ( )
virtual

◆ SetUseSubdirectory()

virtual void vtkXMLPDataObjectWriter::SetUseSubdirectory ( bool  )
virtual

Get/Set whether to use a subdirectory to store the pieces.

◆ GetUseSubdirectory()

virtual bool vtkXMLPDataObjectWriter::GetUseSubdirectory ( )
virtual

◆ SetWriteSummaryFile()

virtual void vtkXMLPDataObjectWriter::SetWriteSummaryFile ( int  flag)
virtual

Get/Set whether the writer should write the summary file that refers to all of the pieces' individual files.

This is on by default. Note that only the first process writes the summary file.

◆ GetWriteSummaryFile()

virtual int vtkXMLPDataObjectWriter::GetWriteSummaryFile ( )
virtual

◆ WriteSummaryFileOn()

virtual void vtkXMLPDataObjectWriter::WriteSummaryFileOn ( )
virtual

◆ WriteSummaryFileOff()

virtual void vtkXMLPDataObjectWriter::WriteSummaryFileOff ( )
virtual

◆ SetController()

virtual void vtkXMLPDataObjectWriter::SetController ( vtkMultiProcessController )
virtual

Controller used to communicate data type of blocks.

By default, the global controller is used. If you want another controller to be used, set it with this.

◆ GetController()

virtual vtkMultiProcessController* vtkXMLPDataObjectWriter::GetController ( )
virtual

◆ ProcessRequest()

vtkTypeBool vtkXMLPDataObjectWriter::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overridevirtual

Overridden to handle passing the CONTINUE_EXECUTING() flags to the executive.

Reimplemented from vtkAlgorithm.

◆ WriteInternal()

int vtkXMLPDataObjectWriter::WriteInternal ( )
overrideprotectedvirtual

Override writing method from superclass.

Reimplemented from vtkXMLWriter.

Reimplemented in vtkXMLPDataSetWriter, and vtkXMLPStructuredDataWriter.

◆ WriteData()

int vtkXMLPDataObjectWriter::WriteData ( )
overrideprotectedvirtual

Write data from the input dataset.

Call WritePData(vtkIndent indent)

Reimplemented from vtkXMLWriter.

◆ WritePData()

virtual void vtkXMLPDataObjectWriter::WritePData ( vtkIndent  indent)
protectedpure virtual

Write Data associated with the input dataset.

It needs to be overridden by subclass

Implemented in vtkXMLPTableWriter, vtkXMLPHyperTreeGridWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPDataWriter, and vtkXMLPUnstructuredDataWriter.

◆ WritePiece()

virtual int vtkXMLPDataObjectWriter::WritePiece ( int  index)
protectedpure virtual

Write a piece of the dataset on disk.

Called by WritePieceInternal(). It needs to be overridden by subclass

Implemented in vtkXMLPTableWriter, vtkXMLPHyperTreeGridWriter, vtkXMLPStructuredDataWriter, and vtkXMLPDataWriter.

◆ WritePieceInternal()

virtual int vtkXMLPDataObjectWriter::WritePieceInternal ( )
protectedpure virtual

Method called by WriteInternal().

It's used for writing a piece of the dataset. It needs to be overridden by subclass.

Implemented in vtkXMLPTableWriter, vtkXMLPHyperTreeGridWriter, and vtkXMLPDataWriter.

◆ RequestUpdateExtent()

virtual int vtkXMLPDataObjectWriter::RequestUpdateExtent ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

Overridden to make appropriate piece request from upstream.

◆ PrepareSummaryFile()

virtual void vtkXMLPDataObjectWriter::PrepareSummaryFile ( )
protectedvirtual

Collect information between ranks before writing the summary file.

This method is called on all ranks while summary file is only written on 1 rank (rank 0).

Reimplemented in vtkXMLPStructuredDataWriter.

◆ WritePPieceAttributes()

virtual void vtkXMLPDataObjectWriter::WritePPieceAttributes ( int  index)
protectedvirtual

Write the attributes of the piece at the given index.

Reimplemented in vtkXMLPStructuredDataWriter.

◆ CreatePieceFileName()

char* vtkXMLPDataObjectWriter::CreatePieceFileName ( int  index,
const char *  path = nullptr 
)
protected

Methods for creating a filename for each piece in the dataset.

◆ SplitFileName()

void vtkXMLPDataObjectWriter::SplitFileName ( )
protected

◆ ProgressCallbackFunction()

static void vtkXMLPDataObjectWriter::ProgressCallbackFunction ( vtkObject ,
unsigned long  ,
void *  ,
void *   
)
staticprotected

Callback registered with the InternalProgressObserver.

◆ GetContinuingExecution()

virtual bool vtkXMLPDataObjectWriter::GetContinuingExecution ( )
protectedvirtual

Valid at end of WriteInternal to indicate if we're going to continue execution.

◆ GetCurrentPiece()

virtual int vtkXMLPDataObjectWriter::GetCurrentPiece ( )
protectedvirtual

Get the current piece to write.

◆ ProgressCallback()

virtual void vtkXMLPDataObjectWriter::ProgressCallback ( vtkAlgorithm w)
protectedvirtual

Progress callback from internal writer.

◆ DeleteFiles()

void vtkXMLPDataObjectWriter::DeleteFiles ( )
protected

Method used to delete all written files.

◆ SetupPieceFileNameExtension()

virtual void vtkXMLPDataObjectWriter::SetupPieceFileNameExtension ( )
protectedvirtual

Initializes PieceFileNameExtension.

Member Data Documentation

◆ InternalProgressObserver

vtkCallbackCommand* vtkXMLPDataObjectWriter::InternalProgressObserver
protected

The observer to report progress from the internal writer.

Definition at line 192 of file vtkXMLPDataObjectWriter.h.

◆ Controller

vtkMultiProcessController* vtkXMLPDataObjectWriter::Controller
protected

Definition at line 194 of file vtkXMLPDataObjectWriter.h.

◆ StartPiece

int vtkXMLPDataObjectWriter::StartPiece
protected

Definition at line 196 of file vtkXMLPDataObjectWriter.h.

◆ EndPiece

int vtkXMLPDataObjectWriter::EndPiece
protected

Definition at line 197 of file vtkXMLPDataObjectWriter.h.

◆ NumberOfPieces

int vtkXMLPDataObjectWriter::NumberOfPieces
protected

Definition at line 198 of file vtkXMLPDataObjectWriter.h.

◆ GhostLevel

int vtkXMLPDataObjectWriter::GhostLevel
protected

Definition at line 199 of file vtkXMLPDataObjectWriter.h.

◆ WriteSummaryFile

int vtkXMLPDataObjectWriter::WriteSummaryFile
protected

Definition at line 200 of file vtkXMLPDataObjectWriter.h.

◆ UseSubdirectory

bool vtkXMLPDataObjectWriter::UseSubdirectory
protected

Definition at line 201 of file vtkXMLPDataObjectWriter.h.

◆ PathName

char* vtkXMLPDataObjectWriter::PathName
protected

Definition at line 203 of file vtkXMLPDataObjectWriter.h.

◆ FileNameBase

char* vtkXMLPDataObjectWriter::FileNameBase
protected

Definition at line 204 of file vtkXMLPDataObjectWriter.h.

◆ FileNameExtension

char* vtkXMLPDataObjectWriter::FileNameExtension
protected

Definition at line 205 of file vtkXMLPDataObjectWriter.h.

◆ PieceFileNameExtension

char* vtkXMLPDataObjectWriter::PieceFileNameExtension
protected

Definition at line 206 of file vtkXMLPDataObjectWriter.h.

◆ PieceWrittenFlags

unsigned char* vtkXMLPDataObjectWriter::PieceWrittenFlags
protected

Flags used to keep track of which pieces were written out.

Definition at line 211 of file vtkXMLPDataObjectWriter.h.


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