class to read any type of EnSight files More...

#include <vtkGenericEnSightReader.h>

Inheritance diagram for vtkGenericEnSightReader:

Collaboration diagram for vtkGenericEnSightReader:

Public Types
enum	FileTypes { ENSIGHT_6 = 0 , ENSIGHT_6_BINARY = 1 , ENSIGHT_GOLD = 2 , ENSIGHT_GOLD_BINARY = 3 , ENSIGHT_MASTER_SERVER = 4 }

enum	{ FILE_BIG_ENDIAN = 0 , FILE_LITTLE_ENDIAN = 1 , FILE_UNKNOWN_ENDIAN = 2 }

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...

vtkGenericEnSightReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

const char *	GetDescription (int n)
	Get the nth description for a non-complex variable. More...

const char *	GetComplexDescription (int n)
	Get the nth description for a complex variable. More...

const char *	GetDescription (int n, int type)
	Get the nth description of a particular variable type. More...

int	DetermineEnSightVersion (int quiet=0)
	Reads the FORMAT part of the case file to determine whether this is an EnSight6 or EnSightGold data set. More...

virtual int	CanReadFile (VTK_FILEPATH const char *casefilename)
	Returns IsEnSightFile() by default, but can be overridden. More...

vtkGenericEnSightReader *	GetReader ()


void	SetCaseFileName (VTK_FILEPATH const char *fileName)
	Set/Get the Case file name. More...

	vtkGetFilePathMacro (CaseFileName)
	Set/Get the Case file name. More...


	vtkSetFilePathMacro (FilePath)
	Set/Get the file path. More...

	vtkGetFilePathMacro (FilePath)
	Set/Get the file path. More...


virtual int	GetEnSightVersion ()
	Get the EnSight file version being read. More...


virtual int	GetNumberOfVariables ()
	Get the number of variables listed in the case file. More...

virtual int	GetNumberOfComplexVariables ()
	Get the number of variables listed in the case file. More...


int	GetNumberOfVariables (int type)
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfScalarsPerNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfVectorsPerNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfTensorsAsymPerNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfTensorsSymmPerNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfScalarsPerElement ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfVectorsPerElement ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfTensorsAsymPerElement ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfTensorsSymmPerElement ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfScalarsPerMeasuredNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfVectorsPerMeasuredNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfComplexScalarsPerNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfComplexVectorsPerNode ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfComplexScalarsPerElement ()
	Get the number of variables of a particular type. More...

virtual int	GetNumberOfComplexVectorsPerElement ()
	Get the number of variables of a particular type. More...


int	GetVariableType (int n)
	Get the variable type of variable n. More...

int	GetComplexVariableType (int n)
	Get the variable type of variable n. More...


virtual void	SetTimeValue (float value)
	Set/Get the time value at which to get the value. More...

virtual float	GetTimeValue ()
	Set/Get the time value at which to get the value. More...


virtual float	GetMinimumTimeValue ()
	Get the minimum or maximum time value for this data set. More...

virtual float	GetMaximumTimeValue ()
	Get the minimum or maximum time value for this data set. More...


virtual vtkDataArrayCollection *	GetTimeSets ()
	Get the time values per time set. More...


virtual void	ReadAllVariablesOn ()
	Set/get the flag for whether to read all the variables. More...

virtual void	ReadAllVariablesOff ()
	Set/get the flag for whether to read all the variables. More...

virtual void	SetReadAllVariables (vtkTypeBool)
	Set/get the flag for whether to read all the variables. More...

virtual vtkTypeBool	GetReadAllVariables ()
	Set/get the flag for whether to read all the variables. More...


virtual vtkDataArraySelection *	GetPointDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader. More...

virtual vtkDataArraySelection *	GetCellDataArraySelection ()
	Get the data array selection tables used to configure which data arrays are loaded by the reader. 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...


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...


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...

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	SetByteOrderToBigEndian ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...

void	SetByteOrderToLittleEndian ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...

virtual void	SetByteOrder (int)
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...

virtual int	GetByteOrder ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...

const char *	GetByteOrderAsString ()
	Set the byte order of the file (remember, more Unix workstations write big endian whereas PCs write little endian). More...


	vtkGetFilePathMacro (GeometryFileName)
	Get the Geometry file name. More...


virtual void	SetParticleCoordinatesByIndex (vtkTypeBool)
	The MeasuredGeometryFile should list particle coordinates from 0->N-1. More...

virtual vtkTypeBool	GetParticleCoordinatesByIndex ()
	The MeasuredGeometryFile should list particle coordinates from 0->N-1. More...

virtual void	ParticleCoordinatesByIndexOn ()
	The MeasuredGeometryFile should list particle coordinates from 0->N-1. More...

virtual void	ParticleCoordinatesByIndexOff ()
	The MeasuredGeometryFile should list particle coordinates from 0->N-1. More...

Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkMultiBlockDataSetAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details More...

vtkMultiBlockDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkMultiBlockDataSet *	GetOutput (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
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. 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...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (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...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

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...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (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...

virtual vtkInformation *	GetInformation ()
	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...

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 vtkProgressObserver *	GetProgressObserver ()
	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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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...

vtkCommand *	GetCommand (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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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...

virtual 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 vtkGenericEnSightReader *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGenericEnSightReader *	SafeDownCast (vtkObjectBase *o)

static bool	IsEnSightFile (VTK_FILEPATH const char *casefilename)
	Returns true if the file pointed to by casefilename appears to be a valid EnSight case file. More...

Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkMultiBlockDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_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 vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkGenericEnSightReader ()

	~vtkGenericEnSightReader () override

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

virtual void	ClearForNewCaseFileName ()
	Clear data structures such that setting a new case file name works. More...

int	ReadLine (char result[256])
	Internal function to read in a line up to 256 characters. More...

int	ReadBinaryLine (char result[80])
	Internal function to read up to 80 characters from a binary file. More...

bool	SkipDataLine (char line[256])
	Skip certain non-comment lines that are not needed. More...

int	ReadNextDataLine (char result[256])

int	ReplaceWildcards (char *fileName, int timeSet, int fileSet)
	Replace the wildcards in the geometry file name with appropriate filename numbers as specified in the time set or file set. More...

void	SelectionModified ()

char **	CreateStringArray (int numStrings)

void	DestroyStringArray (int numStrings, char **strings)

void	SetDataArraySelectionSetsFromVariables ()

void	SetDataArraySelectionSetsFromReader ()

void	SetReaderDataArraySelectionSetsFromSelf ()

virtual void	SetTimeSets (vtkDataArrayCollection *)

int	InsertNewPartId (int partId)


	vtkSetFilePathMacro (GeometryFileName)
	Set the geometry file name. More...


void	AddVariableDescription (const char *description)
	Add a variable description to the appropriate array. More...

void	AddComplexVariableDescription (const char *description)
	Add a variable description to the appropriate array. More...


void	AddVariableType (int variableType)
	Add a variable type to the appropriate array. More...

void	AddComplexVariableType (int variableType)
	Add a variable type to the appropriate array. More...

Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm () override=default

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...

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm. More...

vtkDataObject *	GetInput (int port)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm. More...

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm. More...

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	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...

vtkDataArray *	GetInputArrayToProcess (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...

vtkDataArray *	GetInputArrayToProcess (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...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (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...

vtkAbstractArray *	GetInputAbstractArrayToProcess (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...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	ReplaceWildcardsHelper (char *fileName, int num)
	Replace the *'s in the filename with the given filename number. More...

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

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
istream *	IS

FILE *	IFile

vtkGenericEnSightReader *	Reader

char *	CaseFileName

char *	GeometryFileName

char *	FilePath

int *	VariableTypes

int *	ComplexVariableTypes

char **	VariableDescriptions

char **	ComplexVariableDescriptions

int	NumberOfVariables

int	NumberOfComplexVariables

int	NumberOfScalarsPerNode

int	NumberOfVectorsPerNode

int	NumberOfTensorsAsymPerNode

int	NumberOfTensorsSymmPerNode

int	NumberOfScalarsPerElement

int	NumberOfVectorsPerElement

int	NumberOfTensorsAsymPerElement

int	NumberOfTensorsSymmPerElement

int	NumberOfScalarsPerMeasuredNode

int	NumberOfVectorsPerMeasuredNode

int	NumberOfComplexScalarsPerNode

int	NumberOfComplexVectorsPerNode

int	NumberOfComplexScalarsPerElement

int	NumberOfComplexVectorsPerElement

float	TimeValue

float	MinimumTimeValue

float	MaximumTimeValue

int	TimeValueInitialized

vtkDataArrayCollection *	TimeSets

vtkTypeBool	ReadAllVariables

int	ByteOrder

vtkTypeBool	ParticleCoordinatesByIndex

int	EnSightVersion

vtkDataArraySelection *	PointDataArraySelection

vtkDataArraySelection *	CellDataArraySelection

vtkCallbackCommand *	SelectionObserver

int	SelectionModifiedDoNotCallModified

TranslationTableType *	TranslationTable

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

class to read any type of EnSight files

The class vtkGenericEnSightReader allows the user to read an EnSight data set without a priori knowledge of what type of EnSight data set it is.

Definition at line 48 of file vtkGenericEnSightReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkGenericEnSightReader::Superclass

Definition at line 52 of file vtkGenericEnSightReader.h.

Member Enumeration Documentation

◆ FileTypes

enum vtkGenericEnSightReader::FileTypes

Enumerator
ENSIGHT_6
ENSIGHT_6_BINARY
ENSIGHT_GOLD
ENSIGHT_GOLD_BINARY
ENSIGHT_MASTER_SERVER

Definition at line 215 of file vtkGenericEnSightReader.h.

◆ anonymous enum

anonymous enum

Enumerator
FILE_BIG_ENDIAN
FILE_LITTLE_ENDIAN
FILE_UNKNOWN_ENDIAN

Definition at line 238 of file vtkGenericEnSightReader.h.

Constructor & Destructor Documentation

◆ vtkGenericEnSightReader()

vtkGenericEnSightReader::vtkGenericEnSightReader ( )

protected

◆ ~vtkGenericEnSightReader()

vtkGenericEnSightReader::~vtkGenericEnSightReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGenericEnSightReader * vtkGenericEnSightReader::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkGenericEnSightReader::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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, and vtkEnSightReader.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGenericEnSightReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, and vtkEnSightReader.

◆ NewInstance()

vtkGenericEnSightReader * vtkGenericEnSightReader::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericEnSightReader::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.

◆ SetCaseFileName()

void vtkGenericEnSightReader::SetCaseFileName ( VTK_FILEPATH const char * fileName )

Set/Get the Case file name.

◆ vtkGetFilePathMacro() [1/3]

vtkGenericEnSightReader::vtkGetFilePathMacro ( CaseFileName )

Set/Get the Case file name.

◆ vtkSetFilePathMacro() [1/2]

vtkGenericEnSightReader::vtkSetFilePathMacro ( FilePath )

Set/Get the file path.

◆ vtkGetFilePathMacro() [2/3]

vtkGenericEnSightReader::vtkGetFilePathMacro ( FilePath )

Set/Get the file path.

◆ GetEnSightVersion()

virtual int vtkGenericEnSightReader::GetEnSightVersion ( )

virtual

Get the EnSight file version being read.

◆ GetNumberOfVariables() [1/2]

virtual int vtkGenericEnSightReader::GetNumberOfVariables ( )

virtual

Get the number of variables listed in the case file.

◆ GetNumberOfComplexVariables()

virtual int vtkGenericEnSightReader::GetNumberOfComplexVariables ( )

virtual

Get the number of variables listed in the case file.