reads meta-files points to PLOT3D files More...

#include <vtkPlot3DMetaReader.h>

Inheritance diagram for vtkPlot3DMetaReader:

Collaboration diagram for vtkPlot3DMetaReader:

Public Types
typedef vtkMultiBlockDataSetAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkPlot3DMetaReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
Static Public Member Functions
static vtkPlot3DMetaReader *	New ()
static int	IsTypeOf (const char *type)
static vtkPlot3DMetaReader *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlot3DMetaReader ()
	~vtkPlot3DMetaReader ()
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
void	SetAutoDetectFormat (Json::Value *value)
void	SetByteOrder (Json::Value *value)
void	SetPrecision (Json::Value *val)
void	SetMultiGrid (Json::Value *val)
void	SetFormat (Json::Value *val)
void	SetBlanking (Json::Value *val)
void	Set2D (Json::Value *val)
void	SetR (Json::Value *val)
void	SetGamma (Json::Value *val)
void	SetFileNames (Json::Value *val)
void	SetLanguage (Json::Value *val)
void	AddFunctions (Json::Value *val)
Protected Attributes
char *	FileName

Detailed Description

reads meta-files points to PLOT3D files

The main goal of this reader is to make it easy to read PLOT3D files, specifically time series of PLOT3D files. PLOT3D files can take many different forms based on their content. Unfortunately, it is not a self-describing format therefore the user needs to pass information about the contents of the file to the reader. Normally, this is done by setting a number of member variables. The goal of this reader is to provide a simple format that enable the writer of the PLOT3D file to describe its settings as well as group a number of files as a time series. Note that for binary files, the auto-detect-format option, which is on by default negates the need to specify most other option. However, this reader is still very useful when trying to read file series even for binary files. The format for this meta-file is very simple and is based on JSON (there is no need to know anything about JSON to understand this format). Below is an example with comments (followed by //) that describe the format. Note that the PLOT3D file names are relative to the location of the meta-file unless they start with a leading /.

 {
 "auto-detect-format" : true // Tells the reader to try to figure out the format automatically. Only works
                             // with binary file. This is on by default, negating the need for most other
                             // options for binary files (format, byte-order, precision, multi-grid,
                             // blanking, 2D).
 "format" : "binary",  // Is this a binary or ascii file, values : binary, ascii
 "byte-order" : "big", // Byte order for binary files, values : little, big (denoting little or big endian)
 "precision" : 32,     // Precision of floating point values, can be 32 or 64 (bits)
 "multi-grid" : false, // Is this a multi-grid file, values: true, false
 "language" : "C",     // Which language was this file written in, values : C, fortran. This is
                       // used to determine if an binary PLOT3D file contains byte counts, used by
                       // Fortran IO routines.
 "blanking" : false,   // Does this file have blanking information (iblanks), values : true, false
 "2D" : false,         // Is this a 2D dataset, values : true, false
 "R" : 8.314,          // The value of the gas constant, default is 1.0. Set this according to the dimensions you use
 "gamma" : 1.4,        // Ratio of specific heats. Default is 1.4.
 "functions": [ 110, 200, 201 ],  // Additional derived values to calculate. This is an array of integers formatted
                                  // as [ value, value, value, ...]
 "filenames" : [     // List of xyz (geometry) and q (value) file names along with the time values.
                     // This is an array which contains items in the format:
                     // {"time" : values, "xyz" : "xyz file name", "q" : "q file name", "function" : "function file name"}
                     // Note that q and function are optional. Also, you can repeat the same file name for xyz or q
                     // if they don't change over time. The reader will not read files unnecessarily.
  { "time" : 3.5, "xyz" : "combxyz.bin", "q" : "combq.1.bin", "function" : "combf.1.bin" },
  { "time" : 4.5, "xyz" : "combxyz.bin", "q" : "combq.2.bin", "function" : "combf.2.bin" }
 ]
 }

This reader leverages vtkMultiBlockPLOT3DReader to do the actual reading so you may want to refer to the documenation of vtkMultiBlockPLOT3DReader about the details of some of these parameters including the function numbers for derived value calculation.

See also:: vtkMultiBlockPLOT3DReader

Tests:: vtkPlot3DMetaReader (Tests)

Definition at line 95 of file vtkPlot3DMetaReader.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkPlot3DMetaReader::Superclass

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Definition at line 99 of file vtkPlot3DMetaReader.h.

Constructor & Destructor Documentation

vtkPlot3DMetaReader::vtkPlot3DMetaReader ( ) [protected]

vtkPlot3DMetaReader::~vtkPlot3DMetaReader ( ) [protected]

Member Function Documentation

static vtkPlot3DMetaReader* vtkPlot3DMetaReader::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

static int vtkPlot3DMetaReader::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkPlot3DMetaReader::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.

static vtkPlot3DMetaReader* vtkPlot3DMetaReader::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

virtual vtkObjectBase* vtkPlot3DMetaReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

vtkPlot3DMetaReader* vtkPlot3DMetaReader::NewInstance ( ) const

Reimplemented from vtkMultiBlockDataSetAlgorithm.

void vtkPlot3DMetaReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

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.

virtual void vtkPlot3DMetaReader::SetFileName ( const char * ) [virtual]

Set/Get the meta PLOT3D filename. See the class documentation for format details.

virtual char* vtkPlot3DMetaReader::GetFileName ( ) [virtual]

Set/Get the meta PLOT3D filename. See the class documentation for format details.