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

An abstract base class that implements all the common functionality for all particle readers. More...

#include <vtkAMRBaseParticlesReader.h>

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

Public Types

typedef vtkMultiBlockDataSetAlgorithm Superclass
 
- Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAMRBaseParticlesReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetNumberOfParticleArrays ()
 Get the number of particles arrays available in the input. More...
 
const char * GetParticleArrayName (int index)
 Get the particle array name of the array associated with the given index. More...
 
virtual void SetFileName (const char *fileName)
 
virtual char * GetFileName ()
 
virtual int GetTotalNumberOfParticles ()=0
 Returns the total number of particles. More...
 
virtual int GetFrequency ()
 Set & Get the frequency. More...
 
virtual void SetFrequency (int)
 Set & Get the frequency. More...
 
virtual vtkMultiProcessControllerGetController ()
 Set & Get the multi-process controller. More...
 
virtual void SetController (vtkMultiProcessController *)
 Set & Get the multi-process controller. More...
 
virtual void SetFilterLocation (vtkTypeBool)
 Set & Get for filter location and boolean macro. More...
 
virtual vtkTypeBool GetFilterLocation ()
 Set & Get for filter location and boolean macro. More...
 
virtual void FilterLocationOn ()
 Set & Get for filter location and boolean macro. More...
 
virtual void FilterLocationOff ()
 Set & Get for filter location and boolean macro. More...
 
virtual vtkDataArraySelectionGetParticleDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
int GetParticleArrayStatus (const char *name)
 Get/Set whether the particle array status. More...
 
void SetParticleArrayStatus (const char *name, int status)
 Get/Set whether the particle array status. More...
 
void SetMinLocation (const double minx, const double miny, const double minz)
 Sets the min location. More...
 
void SetMaxLocation (const double maxx, const double maxy, const double maxz)
 Sets the max location. More...
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=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 vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a 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 ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAMRBaseParticlesReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockDataSetAlgorithmSafeDownCast (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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAMRBaseParticlesReader ()
 
 ~vtkAMRBaseParticlesReader () override
 
virtual void ReadMetaData ()=0
 Reads the metadata, e.g., the number of blocks in the file. More...
 
virtual vtkPolyDataReadParticles (const int blkIdx)=0
 Reads the particles corresponding to the block associated with the given supplied block index. More...
 
bool CheckLocation (const double x, const double y, const double z)
 Filters particles by their location. More...
 
bool IsParallel ()
 Determines whether this reader instance is running in parallel or not. More...
 
bool IsBlockMine (const int blkIdx)
 Determines if the block associated with the given block index belongs to the process that executes the current instance of the reader. More...
 
int GetBlockProcessId (const int blkIdx)
 Given the block index, this method determines the process Id. More...
 
void Initialize ()
 Initializes the AMR Particles reader NOTE: must be called in the constructor of concrete classes. More...
 
void InitializeParticleDataSelections ()
 Initializes the ParticleDataArraySelection object. More...
 
virtual void SetupParticleDataSelections ()=0
 Sets up the ParticleDataArraySelection. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Standard pipeline operations. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Standard pipeline operations. More...
 
- Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
 vtkMultiBlockDataSetAlgorithm ()
 
 ~vtkMultiBlockDataSetAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 Call-back registered with the SelectionObserver for selecting/deselecting particles. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

int NumberOfBlocks
 
vtkTypeBool FilterLocation
 
double MinLocation [3]
 
double MaxLocation [3]
 
int Frequency
 
vtkMultiProcessControllerController
 
bool InitialRequest
 
bool Initialized
 
char * FileName
 
vtkDataArraySelectionParticleDataArraySelection
 Standard Array selection variables & methods. More...
 
vtkCallbackCommandSelectionObserver
 Standard Array selection variables & methods. More...
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

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

Detailed Description

An abstract base class that implements all the common functionality for all particle readers.

Definition at line 37 of file vtkAMRBaseParticlesReader.h.

Member Typedef Documentation

Definition at line 41 of file vtkAMRBaseParticlesReader.h.

Constructor & Destructor Documentation

vtkAMRBaseParticlesReader::vtkAMRBaseParticlesReader ( )
protected
vtkAMRBaseParticlesReader::~vtkAMRBaseParticlesReader ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkAMRBaseParticlesReader::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkAMRBaseParticlesReader::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

static vtkAMRBaseParticlesReader* vtkAMRBaseParticlesReader::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAMRBaseParticlesReader::NewInstanceInternal ( ) const
protectedvirtual
vtkAMRBaseParticlesReader* vtkAMRBaseParticlesReader::NewInstance ( ) const
void vtkAMRBaseParticlesReader::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 vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

virtual int vtkAMRBaseParticlesReader::GetFrequency ( )
virtual

Set & Get the frequency.

virtual void vtkAMRBaseParticlesReader::SetFrequency ( int  )
virtual

Set & Get the frequency.

virtual vtkMultiProcessController* vtkAMRBaseParticlesReader::GetController ( )
virtual

Set & Get the multi-process controller.

virtual void vtkAMRBaseParticlesReader::SetController ( vtkMultiProcessController )
virtual

Set & Get the multi-process controller.

virtual void vtkAMRBaseParticlesReader::SetFilterLocation ( vtkTypeBool  )
virtual

Set & Get for filter location and boolean macro.

virtual vtkTypeBool vtkAMRBaseParticlesReader::GetFilterLocation ( )
virtual

Set & Get for filter location and boolean macro.

virtual void vtkAMRBaseParticlesReader::FilterLocationOn ( )
virtual

Set & Get for filter location and boolean macro.

virtual void vtkAMRBaseParticlesReader::FilterLocationOff ( )
virtual

Set & Get for filter location and boolean macro.

virtual vtkDataArraySelection* vtkAMRBaseParticlesReader::GetParticleDataArraySelection ( )
virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

int vtkAMRBaseParticlesReader::GetNumberOfParticleArrays ( )

Get the number of particles arrays available in the input.

const char* vtkAMRBaseParticlesReader::GetParticleArrayName ( int  index)

Get the particle array name of the array associated with the given index.

int vtkAMRBaseParticlesReader::GetParticleArrayStatus ( const char *  name)

Get/Set whether the particle array status.

void vtkAMRBaseParticlesReader::SetParticleArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the particle array status.

virtual void vtkAMRBaseParticlesReader::SetFileName ( const char *  fileName)
virtual
virtual char* vtkAMRBaseParticlesReader::GetFileName ( )
virtual
void vtkAMRBaseParticlesReader::SetMinLocation ( const double  minx,
const double  miny,
const double  minz 
)
inline

Sets the min location.

Definition at line 105 of file vtkAMRBaseParticlesReader.h.

void vtkAMRBaseParticlesReader::SetMaxLocation ( const double  maxx,
const double  maxy,
const double  maxz 
)
inline

Sets the max location.

Definition at line 118 of file vtkAMRBaseParticlesReader.h.

virtual int vtkAMRBaseParticlesReader::GetTotalNumberOfParticles ( )
pure virtual

Returns the total number of particles.

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

virtual void vtkAMRBaseParticlesReader::ReadMetaData ( )
protectedpure virtual

Reads the metadata, e.g., the number of blocks in the file.

After the metadata is read, this->Initialized is set to true. Furthermore, to limit I/O, all concrete classes must make sure that this method returns immediately if this->Initialized is true.

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

virtual vtkPolyData* vtkAMRBaseParticlesReader::ReadParticles ( const int  blkIdx)
protectedpure virtual

Reads the particles corresponding to the block associated with the given supplied block index.

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

bool vtkAMRBaseParticlesReader::CheckLocation ( const double  x,
const double  y,
const double  z 
)
protected

Filters particles by their location.

If FilterLocation is ON, this method returns whether or not the particle with the supplied xyz coordinates class within the bounding box specified by the user using the SetMinLocation & SetMaxLocation.

bool vtkAMRBaseParticlesReader::IsParallel ( )
protected

Determines whether this reader instance is running in parallel or not.

bool vtkAMRBaseParticlesReader::IsBlockMine ( const int  blkIdx)
protected

Determines if the block associated with the given block index belongs to the process that executes the current instance of the reader.

int vtkAMRBaseParticlesReader::GetBlockProcessId ( const int  blkIdx)
protected

Given the block index, this method determines the process Id.

If the reader instance is serial this method always returns 0. Otherwise, static block-cyclic-distribution is assumed and each block is assigned to a process according to blkIdxN, where N is the total number of processes.

void vtkAMRBaseParticlesReader::Initialize ( )
protected

Initializes the AMR Particles reader NOTE: must be called in the constructor of concrete classes.

void vtkAMRBaseParticlesReader::InitializeParticleDataSelections ( )
protected

Initializes the ParticleDataArraySelection object.

This method only executes for an initial request in which case all arrays are deselected.

virtual void vtkAMRBaseParticlesReader::SetupParticleDataSelections ( )
protectedpure virtual

Sets up the ParticleDataArraySelection.

Implemented by concrete classes.

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

static void vtkAMRBaseParticlesReader::SelectionModifiedCallback ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
)
staticprotected

Call-back registered with the SelectionObserver for selecting/deselecting particles.

int vtkAMRBaseParticlesReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Standard pipeline operations.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

int vtkAMRBaseParticlesReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Standard pipeline operations.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Member Data Documentation

vtkDataArraySelection* vtkAMRBaseParticlesReader::ParticleDataArraySelection
protected

Standard Array selection variables & methods.

Definition at line 188 of file vtkAMRBaseParticlesReader.h.

vtkCallbackCommand* vtkAMRBaseParticlesReader::SelectionObserver
protected

Standard Array selection variables & methods.

Definition at line 189 of file vtkAMRBaseParticlesReader.h.

int vtkAMRBaseParticlesReader::NumberOfBlocks
protected

Definition at line 222 of file vtkAMRBaseParticlesReader.h.

vtkTypeBool vtkAMRBaseParticlesReader::FilterLocation
protected

Definition at line 224 of file vtkAMRBaseParticlesReader.h.

double vtkAMRBaseParticlesReader::MinLocation[3]
protected

Definition at line 225 of file vtkAMRBaseParticlesReader.h.

double vtkAMRBaseParticlesReader::MaxLocation[3]
protected

Definition at line 226 of file vtkAMRBaseParticlesReader.h.

int vtkAMRBaseParticlesReader::Frequency
protected

Definition at line 228 of file vtkAMRBaseParticlesReader.h.

vtkMultiProcessController* vtkAMRBaseParticlesReader::Controller
protected

Definition at line 229 of file vtkAMRBaseParticlesReader.h.

bool vtkAMRBaseParticlesReader::InitialRequest
protected

Definition at line 231 of file vtkAMRBaseParticlesReader.h.

bool vtkAMRBaseParticlesReader::Initialized
protected

Definition at line 232 of file vtkAMRBaseParticlesReader.h.

char* vtkAMRBaseParticlesReader::FileName
protected

Definition at line 233 of file vtkAMRBaseParticlesReader.h.


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