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

Superclass for parallel structured data XML readers. More...

#include <vtkXMLPStructuredDataReader.h>

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

Public Types

typedef vtkXMLPDataReader Superclass
 
- Public Types inherited from vtkXMLPDataReader
typedef vtkXMLPDataObjectReader Superclass
 
- Public Types inherited from vtkXMLPDataObjectReader
typedef vtkXMLReader Superclass
 
- Public Types inherited from vtkXMLReader
enum  FieldType { POINT_DATA , CELL_DATA , OTHER }
 
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.
 
vtkXMLPStructuredDataReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void CopyOutputInformation (vtkInformation *outInfo, int port) override
 
- Public Member Functions inherited from vtkXMLPDataReader
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLPDataReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void CopyOutputInformation (vtkInformation *outInfo, int port) override
 For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo.
 
- Public Member Functions inherited from vtkXMLPDataObjectReader
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLPDataObjectReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int GetNumberOfPieces ()
 Get the number of pieces from the summary file being read.
 
- Public Member Functions inherited from vtkXMLReader
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXMLReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int CanReadFile (VTK_FILEPATH const char *name)
 Test whether the file (type) with the given name can be read by this reader.
 
virtual void CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))
 
virtual int GetNumberOfTimeSteps ()
 
vtkXMLDataParserGetXMLParser ()
 Returns the internal XML parser.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
 vtkSetFilePathMacro (FileName)
 Get/Set the name of the input file.
 
 vtkGetFilePathMacro (FileName)
 Get/Set the name of the input file.
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString instead of the default, a file.
 
virtual vtkTypeBool GetReadFromInputString ()
 Enable reading from an InputString instead of the default, a file.
 
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString instead of the default, a file.
 
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString instead of the default, a file.
 
void SetInputString (const char *in)
 Specify the InputString for use when reading from a character array.
 
void SetInputString (const char *in, int len)
 Enable reading from an InputString instead of the default, a file.
 
void SetBinaryInputString (const char *, int len)
 Enable reading from an InputString instead of the default, a file.
 
void SetInputString (const std::string &input)
 Enable reading from an InputString instead of the default, a file.
 
virtual void SetInputArray (vtkCharArray *)
 Specify the vtkCharArray to be used when reading from a string.
 
vtkDataSetGetOutputAsDataSet ()
 Get the output as a vtkDataSet pointer.
 
vtkDataSetGetOutputAsDataSet (int index)
 Get the output as a vtkDataSet pointer.
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader.
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader.
 
virtual vtkDataArraySelectionGetColumnArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader.
 
int GetNumberOfPointArrays ()
 Get the number of point, cell or column arrays available in the input.
 
int GetNumberOfCellArrays ()
 Get the number of point, cell or column arrays available in the input.
 
int GetNumberOfColumnArrays ()
 Get the number of point, cell or column arrays available in the input.
 
int GetNumberOfTimeDataArrays () const
 Getters for time data array candidates.
 
const char * GetTimeDataArray (int idx) const
 Getters for time data array candidates.
 
virtual vtkStringArrayGetTimeDataStringArray ()
 Getters for time data array candidates.
 
virtual char * GetActiveTimeDataArrayName ()
 Setter / Getter on ActiveTimeDataArrayName.
 
virtual void SetActiveTimeDataArrayName (const char *)
 Setter / Getter on ActiveTimeDataArrayName.
 
const char * GetPointArrayName (int index)
 Get the name of the point, cell, column or time array with the given index in the input.
 
const char * GetCellArrayName (int index)
 Get the name of the point, cell, column or time array with the given index in the input.
 
const char * GetColumnArrayName (int index)
 Get the name of the point, cell, column or time array with the given index in the input.
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point, cell, column or time array with the given name is to be read.
 
int GetCellArrayStatus (const char *name)
 Get/Set whether the point, cell, column or time array with the given name is to be read.
 
void SetPointArrayStatus (const char *name, int status)
 Get/Set whether the point, cell, column or time array with the given name is to be read.
 
void SetCellArrayStatus (const char *name, int status)
 Get/Set whether the point, cell, column or time array with the given name is to be read.
 
int GetColumnArrayStatus (const char *name)
 Get/Set whether the point, cell, column or time array with the given name is to be read.
 
void SetColumnArrayStatus (const char *name, int status)
 Get/Set whether the point, cell, column or time array with the given name is to be read.
 
virtual void SetTimeStep (int)
 Which TimeStep to read.
 
virtual int GetTimeStep ()
 Which TimeStep to read.
 
virtual int * GetTimeStepRange ()
 Which TimeStepRange to read.
 
virtual void GetTimeStepRange (int &, int &)
 Which TimeStepRange to read.
 
virtual void GetTimeStepRange (int[2])
 Which TimeStepRange to read.
 
virtual void SetTimeStepRange (int, int)
 Which TimeStepRange to read.
 
void SetTimeStepRange (int[2])
 Which TimeStepRange to read.
 
void SetReaderErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.
 
virtual vtkCommandGetReaderErrorObserver ()
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.
 
void SetParserErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.
 
virtual vtkCommandGetParserErrorObserver ()
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual VTK_UNBLOCKTHREADS void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLPStructuredDataReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLPDataReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLPDataReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLPDataObjectReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLPDataObjectReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkXMLReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLReaderSafeDownCast (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.
 
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.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLPStructuredDataReader ()
 
 ~vtkXMLPStructuredDataReader () override
 
vtkIdType GetNumberOfPoints () override
 
vtkIdType GetNumberOfCells () override
 
void CopyArrayForPoints (vtkAbstractArray *inArray, vtkAbstractArray *outArray) override
 
void CopyArrayForCells (vtkAbstractArray *inArray, vtkAbstractArray *outArray) override
 
virtual void SetOutputExtent (int *extent)=0
 
virtual void GetPieceInputExtent (int index, int *extent)=0
 
void ReadXMLData () override
 Pipeline execution methods to be defined by subclass.
 
int ReadPrimaryElement (vtkXMLDataElement *ePrimary) override
 Read the information relative to the dataset and allocate the needed structures according to it.
 
void SetupOutputData () override
 Initialize the output data.
 
void SetupPieces (int numPieces) override
 Setup the number of pieces to be read and allocate space accordingly.
 
void DestroyPieces () override
 Delete all piece readers and related information.
 
int ReadPiece (vtkXMLDataElement *ePiece) override
 Setup the current piece reader.
 
int ReadPieceData () override
 Actually read the current piece data.
 
void CopySubExtent (int *inExtent, int *inDimensions, vtkIdType *inIncrements, int *outExtent, int *outDimensions, vtkIdType *outIncrements, int *subExtent, int *subDimensions, vtkAbstractArray *inArray, vtkAbstractArray *outArray)
 
int ComputePieceSubExtents ()
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- Protected Member Functions inherited from vtkXMLPDataReader
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLPDataReader ()
 
 ~vtkXMLPDataReader () override
 
void DestroyPieces () override
 Delete all piece readers and related information.
 
virtual vtkIdType GetNumberOfPoints ()=0
 
virtual vtkIdType GetNumberOfCells ()=0
 
vtkDataSetGetPieceInputAsDataSet (int piece)
 Get a given piece input as a dataset, return nullptr if there is none.
 
void SetupOutputData () override
 Initialize the output data.
 
void SetupOutputInformation (vtkInformation *outInfo) override
 Pipeline execute information driver.
 
void SetupPieces (int numPieces) override
 Setup the number of pieces to be read and allocate space accordingly.
 
int CanReadPiece (int index) override
 Whether or not the current reader can read the current piece.
 
virtual vtkXMLDataReaderCreatePieceReader ()=0
 Create a reader according to the data to read.
 
int ReadPiece (vtkXMLDataElement *ePiece) override
 Setup the current piece reader.
 
int ReadPieceData (int index)
 Actually read the piece at the given index data.
 
virtual int ReadPieceData ()
 Actually read the current piece data.
 
int ReadPrimaryElement (vtkXMLDataElement *ePrimary) override
 Read the information relative to the dataset and allocate the needed structures according to it.
 
virtual void CopyArrayForPoints (vtkAbstractArray *inArray, vtkAbstractArray *outArray)=0
 
virtual void CopyArrayForCells (vtkAbstractArray *inArray, vtkAbstractArray *outArray)=0
 
void PieceProgressCallback () override
 Callback registered with the PieceProgressObserver.
 
int ReadPiece (vtkXMLDataElement *ePiece, int index)
 Setup the piece reader at the given index.
 
virtual int ReadPiece (vtkXMLDataElement *ePiece)=0
 Setup the current piece reader.
 
- Protected Member Functions inherited from vtkXMLPDataObjectReader
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLPDataObjectReader ()
 
 ~vtkXMLPDataObjectReader () override
 
virtual void DestroyPieces ()
 Delete all piece readers and related information.
 
void SetupOutputData () override
 Initialize the output data.
 
virtual void SetupPieces (int numPieces)
 Setup the number of pieces to be read and allocate space accordingly.
 
int ReadXMLInformation () override
 Pipeline execute information driver.
 
virtual int CanReadPiece (int index)=0
 Whether or not the current reader can read the current piece.
 
int ReadPiece (vtkXMLDataElement *ePiece, int index)
 Setup the piece reader at the given index.
 
virtual int ReadPiece (vtkXMLDataElement *ePiece)=0
 Setup the current piece reader.
 
char * CreatePieceFileName (const char *fileName)
 Methods for creating a filename for each piece in the dataset.
 
void SplitFileName ()
 Methods for creating a filename for each piece in the dataset.
 
- Protected Member Functions inherited from vtkXMLReader
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLReader ()
 
 ~vtkXMLReader () override
 
virtual const char * GetDataSetName ()=0
 Get the name of the data set being read.
 
virtual int CanReadFileVersion (int major, int minor)
 Test if the reader can read a file with the given version number.
 
virtual void SetupEmptyOutput ()=0
 Setup the output with no data available.
 
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
 Setup the output's information.
 
virtual void SetupOutputData ()
 Setup the output's data with allocation.
 
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
 Read the primary element from the file.
 
virtual int ReadVTKFile (vtkXMLDataElement *eVTKFile)
 Read the top-level element from the file.
 
int GetLocalDataType (vtkXMLDataElement *da, int datatype)
 If the IdType argument is present in the provided XMLDataElement and the provided dataType has the same size with VTK_ID_TYPE on this build of VTK, returns VTK_ID_TYPE.
 
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
 Create a vtkAbstractArray from its corresponding XML representation.
 
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
 Create a vtkInformationKey from its corresponding XML representation.
 
bool ReadInformation (vtkXMLDataElement *infoRoot, vtkInformation *info)
 Populates the info object with the InformationKey children in infoRoot.
 
virtual int CanReadFileWithDataType (const char *dsname)
 This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name.
 
virtual int GetFileMajorVersion ()
 Returns the major version for the file being read.
 
virtual int GetFileMinorVersion ()
 Returns the minor version for the file being read.
 
virtual int ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues, FieldType type=OTHER)
 Read an Array values starting at the given index and up to numValues.
 
virtual int ReadArrayTuples (vtkXMLDataElement *da, vtkIdType arrayTupleIndex, vtkAbstractArray *array, vtkIdType startTupleIndex, vtkIdType numTuples, FieldType type=OTHER)
 Read an Array values starting at the given tuple index and up to numTuples taking into account the number of components declared in array.
 
void SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)
 Setup the data array selections for the input's set of arrays.
 
int SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, vtkIdType numTuples, vtkInformationVector *(&infoVector))
 
virtual void SqueezeOutputArrays (vtkDataObject *)
 Give concrete classes an option to squeeze any output arrays at the end of RequestData.
 
void MarkIdTypeArrays (vtkXMLDataElement *da)
 XML files have not consistently saved out adequate meta-data in past to correctly create vtkIdTypeArray for global ids and pedigree ids.
 
virtual void GetProgressRange (float *range)
 
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 UpdateProgressDiscrete (float progress)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(outputVector))
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void SetNumberOfTimeSteps (int num)
 
vtkDataObjectGetCurrentOutput ()
 
vtkInformationGetCurrentOutputInformation ()
 
virtual void ConvertGhostLevelsToGhostType (FieldType, vtkAbstractArray *, vtkIdType, vtkIdType)
 
void ReadFieldData ()
 
virtual int OpenStream ()
 Internal utility methods.
 
virtual void CloseStream ()
 Internal utility methods.
 
virtual int OpenVTKFile ()
 Internal utility methods.
 
virtual void CloseVTKFile ()
 Internal utility methods.
 
virtual int OpenVTKString ()
 Internal utility methods.
 
virtual void CloseVTKString ()
 Internal utility methods.
 
virtual void CreateXMLParser ()
 Internal utility methods.
 
virtual void DestroyXMLParser ()
 Internal utility methods.
 
void SetupCompressor (const char *type)
 Internal utility methods.
 
int CanReadFileVersionString (const char *version)
 Internal utility methods.
 
int IntersectExtents (int *extent1, int *extent2, int *result)
 Utility methods for subclasses.
 
int Min (int a, int b)
 Utility methods for subclasses.
 
int Max (int a, int b)
 Utility methods for subclasses.
 
void ComputePointDimensions (int *extent, int *dimensions)
 Utility methods for subclasses.
 
void ComputePointIncrements (int *extent, vtkIdType *increments)
 Utility methods for subclasses.
 
void ComputeCellDimensions (int *extent, int *dimensions)
 Utility methods for subclasses.
 
void ComputeCellIncrements (int *extent, vtkIdType *increments)
 Utility methods for subclasses.
 
vtkIdType GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)
 Utility methods for subclasses.
 
void ReadAttributeIndices (vtkXMLDataElement *eDSA, vtkDataSetAttributes *dsa)
 Utility methods for subclasses.
 
char ** CreateStringArray (int numStrings)
 Utility methods for subclasses.
 
void DestroyStringArray (int numStrings, char **strings)
 Utility methods for subclasses.
 
int PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)
 Check whether the given array element is an enabled array.
 
int CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)
 Check whether the given array element is an enabled array.
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkExtentSplitterExtentSplitter
 
int UpdateExtent [6]
 
int PointDimensions [3]
 
vtkIdType PointIncrements [3]
 
int CellDimensions [3]
 
vtkIdType CellIncrements [3]
 
int SubExtent [6]
 
int SubPointDimensions [3]
 
int SubCellDimensions [3]
 
int SubPieceExtent [6]
 
int SubPiecePointDimensions [3]
 
vtkIdType SubPiecePointIncrements [3]
 
int SubPieceCellDimensions [3]
 
vtkIdType SubPieceCellIncrements [3]
 
int * PieceExtents
 
- Protected Attributes inherited from vtkXMLPDataReader
int GhostLevel
 The ghost level available on each input piece.
 
vtkXMLDataReader ** PieceReaders
 Information per-piece.
 
vtkXMLDataElementPPointDataElement
 The PPointData and PCellData element representations.
 
vtkXMLDataElementPCellDataElement
 
- Protected Attributes inherited from vtkXMLPDataObjectReader
int NumberOfPieces
 Pieces from the input summary file.
 
int Piece
 The piece currently being read.
 
char * PathName
 The path to the input file without the file name.
 
vtkCallbackCommandPieceProgressObserver
 
vtkXMLDataElement ** PieceElements
 Information per-piece.
 
int * CanReadPieceFlag
 Information per-piece.
 
- Protected Attributes inherited from vtkXMLReader
vtkXMLDataParserXMLParser
 
vtkXMLDataElementFieldDataElement
 
char * FileName
 
istream * Stream
 
vtkTypeBool ReadFromInputString
 
std::string InputString
 
vtkCharArrayInputArray
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkDataArraySelectionColumnArraySelection
 
vtkStringArrayTimeDataStringArray
 
char * ActiveTimeDataArrayName
 Name of the field-data array used to determine the time for the dataset being read.
 
vtkSmartPointer< vtkDataArrayTimeDataArray
 Populated in ReadXMLInformation from the field data for the array chosen using ActiveTimeDataArrayName, if any.
 
vtkCallbackCommandSelectionObserver
 
int InformationError
 
int DataError
 
float ProgressRange [2]
 
vtkTimeStamp ReadMTime
 
int ReadError
 
int AxesEmpty [3]
 
int TimeStep
 
int CurrentTimeStep
 
int NumberOfTimeSteps
 
int * TimeSteps
 
int TimeStepRange [2]
 
int InReadData
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkXMLPDataObjectReader
static void PieceProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
 Callback registered with the PieceProgressObserver.
 
- Static Protected Member Functions inherited from vtkXMLReader
static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 Callback registered with the SelectionObserver.
 
static int IsTimeStepInArray (int timestep, int *timesteps, int length)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Superclass for parallel structured data XML readers.

vtkXMLPStructuredDataReader provides functionality common to all parallel structured data format readers.

See also
vtkXMLPImageDataReader vtkXMLPStructuredGridReader vtkXMLPRectilinearGridReader

Definition at line 26 of file vtkXMLPStructuredDataReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkXMLPStructuredDataReader.h.

Constructor & Destructor Documentation

◆ vtkXMLPStructuredDataReader()

vtkXMLPStructuredDataReader::vtkXMLPStructuredDataReader ( )
protected

◆ ~vtkXMLPStructuredDataReader()

vtkXMLPStructuredDataReader::~vtkXMLPStructuredDataReader ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkXMLPStructuredDataReader::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 vtkXMLPDataReader.

Reimplemented in vtkXMLPImageDataReader, vtkXMLPRectilinearGridReader, and vtkXMLPStructuredGridReader.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLPStructuredDataReader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkXMLPStructuredDataReader * vtkXMLPStructuredDataReader::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLPStructuredDataReader::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 vtkXMLPDataReader.

Reimplemented in vtkXMLPStructuredGridReader.

◆ CopyOutputInformation()

void vtkXMLPStructuredDataReader::CopyOutputInformation ( vtkInformation outInfo,
int  port 
)
override

◆ GetNumberOfPoints()

vtkIdType vtkXMLPStructuredDataReader::GetNumberOfPoints ( )
overrideprotectedvirtual

Implements vtkXMLPDataReader.

◆ GetNumberOfCells()

vtkIdType vtkXMLPStructuredDataReader::GetNumberOfCells ( )
overrideprotectedvirtual

Implements vtkXMLPDataReader.

◆ CopyArrayForPoints()

void vtkXMLPStructuredDataReader::CopyArrayForPoints ( vtkAbstractArray inArray,
vtkAbstractArray outArray 
)
overrideprotectedvirtual

Implements vtkXMLPDataReader.

◆ CopyArrayForCells()

void vtkXMLPStructuredDataReader::CopyArrayForCells ( vtkAbstractArray inArray,
vtkAbstractArray outArray 
)
overrideprotectedvirtual

Implements vtkXMLPDataReader.

◆ SetOutputExtent()

virtual void vtkXMLPStructuredDataReader::SetOutputExtent ( int *  extent)
protectedpure virtual

◆ GetPieceInputExtent()

virtual void vtkXMLPStructuredDataReader::GetPieceInputExtent ( int  index,
int *  extent 
)
protectedpure virtual

◆ ReadXMLData()

void vtkXMLPStructuredDataReader::ReadXMLData ( )
overrideprotectedvirtual

Pipeline execution methods to be defined by subclass.

Called by corresponding RequestData methods after appropriate setup has been done.

Reimplemented from vtkXMLReader.

◆ ReadPrimaryElement()

int vtkXMLPStructuredDataReader::ReadPrimaryElement ( vtkXMLDataElement ePrimary)
overrideprotectedvirtual

Read the information relative to the dataset and allocate the needed structures according to it.

Reimplemented from vtkXMLPDataReader.

Reimplemented in vtkXMLPStructuredGridReader.

◆ SetupOutputData()

void vtkXMLPStructuredDataReader::SetupOutputData ( )
overrideprotectedvirtual

Initialize the output data.

Reimplemented from vtkXMLPDataReader.

Reimplemented in vtkXMLPStructuredGridReader.

◆ SetupPieces()

void vtkXMLPStructuredDataReader::SetupPieces ( int  numPieces)
overrideprotectedvirtual

Setup the number of pieces to be read and allocate space accordingly.

Reimplemented from vtkXMLPDataReader.

◆ DestroyPieces()

void vtkXMLPStructuredDataReader::DestroyPieces ( )
overrideprotectedvirtual

Delete all piece readers and related information.

Reimplemented from vtkXMLPDataReader.

◆ ReadPiece()

int vtkXMLPStructuredDataReader::ReadPiece ( vtkXMLDataElement ePiece)
overrideprotectedvirtual

Setup the current piece reader.

Reimplemented from vtkXMLPDataReader.

◆ ReadPieceData()

int vtkXMLPStructuredDataReader::ReadPieceData ( )
overrideprotectedvirtual

Actually read the current piece data.

Reimplemented from vtkXMLPDataReader.

Reimplemented in vtkXMLPStructuredGridReader.

◆ CopySubExtent()

void vtkXMLPStructuredDataReader::CopySubExtent ( int *  inExtent,
int *  inDimensions,
vtkIdType inIncrements,
int *  outExtent,
int *  outDimensions,
vtkIdType outIncrements,
int *  subExtent,
int *  subDimensions,
vtkAbstractArray inArray,
vtkAbstractArray outArray 
)
protected

◆ ComputePieceSubExtents()

int vtkXMLPStructuredDataReader::ComputePieceSubExtents ( )
protected

◆ RequestInformation()

int vtkXMLPStructuredDataReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkXMLReader.

Member Data Documentation

◆ ExtentSplitter

vtkExtentSplitter* vtkXMLPStructuredDataReader::ExtentSplitter
protected

Definition at line 63 of file vtkXMLPStructuredDataReader.h.

◆ UpdateExtent

int vtkXMLPStructuredDataReader::UpdateExtent[6]
protected

Definition at line 66 of file vtkXMLPStructuredDataReader.h.

◆ PointDimensions

int vtkXMLPStructuredDataReader::PointDimensions[3]
protected

Definition at line 67 of file vtkXMLPStructuredDataReader.h.

◆ PointIncrements

vtkIdType vtkXMLPStructuredDataReader::PointIncrements[3]
protected

Definition at line 68 of file vtkXMLPStructuredDataReader.h.

◆ CellDimensions

int vtkXMLPStructuredDataReader::CellDimensions[3]
protected

Definition at line 69 of file vtkXMLPStructuredDataReader.h.

◆ CellIncrements

vtkIdType vtkXMLPStructuredDataReader::CellIncrements[3]
protected

Definition at line 70 of file vtkXMLPStructuredDataReader.h.

◆ SubExtent

int vtkXMLPStructuredDataReader::SubExtent[6]
protected

Definition at line 73 of file vtkXMLPStructuredDataReader.h.

◆ SubPointDimensions

int vtkXMLPStructuredDataReader::SubPointDimensions[3]
protected

Definition at line 74 of file vtkXMLPStructuredDataReader.h.

◆ SubCellDimensions

int vtkXMLPStructuredDataReader::SubCellDimensions[3]
protected

Definition at line 75 of file vtkXMLPStructuredDataReader.h.

◆ SubPieceExtent

int vtkXMLPStructuredDataReader::SubPieceExtent[6]
protected

Definition at line 76 of file vtkXMLPStructuredDataReader.h.

◆ SubPiecePointDimensions

int vtkXMLPStructuredDataReader::SubPiecePointDimensions[3]
protected

Definition at line 77 of file vtkXMLPStructuredDataReader.h.

◆ SubPiecePointIncrements

vtkIdType vtkXMLPStructuredDataReader::SubPiecePointIncrements[3]
protected

Definition at line 78 of file vtkXMLPStructuredDataReader.h.

◆ SubPieceCellDimensions

int vtkXMLPStructuredDataReader::SubPieceCellDimensions[3]
protected

Definition at line 79 of file vtkXMLPStructuredDataReader.h.

◆ SubPieceCellIncrements

vtkIdType vtkXMLPStructuredDataReader::SubPieceCellIncrements[3]
protected

Definition at line 80 of file vtkXMLPStructuredDataReader.h.

◆ PieceExtents

int* vtkXMLPStructuredDataReader::PieceExtents
protected

Definition at line 83 of file vtkXMLPStructuredDataReader.h.


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