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

Read ADIOS2 streams using Fides data model. More...

#include <vtkFidesReader.h>

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

Public Types

enum  StepStatus { OK , NotReady , EndOfStream }
 When using streaming mode instead of random access, PrepareNextStep receives a step status from Fides/ADIOS. More...
 
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...
 
vtkFidesReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int CanReadFile (VTK_FILEPATH const std::string &name)
 Test whether or not a given file should even be attempted for use with this reader. More...
 
void SetFileName (VTK_FILEPATH const std::string &fname)
 Set the filename to be read. More...
 
void SetDataSourcePath (const std::string &name, VTK_FILEPATH const std::string &path)
 Set the path for a Fides data source. More...
 
void SetDataSourceEngine (const std::string &name, const std::string &engine)
 Set the engine for a Fides data source. More...
 
void SetDataSourceIO (const std::string &name, const std::string &ioAddress)
 Set the ADIOS2::IO object to be used for setting up the Inline engine reader. More...
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Implements various pipeline passes. More...
 
void PrepareNextStep ()
 This method has to be called before each step when streaming. More...
 
int GetNextStepStatus ()
 Get the StepStatus of the next step reported by Fides. More...
 
double GetTimeOfCurrentStep ()
 Gets the time (from the specified ADIOS variable) of the current step. More...
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Object to perform point array selection before update. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 Object to perform cell array selection before update. More...
 
virtual vtkDataArraySelectionGetFieldDataArraySelection ()
 Object to perform field array selection before update. More...
 
vtkMTimeType GetMTime () override
 Overridden to take into account mtimes for vtkDataArraySelection instances. More...
 
void ParseDataModel (VTK_FILEPATH const std::string &fname)
 Given a json filename, parse and internally store a data model. More...
 
void ParseDataModel ()
 Given a json filename, parse and internally store a data model. More...
 
virtual void ConvertToVTKOn ()
 Methods to determine whether to output a set of vtkmDataSets or native VTK datasets. More...
 
virtual void ConvertToVTKOff ()
 Methods to determine whether to output a set of vtkmDataSets or native VTK datasets. More...
 
virtual void SetConvertToVTK (bool)
 Methods to determine whether to output a set of vtkmDataSets or native VTK datasets. More...
 
virtual bool GetConvertToVTK ()
 Methods to determine whether to output a set of vtkmDataSets or native VTK datasets. More...
 
virtual void StreamStepsOn ()
 Methods to determine whether streaming mode is used. More...
 
virtual void StreamStepsOff ()
 Methods to determine whether streaming mode is used. More...
 
virtual void SetStreamSteps (bool)
 Methods to determine whether streaming mode is used. More...
 
virtual bool GetStreamSteps ()
 Methods to determine whether streaming mode is used. More...
 
virtual void CreateSharedPointsOn ()
 Determines whether to close gaps between blocks of structured grids with the use of shared points. More...
 
virtual void CreateSharedPointsOff ()
 Determines whether to close gaps between blocks of structured grids with the use of shared points. More...
 
virtual void SetCreateSharedPoints (bool)
 Determines whether to close gaps between blocks of structured grids with the use of shared points. More...
 
virtual bool GetCreateSharedPoints ()
 Determines whether to close gaps between blocks of structured grids with the use of shared points. More...
 
int GetNumberOfPointArrays ()
 Get the number of point or cell arrays available in the input. More...
 
int GetNumberOfCellArrays ()
 Get the number of point or cell arrays available in the input. More...
 
int GetNumberOfFieldArrays ()
 Get the number of point or cell arrays available in the input. More...
 
const char * GetPointArrayName (int index)
 Get the name of the point or cell array with the given index in the input. More...
 
const char * GetCellArrayName (int index)
 Get the name of the point or cell array with the given index in the input. More...
 
const char * GetFieldArrayName (int index)
 Get the name of the point or cell array with the given index in the input. More...
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
int GetCellArrayStatus (const char *name)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
int GetFieldArrayStatus (const char *name)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
void SetPointArrayStatus (const char *name, int status)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
void SetCellArrayStatus (const char *name, int status)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
void SetFieldArrayStatus (const char *name, int status)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
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 SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. 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 vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. 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...
 
bool UsesGarbageCollector () const 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 SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. 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 (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool 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...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (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...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). 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...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkFidesReaderSafeDownCast (vtkObjectBase *o)
 
static vtkFidesReaderNew ()
 Construct a new reader instance. More...
 
- 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 vtkInformationIntegerKeyABORTED ()
 
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 (vtkTypeBool 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 vtkTypeBool 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFidesReader ()
 
 ~vtkFidesReader () override
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int ADIOSAttributeCheck (const std::string &name)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::unique_ptr< vtkFidesReaderImpl > Impl
 
std::string FileName
 
bool ConvertToVTK
 
bool StreamSteps
 
StepStatus NextStepStatus
 
bool CreateSharedPoints
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkDataArraySelectionFieldDataArraySelection
 
- 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. More...
 
- 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 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

Read ADIOS2 streams using Fides data model.

vtkFidesReader is a data source that reads ADIOS2 files or data streams (SST engine, inline engine etc.). The data model in these data streams is defined by the Fides library: (https://gitlab.kitware.com/vtk/fides/) See the Fides documentation for the details of the schema used to represent VTK/VTK-m data models. The reader can create partitioned dataset collection containing native VTK dataset or VTK VTK-m datasets. Time and time streaming is supported. Note that the interface for time streaming is different. It requires calling PrepareNextStep() and Update() for each new step. Partitioned (in ADIOS2 terminology blocks) data is supported.

Tests:
vtkFidesReader (Tests)

Definition at line 36 of file vtkFidesReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkFidesReader.h.

Member Enumeration Documentation

◆ StepStatus

When using streaming mode instead of random access, PrepareNextStep receives a step status from Fides/ADIOS.

Enumerator
OK 
NotReady 
EndOfStream 

Definition at line 43 of file vtkFidesReader.h.

Constructor & Destructor Documentation

◆ vtkFidesReader()

vtkFidesReader::vtkFidesReader ( )
protected

◆ ~vtkFidesReader()

vtkFidesReader::~vtkFidesReader ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkFidesReader::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 vtkAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFidesReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAlgorithm.

◆ NewInstance()

vtkFidesReader* vtkFidesReader::NewInstance ( ) const

◆ PrintSelf()

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

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

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

Reimplemented from vtkAlgorithm.

◆ New()

static vtkFidesReader* vtkFidesReader::New ( )
static

Construct a new reader instance.

◆ CanReadFile()

int vtkFidesReader::CanReadFile ( VTK_FILEPATH const std::string &  name)

Test whether or not a given file should even be attempted for use with this reader.

◆ SetFileName()

void vtkFidesReader::SetFileName ( VTK_FILEPATH const std::string &  fname)

Set the filename to be read.

◆ ParseDataModel() [1/2]

void vtkFidesReader::ParseDataModel ( VTK_FILEPATH const std::string &  fname)

Given a json filename, parse and internally store a data model.

Has to be called before any data input can take place. See the Fides documentation for the description of the schema.

◆ ParseDataModel() [2/2]

void vtkFidesReader::ParseDataModel ( )

Given a json filename, parse and internally store a data model.

Has to be called before any data input can take place. See the Fides documentation for the description of the schema.

◆ SetDataSourcePath()

void vtkFidesReader::SetDataSourcePath ( const std::string &  name,
VTK_FILEPATH const std::string &  path 
)

Set the path for a Fides data source.

This can be a file, an SST stream or an inline data source. The name of the data source corresponds to what is in the data model.

◆ SetDataSourceEngine()

void vtkFidesReader::SetDataSourceEngine ( const std::string &  name,
const std::string &  engine 
)

Set the engine for a Fides data source.

Defaults to BP engine.

◆ SetDataSourceIO()

void vtkFidesReader::SetDataSourceIO ( const std::string &  name,
const std::string &  ioAddress 
)

Set the ADIOS2::IO object to be used for setting up the Inline engine reader.

This should not be used for any other engine type. ioAddress is a string containing the address of the IO object, which Fides will cast to a IO pointer.

◆ ProcessRequest()

int vtkFidesReader::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overridevirtual

Implements various pipeline passes.

Reimplemented from vtkAlgorithm.

◆ PrepareNextStep()

void vtkFidesReader::PrepareNextStep ( )

This method has to be called before each step when streaming.

It will move to the next step and initialize any meta-data necessary. The loading of the next step is done in the update pipeline pass. Note that this internally calls Modified() on the reader to force the next update to cause an execution.

◆ GetNextStepStatus()

int vtkFidesReader::GetNextStepStatus ( )

Get the StepStatus of the next step reported by Fides.

See enum vtkFidesReader::StepStatus for potential return values. This is updated in PrepareNextStep() and set back to NotReady after reading a step.

◆ GetTimeOfCurrentStep()

double vtkFidesReader::GetTimeOfCurrentStep ( )

Gets the time (from the specified ADIOS variable) of the current step.

Should only be used in streaming mode.

◆ ConvertToVTKOn()

virtual void vtkFidesReader::ConvertToVTKOn ( )
virtual

Methods to determine whether to output a set of vtkmDataSets or native VTK datasets.

If the pipeline following the reader is mainly VTK filters (as opposed to VTK-m accelerated VTK filters), set this to on. False by default.

◆ ConvertToVTKOff()

virtual void vtkFidesReader::ConvertToVTKOff ( )
virtual

Methods to determine whether to output a set of vtkmDataSets or native VTK datasets.

If the pipeline following the reader is mainly VTK filters (as opposed to VTK-m accelerated VTK filters), set this to on. False by default.

◆ SetConvertToVTK()

virtual void vtkFidesReader::SetConvertToVTK ( bool  )
virtual

Methods to determine whether to output a set of vtkmDataSets or native VTK datasets.

If the pipeline following the reader is mainly VTK filters (as opposed to VTK-m accelerated VTK filters), set this to on. False by default.

◆ GetConvertToVTK()

virtual bool vtkFidesReader::GetConvertToVTK ( )
virtual

Methods to determine whether to output a set of vtkmDataSets or native VTK datasets.

If the pipeline following the reader is mainly VTK filters (as opposed to VTK-m accelerated VTK filters), set this to on. False by default.

◆ StreamStepsOn()

virtual void vtkFidesReader::StreamStepsOn ( )
virtual

Methods to determine whether streaming mode is used.

False by default.

◆ StreamStepsOff()

virtual void vtkFidesReader::StreamStepsOff ( )
virtual

Methods to determine whether streaming mode is used.

False by default.

◆ SetStreamSteps()

virtual void vtkFidesReader::SetStreamSteps ( bool  )
virtual

Methods to determine whether streaming mode is used.

False by default.

◆ GetStreamSteps()

virtual bool vtkFidesReader::GetStreamSteps ( )
virtual

Methods to determine whether streaming mode is used.

False by default.

◆ CreateSharedPointsOn()

virtual void vtkFidesReader::CreateSharedPointsOn ( )
virtual

Determines whether to close gaps between blocks of structured grids with the use of shared points.

◆ CreateSharedPointsOff()

virtual void vtkFidesReader::CreateSharedPointsOff ( )
virtual

Determines whether to close gaps between blocks of structured grids with the use of shared points.

◆ SetCreateSharedPoints()

virtual void vtkFidesReader::SetCreateSharedPoints ( bool  )
virtual

Determines whether to close gaps between blocks of structured grids with the use of shared points.

◆ GetCreateSharedPoints()

virtual bool vtkFidesReader::GetCreateSharedPoints ( )
virtual

Determines whether to close gaps between blocks of structured grids with the use of shared points.

◆ GetPointDataArraySelection()

virtual vtkDataArraySelection* vtkFidesReader::GetPointDataArraySelection ( )
virtual

Object to perform point array selection before update.

◆ GetCellDataArraySelection()

virtual vtkDataArraySelection* vtkFidesReader::GetCellDataArraySelection ( )
virtual

Object to perform cell array selection before update.

◆ GetFieldDataArraySelection()

virtual vtkDataArraySelection* vtkFidesReader::GetFieldDataArraySelection ( )
virtual

Object to perform field array selection before update.

◆ GetNumberOfPointArrays()

int vtkFidesReader::GetNumberOfPointArrays ( )

Get the number of point or cell arrays available in the input.

◆ GetNumberOfCellArrays()

int vtkFidesReader::GetNumberOfCellArrays ( )

Get the number of point or cell arrays available in the input.

◆ GetNumberOfFieldArrays()

int vtkFidesReader::GetNumberOfFieldArrays ( )

Get the number of point or cell arrays available in the input.

◆ GetPointArrayName()

const char* vtkFidesReader::GetPointArrayName ( int  index)

Get the name of the point or cell array with the given index in the input.

◆ GetCellArrayName()

const char* vtkFidesReader::GetCellArrayName ( int  index)

Get the name of the point or cell array with the given index in the input.

◆ GetFieldArrayName()

const char* vtkFidesReader::GetFieldArrayName ( int  index)

Get the name of the point or cell array with the given index in the input.

◆ GetPointArrayStatus()

int vtkFidesReader::GetPointArrayStatus ( const char *  name)

Get/Set whether the point or cell array with the given name is to be read.

◆ GetCellArrayStatus()

int vtkFidesReader::GetCellArrayStatus ( const char *  name)

Get/Set whether the point or cell array with the given name is to be read.

◆ GetFieldArrayStatus()

int vtkFidesReader::GetFieldArrayStatus ( const char *  name)

Get/Set whether the point or cell array with the given name is to be read.

◆ SetPointArrayStatus()

void vtkFidesReader::SetPointArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point or cell array with the given name is to be read.

◆ SetCellArrayStatus()

void vtkFidesReader::SetCellArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point or cell array with the given name is to be read.

◆ SetFieldArrayStatus()

void vtkFidesReader::SetFieldArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point or cell array with the given name is to be read.

◆ GetMTime()

vtkMTimeType vtkFidesReader::GetMTime ( )
overridevirtual

Overridden to take into account mtimes for vtkDataArraySelection instances.

Reimplemented from vtkObject.

◆ RequestDataObject()

virtual int vtkFidesReader::RequestDataObject ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

◆ RequestInformation()

virtual int vtkFidesReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

◆ RequestData()

virtual int vtkFidesReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

◆ FillOutputPortInformation()

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

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

◆ ADIOSAttributeCheck()

int vtkFidesReader::ADIOSAttributeCheck ( const std::string &  name)
protected

Member Data Documentation

◆ Impl

std::unique_ptr<vtkFidesReaderImpl> vtkFidesReader::Impl
protected

Definition at line 215 of file vtkFidesReader.h.

◆ FileName

std::string vtkFidesReader::FileName
protected

Definition at line 217 of file vtkFidesReader.h.

◆ ConvertToVTK

bool vtkFidesReader::ConvertToVTK
protected

Definition at line 218 of file vtkFidesReader.h.

◆ StreamSteps

bool vtkFidesReader::StreamSteps
protected

Definition at line 219 of file vtkFidesReader.h.

◆ NextStepStatus

StepStatus vtkFidesReader::NextStepStatus
protected

Definition at line 220 of file vtkFidesReader.h.

◆ CreateSharedPoints

bool vtkFidesReader::CreateSharedPoints
protected

Definition at line 221 of file vtkFidesReader.h.

◆ PointDataArraySelection

vtkDataArraySelection* vtkFidesReader::PointDataArraySelection
protected

Definition at line 232 of file vtkFidesReader.h.

◆ CellDataArraySelection

vtkDataArraySelection* vtkFidesReader::CellDataArraySelection
protected

Definition at line 233 of file vtkFidesReader.h.

◆ FieldDataArraySelection

vtkDataArraySelection* vtkFidesReader::FieldDataArraySelection
protected

Definition at line 234 of file vtkFidesReader.h.


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