ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkEnsembleDataReader Class Reference

reader for ensemble data sets More...

#include <vtkEnsembleDataReader.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkStdString GetFilePath (unsigned int rowIndex) const
 Get the file path associated with the specified row of the meta data. More...
 
void SetReader (unsigned int rowIndex, vtkAlgorithm *reader)
 Set the file reader for the specified row of data. More...
 
void ResetReaders ()
 Removes all readers set using SetReader(). More...
 
bool UpdateMetaData ()
 Use this method to update the meta data, if needed. More...
 
virtual void SetFileName (const char *)
 Set/Get the filename of the ensemble (.pve extension). More...
 
virtual char * GetFileName ()
 Set/Get the filename of the ensemble (.pve extension). More...
 
virtual void SetCurrentMember (unsigned int)
 Set/Get the current ensemble member to process. More...
 
virtual unsigned int GetCurrentMember ()
 Set/Get the current ensemble member to process. More...
 
unsigned int GetNumberOfMembers () const
 Returns the number of ensemble members. More...
 
virtual unsigned int * GetCurrentMemberRange ()
 Returns the number of ensemble members. More...
 
virtual void GetCurrentMemberRange (unsigned int &, unsigned int &)
 Returns the number of ensemble members. More...
 
virtual void GetCurrentMemberRange (unsigned int [2])
 Returns the number of ensemble members. More...
 

Static Public Member Functions

static vtkEnsembleDataReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkEnsembleDataReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkEnsembleDataReader ()
 
 ~vtkEnsembleDataReader ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkAlgorithm * GetCurrentReader ()
 

Detailed Description

reader for ensemble data sets

vtkEnsembleDataReader reads a collection of data sources from a metadata file (of extension .pve). 'pve' a simply CSV file with the last column being the relative filename and other columns for each of the variables in the ensemble.

Definition at line 31 of file vtkEnsembleDataReader.h.

Member Typedef Documentation

§ Superclass

typedef vtkDataObjectAlgorithm vtkEnsembleDataReader::Superclass

Definition at line 35 of file vtkEnsembleDataReader.h.

Constructor & Destructor Documentation

§ vtkEnsembleDataReader()

vtkEnsembleDataReader::vtkEnsembleDataReader ( )
protected

§ ~vtkEnsembleDataReader()

vtkEnsembleDataReader::~vtkEnsembleDataReader ( )
protected

Member Function Documentation

§ New()

static vtkEnsembleDataReader* vtkEnsembleDataReader::New ( )
static

§ GetClassName()

virtual const char* vtkEnsembleDataReader::GetClassName ( )
virtual

§ IsTypeOf()

static int vtkEnsembleDataReader::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkEnsembleDataReader::IsA ( const char *  type)
virtual

§ SafeDownCast()

static vtkEnsembleDataReader* vtkEnsembleDataReader::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkEnsembleDataReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetFileName()

virtual void vtkEnsembleDataReader::SetFileName ( const char *  )
virtual

Set/Get the filename of the ensemble (.pve extension).

§ GetFileName()

virtual char* vtkEnsembleDataReader::GetFileName ( )
virtual

Set/Get the filename of the ensemble (.pve extension).

§ SetCurrentMember()

virtual void vtkEnsembleDataReader::SetCurrentMember ( unsigned  int)
virtual

Set/Get the current ensemble member to process.

§ GetCurrentMember()

virtual unsigned int vtkEnsembleDataReader::GetCurrentMember ( )
virtual

Set/Get the current ensemble member to process.

§ GetNumberOfMembers()

unsigned int vtkEnsembleDataReader::GetNumberOfMembers ( ) const

Returns the number of ensemble members.

§ GetCurrentMemberRange() [1/3]

virtual unsigned int* vtkEnsembleDataReader::GetCurrentMemberRange ( )
virtual

Returns the number of ensemble members.

§ GetCurrentMemberRange() [2/3]

virtual void vtkEnsembleDataReader::GetCurrentMemberRange ( unsigned int &  ,
unsigned int &   
)
virtual

Returns the number of ensemble members.

§ GetCurrentMemberRange() [3/3]

virtual void vtkEnsembleDataReader::GetCurrentMemberRange ( unsigned  int[2])
virtual

Returns the number of ensemble members.

§ GetFilePath()

vtkStdString vtkEnsembleDataReader::GetFilePath ( unsigned int  rowIndex) const

Get the file path associated with the specified row of the meta data.

§ SetReader()

void vtkEnsembleDataReader::SetReader ( unsigned int  rowIndex,
vtkAlgorithm *  reader 
)

Set the file reader for the specified row of data.

§ ResetReaders()

void vtkEnsembleDataReader::ResetReaders ( )

Removes all readers set using SetReader().

§ UpdateMetaData()

bool vtkEnsembleDataReader::UpdateMetaData ( )

Use this method to update the meta data, if needed.

This will only read the file again if cache is obsolete.

§ ProcessRequest()

virtual int vtkEnsembleDataReader::ProcessRequest ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

§ GetCurrentReader()

vtkAlgorithm* vtkEnsembleDataReader::GetCurrentReader ( )
protected

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