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

Manages writing pieces of a data set. More...

#include <vtkPDataSetWriter.h>

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

Public Types

typedef vtkDataSetWriter Superclass
 
- Public Types inherited from vtkDataSetWriter
typedef vtkDataWriter Superclass
 
- Public Types inherited from vtkDataWriter
typedef vtkWriter Superclass
 
- Public Types inherited from vtkWriter
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

void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPDataSetWriterNewInstance () const
 
int Write () override
 Write the pvtk file and cooresponding vtk files. More...
 
void SetNumberOfPieces (int num)
 This is how many pieces the whole data set will be divided into. More...
 
virtual int GetNumberOfPieces ()
 
virtual void SetGhostLevel (int)
 Extra ghost cells will be written out to each piece file if this value is larger than 0. More...
 
virtual int GetGhostLevel ()
 
virtual void SetStartPiece (int)
 This is the range of pieces that that this writer is responsible for writing. More...
 
virtual int GetStartPiece ()
 
virtual void SetEndPiece (int)
 
virtual int GetEndPiece ()
 
virtual void SetFilePattern (const char *)
 This file pattern uses the file name and piece number to construct a file name for the piece file. More...
 
virtual char * GetFilePattern ()
 
virtual void SetUseRelativeFileNames (vtkTypeBool)
 This flag determines whether to use absolute paths for the piece files. More...
 
virtual vtkTypeBool GetUseRelativeFileNames ()
 
virtual void UseRelativeFileNamesOn ()
 
virtual void UseRelativeFileNamesOff ()
 
virtual void SetController (vtkMultiProcessController *)
 Controller used to communicate data type of blocks. More...
 
virtual vtkMultiProcessControllerGetController ()
 
- Public Member Functions inherited from vtkDataSetWriter
vtkDataSetWriterNewInstance () const
 
vtkDataSetGetInput ()
 Get the input to this writer. More...
 
vtkDataSetGetInput (int port)
 
- Public Member Functions inherited from vtkDataWriter
vtkDataWriterNewInstance () const
 
virtual void SetFileName (const char *)
 Specify file name of vtk polygon data file to write. 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 ()
 
virtual vtkIdType GetOutputStringLength ()
 When WriteToOutputString in on, then a string is allocated, written to, and can be retrieved with these methods. More...
 
virtual char * GetOutputString ()
 
unsigned char * GetBinaryOutputString ()
 
vtkStdString GetOutputStdString ()
 When WriteToOutputString is on, this method returns a copy of the output string in a vtkStdString. More...
 
char * RegisterAndGetOutputString ()
 This convenience method returns the string, sets the IVAR to nullptr, so that the user is responsible for deleting the string. More...
 
virtual void SetHeader (const char *)
 Specify the header for the vtk data file. More...
 
virtual char * GetHeader ()
 
virtual void SetWriteArrayMetaData (bool)
 If true, vtkInformation objects attached to arrays and array component nameswill be written to the output. More...
 
virtual bool GetWriteArrayMetaData ()
 
virtual void WriteArrayMetaDataOn ()
 
virtual void WriteArrayMetaDataOff ()
 
virtual void SetFileType (int)
 Specify file type (ASCII or BINARY) for vtk data file. More...
 
virtual int GetFileType ()
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetScalarsName (const char *)
 Give a name to the scalar data. More...
 
virtual char * GetScalarsName ()
 
virtual void SetVectorsName (const char *)
 Give a name to the vector data. More...
 
virtual char * GetVectorsName ()
 
virtual void SetTensorsName (const char *)
 Give a name to the tensors data. More...
 
virtual char * GetTensorsName ()
 
virtual void SetNormalsName (const char *)
 Give a name to the normals data. More...
 
virtual char * GetNormalsName ()
 
virtual void SetTCoordsName (const char *)
 Give a name to the texture coordinates data. More...
 
virtual char * GetTCoordsName ()
 
virtual void SetGlobalIdsName (const char *)
 Give a name to the global ids data. More...
 
virtual char * GetGlobalIdsName ()
 
virtual void SetPedigreeIdsName (const char *)
 Give a name to the pedigree ids data. More...
 
virtual char * GetPedigreeIdsName ()
 
virtual void SetEdgeFlagsName (const char *)
 Give a name to the edge flags data. More...
 
virtual char * GetEdgeFlagsName ()
 
virtual void SetLookupTableName (const char *)
 Give a name to the lookup table. More...
 
virtual char * GetLookupTableName ()
 
virtual void SetFieldDataName (const char *)
 Give a name to the field data. More...
 
virtual char * GetFieldDataName ()
 
virtual ostream * OpenVTKFile ()
 Open a vtk data file. More...
 
int WriteHeader (ostream *fp)
 Write the header of a vtk data file. More...
 
int WritePoints (ostream *fp, vtkPoints *p)
 Write out the points of the data set. More...
 
int WriteCoordinates (ostream *fp, vtkDataArray *coords, int axes)
 Write out coordinates for rectilinear grids. More...
 
int WriteCells (ostream *fp, vtkCellArray *cells, const char *label)
 Write out the cells of the data set. More...
 
int WriteCellData (ostream *fp, vtkDataSet *ds)
 Write the cell data (e.g., scalars, vectors, ...) of a vtk dataset. More...
 
int WritePointData (ostream *fp, vtkDataSet *ds)
 Write the point data (e.g., scalars, vectors, ...) of a vtk dataset. More...
 
int WriteEdgeData (ostream *fp, vtkGraph *g)
 Write the edge data (e.g., scalars, vectors, ...) of a vtk graph. More...
 
int WriteVertexData (ostream *fp, vtkGraph *g)
 Write the vertex data (e.g., scalars, vectors, ...) of a vtk graph. More...
 
int WriteRowData (ostream *fp, vtkTable *g)
 Write the row data (e.g., scalars, vectors, ...) of a vtk table. More...
 
int WriteFieldData (ostream *fp, vtkFieldData *f)
 Write out the field data. More...
 
int WriteDataSetData (ostream *fp, vtkDataSet *ds)
 Write out the data associated with the dataset (i.e. More...
 
void CloseVTKFile (ostream *fp)
 Close a vtk file. More...
 
- Public Member Functions inherited from vtkWriter
vtkWriterNewInstance () const
 
void EncodeString (char *resname, const char *name, bool doublePercent)
 Encode the string so that the reader will not have problems. More...
 
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
 Encode the string so that the reader will not have problems. More...
 
void SetInputData (vtkDataObject *input)
 Set/get the input to this writer. More...
 
void SetInputData (int index, vtkDataObject *input)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
- 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 vtkPDataSetWriterSafeDownCast (vtkObjectBase *o)
 
static vtkPDataSetWriterNew ()
 
- Static Public Member Functions inherited from vtkDataSetWriter
static vtkDataSetWriterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataWriter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataWriterSafeDownCast (vtkObjectBase *o)
 
static vtkDataWriterNew ()
 Created object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates. More...
 
- Static Public Member Functions inherited from vtkWriter
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWriterSafeDownCast (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 Types

typedef std::map< int, std::vector< int > > ExtentsType
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPDataSetWriter ()
 
 ~vtkPDataSetWriter () override
 
ostream * OpenFile ()
 
int WriteUnstructuredMetaData (vtkDataSet *input, char *root, char *str, size_t strSize, ostream *fptr)
 
int WriteImageMetaData (vtkImageData *input, char *root, char *str, size_t strSize, ostream *fptr)
 
int WriteRectilinearGridMetaData (vtkRectilinearGrid *input, char *root, char *str, size_t strSize, ostream *fptr)
 
int WriteStructuredGridMetaData (vtkStructuredGrid *input, char *root, char *str, size_t strSize, ostream *fptr)
 
void DeleteFiles ()
 
- Protected Member Functions inherited from vtkDataSetWriter
 vtkDataSetWriter ()
 
 ~vtkDataSetWriter () override
 
void WriteData () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkDataWriter
 vtkDataWriter ()
 
 ~vtkDataWriter () override
 
void WriteData () override
 
int WriteArray (ostream *fp, int dataType, vtkAbstractArray *data, const char *format, vtkIdType num, vtkIdType numComp)
 
int WriteScalarData (ostream *fp, vtkDataArray *s, vtkIdType num)
 
int WriteVectorData (ostream *fp, vtkDataArray *v, vtkIdType num)
 
int WriteNormalData (ostream *fp, vtkDataArray *n, vtkIdType num)
 
int WriteTCoordData (ostream *fp, vtkDataArray *tc, vtkIdType num)
 
int WriteTensorData (ostream *fp, vtkDataArray *t, vtkIdType num)
 
int WriteGlobalIdData (ostream *fp, vtkDataArray *g, vtkIdType num)
 
int WritePedigreeIdData (ostream *fp, vtkAbstractArray *p, vtkIdType num)
 
int WriteEdgeFlagsData (ostream *fp, vtkDataArray *edgeFlags, vtkIdType num)
 
bool CanWriteInformationKey (vtkInformation *info, vtkInformationKey *key)
 
int WriteInformation (ostream *fp, vtkInformation *info)
 Format is detailed here. More...
 
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 
 ~vtkWriter () override
 
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 RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- 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...
 
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 &)
 

Protected Attributes

int StartPiece
 
int EndPiece
 
int NumberOfPieces
 
int GhostLevel
 
vtkTypeBool UseRelativeFileNames
 
char * FilePattern
 
ExtentsType Extents
 
vtkMultiProcessControllerController
 
- Protected Attributes inherited from vtkDataWriter
vtkTypeBool WriteToOutputString
 
char * OutputString
 
vtkIdType OutputStringLength
 
char * FileName
 
char * Header
 
int FileType
 
bool WriteArrayMetaData
 
char * ScalarsName
 
char * VectorsName
 
char * TensorsName
 
char * TCoordsName
 
char * NormalsName
 
char * LookupTableName
 
char * FieldDataName
 
char * GlobalIdsName
 
char * PedigreeIdsName
 
char * EdgeFlagsName
 
std::locale CurrentLocale
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- 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 Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Manages writing pieces of a data set.

vtkPDataSetWriter will write a piece of a file, and will also create a metadata file that lists all of the files in a data set.

Tests:
vtkPDataSetWriter (Tests)

Definition at line 40 of file vtkPDataSetWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkPDataSetWriter.h.

◆ ExtentsType

typedef std::map<int, std::vector<int> > vtkPDataSetWriter::ExtentsType
protected

Definition at line 142 of file vtkPDataSetWriter.h.

Constructor & Destructor Documentation

◆ vtkPDataSetWriter()

vtkPDataSetWriter::vtkPDataSetWriter ( )
protected

◆ ~vtkPDataSetWriter()

vtkPDataSetWriter::~vtkPDataSetWriter ( )
overrideprotected

Member Function Documentation

◆ PrintSelf()

void vtkPDataSetWriter::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 vtkDataSetWriter.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPDataSetWriter::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 vtkDataSetWriter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPDataSetWriter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSetWriter.

◆ NewInstance()

vtkPDataSetWriter* vtkPDataSetWriter::NewInstance ( ) const

◆ New()

static vtkPDataSetWriter* vtkPDataSetWriter::New ( )
static

◆ Write()

int vtkPDataSetWriter::Write ( )
overridevirtual

Write the pvtk file and cooresponding vtk files.

Reimplemented from vtkWriter.

◆ SetNumberOfPieces()

void vtkPDataSetWriter::SetNumberOfPieces ( int  num)

This is how many pieces the whole data set will be divided into.

◆ GetNumberOfPieces()

virtual int vtkPDataSetWriter::GetNumberOfPieces ( )
virtual

◆ SetGhostLevel()

virtual void vtkPDataSetWriter::SetGhostLevel ( int  )
virtual

Extra ghost cells will be written out to each piece file if this value is larger than 0.

◆ GetGhostLevel()

virtual int vtkPDataSetWriter::GetGhostLevel ( )
virtual

◆ SetStartPiece()

virtual void vtkPDataSetWriter::SetStartPiece ( int  )
virtual

This is the range of pieces that that this writer is responsible for writing.

All pieces must be written by some process. The process that writes piece 0 also writes the pvtk file that lists all the piece file names.

◆ GetStartPiece()

virtual int vtkPDataSetWriter::GetStartPiece ( )
virtual

◆ SetEndPiece()

virtual void vtkPDataSetWriter::SetEndPiece ( int  )
virtual

◆ GetEndPiece()

virtual int vtkPDataSetWriter::GetEndPiece ( )
virtual

◆ SetFilePattern()

virtual void vtkPDataSetWriter::SetFilePattern ( const char *  )
virtual

This file pattern uses the file name and piece number to construct a file name for the piece file.

◆ GetFilePattern()

virtual char* vtkPDataSetWriter::GetFilePattern ( )
virtual

◆ SetUseRelativeFileNames()

virtual void vtkPDataSetWriter::SetUseRelativeFileNames ( vtkTypeBool  )
virtual

This flag determines whether to use absolute paths for the piece files.

By default the pieces are put in the main directory, and the piece file names in the meta data pvtk file are relative to this directory. This should make moving the whole lot to another directory, an easier task.

◆ GetUseRelativeFileNames()

virtual vtkTypeBool vtkPDataSetWriter::GetUseRelativeFileNames ( )
virtual

◆ UseRelativeFileNamesOn()

virtual void vtkPDataSetWriter::UseRelativeFileNamesOn ( )
virtual

◆ UseRelativeFileNamesOff()

virtual void vtkPDataSetWriter::UseRelativeFileNamesOff ( )
virtual

◆ SetController()

virtual void vtkPDataSetWriter::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* vtkPDataSetWriter::GetController ( )
virtual

◆ OpenFile()

ostream* vtkPDataSetWriter::OpenFile ( )
protected

◆ WriteUnstructuredMetaData()

int vtkPDataSetWriter::WriteUnstructuredMetaData ( vtkDataSet input,
char *  root,
char *  str,
size_t  strSize,
ostream *  fptr 
)
protected

◆ WriteImageMetaData()

int vtkPDataSetWriter::WriteImageMetaData ( vtkImageData input,
char *  root,
char *  str,
size_t  strSize,
ostream *  fptr 
)
protected

◆ WriteRectilinearGridMetaData()

int vtkPDataSetWriter::WriteRectilinearGridMetaData ( vtkRectilinearGrid input,
char *  root,
char *  str,
size_t  strSize,
ostream *  fptr 
)
protected

◆ WriteStructuredGridMetaData()

int vtkPDataSetWriter::WriteStructuredGridMetaData ( vtkStructuredGrid input,
char *  root,
char *  str,
size_t  strSize,
ostream *  fptr 
)
protected

◆ DeleteFiles()

void vtkPDataSetWriter::DeleteFiles ( )
protected

Member Data Documentation

◆ StartPiece

int vtkPDataSetWriter::StartPiece
protected

Definition at line 131 of file vtkPDataSetWriter.h.

◆ EndPiece

int vtkPDataSetWriter::EndPiece
protected

Definition at line 132 of file vtkPDataSetWriter.h.

◆ NumberOfPieces

int vtkPDataSetWriter::NumberOfPieces
protected

Definition at line 133 of file vtkPDataSetWriter.h.

◆ GhostLevel

int vtkPDataSetWriter::GhostLevel
protected

Definition at line 134 of file vtkPDataSetWriter.h.

◆ UseRelativeFileNames

vtkTypeBool vtkPDataSetWriter::UseRelativeFileNames
protected

Definition at line 136 of file vtkPDataSetWriter.h.

◆ FilePattern

char* vtkPDataSetWriter::FilePattern
protected

Definition at line 138 of file vtkPDataSetWriter.h.

◆ Extents

ExtentsType vtkPDataSetWriter::Extents
protected

Definition at line 143 of file vtkPDataSetWriter.h.

◆ Controller

vtkMultiProcessController* vtkPDataSetWriter::Controller
protected

Definition at line 145 of file vtkPDataSetWriter.h.


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