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

Creates a vtkUnstructuredGrid instance from a GenericIO file. More...

#include <vtkPGenericIOReader.h>

Inherits vtkUnstructuredGridAlgorithm.

Public Types

enum  IOType { IOTYPEMPI, IOTYPEPOSIX }
 
enum  BlockAssignment { ROUND_ROBIN, RCB }
 
typedef vtkUnstructuredGridAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetNumberOfPointArrays ()
 Returns the number of arrays in the file, i.e., the number of columns. More...
 
const char * GetPointArrayName (int i)
 Returns the name of the ith array. More...
 
int GetPointArrayStatus (const char *name)
 Returns the status of the array corresponding to the given name. More...
 
void SetPointArrayStatus (const char *name, int status)
 Sets the status of the array named. More...
 
vtkIdType GetRequestedHaloId (vtkIdType i)
 Gets the ith requested halo id. More...
 
vtkIdType GetNumberOfRequestedHaloIds ()
 Gets the number of requested halo ids. More...
 
void SetNumberOfRequestedHaloIds (vtkIdType numIds)
 Sets the number of requested halo ids. More...
 
void AddRequestedHaloId (vtkIdType haloId)
 Adds the given halo id to the list of halo ids to request. More...
 
void ClearRequestedHaloIds ()
 Clears the list of requested halo ids. More...
 
void SetRequestedHaloId (vtkIdType i, vtkIdType haloId)
 Sets the ith requested halo id to the given haloId. More...
 
virtual void SetFileName (const char *)
 Specify the name of the cosmology particle binary file to read. More...
 
virtual char * GetFileName ()
 Specify the name of the cosmology particle binary file to read. More...
 
virtual void SetXAxisVariableName (const char *)
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual char * GetXAxisVariableName ()
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual void SetYAxisVariableName (const char *)
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual char * GetYAxisVariableName ()
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual void SetZAxisVariableName (const char *)
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual char * GetZAxisVariableName ()
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual void SetGenericIOType (int)
 Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX. More...
 
virtual int GetGenericIOType ()
 Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX. More...
 
virtual void SetBlockAssignment (int)
 Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB. More...
 
virtual int GetBlockAssignment ()
 Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB. More...
 
virtual void SetRankInQuery (int)
 Set/Get the RankInQuery. More...
 
virtual int GetRankInQuery ()
 Set/Get the RankInQuery. More...
 
virtual void SetQueryRankNeighbors (int)
 Set/Get whether the reader should read/render only the data of the user-supplied rank, via SetRankInQuery(),. More...
 
virtual int GetQueryRankNeighbors ()
 Set/Get whether the reader should read/render only the data of the user-supplied rank, via SetRankInQuery(),. More...
 
virtual void SetAppendBlockCoordinates (bool)
 Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array. More...
 
virtual void AppendBlockCoordinatesOn ()
 Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array. More...
 
virtual void AppendBlockCoordinatesOff ()
 Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array. More...
 
virtual bool GetAppendBlockCoordinates ()
 Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array. More...
 
virtual vtkStringArray * GetArrayList ()
 Returns the list of arrays used to select the variables to be used for the x,y and z axis. More...
 
virtual vtkDataArraySelection * GetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual void SetController (vtkMultiProcessController *)
 Set/Get a multiprocess-controller for reading in parallel. More...
 
virtual vtkMultiProcessController * GetController ()
 Set/Get a multiprocess-controller for reading in parallel. More...
 
virtual void SetHaloIdVariableName (const char *)
 Gets/Sets the variable name for the halo id of the particle. More...
 
virtual char * GetHaloIdVariableName ()
 Gets/Sets the variable name for the halo id of the particle. More...
 

Static Public Member Functions

static vtkPGenericIOReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPGenericIOReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPGenericIOReader ()
 
virtual ~vtkPGenericIOReader ()
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void LoadMetaData ()
 Loads the GenericIO metadata from the file. More...
 
bool ReaderParametersChanged ()
 This method checks if the internal reader parameters have changed. More...
 
gio::GenericIOReader * GetInternalReader ()
 Returns the internal reader instance according to IOType. More...
 
void GetPointFromRawData (int xType, void *xBuffer, int yType, void *yBuffer, int zType, void *zBuffer, vtkIdType idx, double pnt[3])
 Return the point from the raw data. More...
 
void LoadRawVariableData (std::string varName)
 Loads the variable with the given name. More...
 
void LoadRawData ()
 Loads the Raw data. More...
 
void LoadCoordinates (vtkUnstructuredGrid *grid, std::set< vtkIdType > &pointsInSelectedHalos)
 Loads the particle coordinates. More...
 
void LoadData (vtkUnstructuredGrid *grid, const std::set< vtkIdType > &pointsInSelectedHalos)
 Loads the particle data arrays. More...
 
void FindRankNeighbors ()
 Finds the neighbors of the user-supplied rank. More...
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 Call-back registered with the SelectionObserver. More...
 

Protected Attributes

char * XAxisVariableName
 
char * YAxisVariableName
 
char * ZAxisVariableName
 
char * HaloIdVariableName
 
char * FileName
 
int GenericIOType
 
int BlockAssignment
 
int QueryRankNeighbors
 
int RankInQuery
 
bool BuildMetaData
 
bool AppendBlockCoordinates
 
vtkMultiProcessController * Controller
 
vtkStringArray * ArrayList
 
vtkIdList * HaloList
 
vtkDataArraySelection * PointDataArraySelection
 
vtkCallbackCommand * SelectionObserver
 
gio::GenericIOReader * Reader
 
vtkGenericIOMetaData * MetaData
 
int RequestInfoCounter
 
int RequestDataCounter
 

Detailed Description

Creates a vtkUnstructuredGrid instance from a GenericIO file.

Definition at line 50 of file vtkPGenericIOReader.h.

Member Typedef Documentation

§ Superclass

typedef vtkUnstructuredGridAlgorithm vtkPGenericIOReader::Superclass

Definition at line 66 of file vtkPGenericIOReader.h.

Member Enumeration Documentation

§ IOType

Enumerator
IOTYPEMPI 
IOTYPEPOSIX 

Definition at line 53 of file vtkPGenericIOReader.h.

§ BlockAssignment

Enumerator
ROUND_ROBIN 
RCB 

Definition at line 59 of file vtkPGenericIOReader.h.

Constructor & Destructor Documentation

§ vtkPGenericIOReader()

vtkPGenericIOReader::vtkPGenericIOReader ( )
protected

§ ~vtkPGenericIOReader()

virtual vtkPGenericIOReader::~vtkPGenericIOReader ( )
protectedvirtual

Member Function Documentation

§ New()

static vtkPGenericIOReader* vtkPGenericIOReader::New ( )
static

§ GetClassName()

virtual const char* vtkPGenericIOReader::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetFileName()

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

Specify the name of the cosmology particle binary file to read.

§ GetFileName()

virtual char* vtkPGenericIOReader::GetFileName ( )
virtual

Specify the name of the cosmology particle binary file to read.

§ SetXAxisVariableName()

virtual void vtkPGenericIOReader::SetXAxisVariableName ( const char *  )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

§ GetXAxisVariableName()

virtual char* vtkPGenericIOReader::GetXAxisVariableName ( )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

§ SetYAxisVariableName()

virtual void vtkPGenericIOReader::SetYAxisVariableName ( const char *  )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

§ GetYAxisVariableName()

virtual char* vtkPGenericIOReader::GetYAxisVariableName ( )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

§ SetZAxisVariableName()

virtual void vtkPGenericIOReader::SetZAxisVariableName ( const char *  )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

§ GetZAxisVariableName()

virtual char* vtkPGenericIOReader::GetZAxisVariableName ( )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

§ SetGenericIOType()

virtual void vtkPGenericIOReader::SetGenericIOType ( int  )
virtual

Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX.

§ GetGenericIOType()

virtual int vtkPGenericIOReader::GetGenericIOType ( )
virtual

Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX.

§ SetBlockAssignment()

virtual void vtkPGenericIOReader::SetBlockAssignment ( int  )
virtual

Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB.

§ GetBlockAssignment()

virtual int vtkPGenericIOReader::GetBlockAssignment ( )
virtual

Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB.

§ SetRankInQuery()

virtual void vtkPGenericIOReader::SetRankInQuery ( int  )
virtual

Set/Get the RankInQuery.

Used in combination with SetQueryRankNeighbors(1) tells the reader to render only the data of the RankInQuery and its neighbors.

§ GetRankInQuery()

virtual int vtkPGenericIOReader::GetRankInQuery ( )
virtual

Set/Get the RankInQuery.

Used in combination with SetQueryRankNeighbors(1) tells the reader to render only the data of the RankInQuery and its neighbors.

§ SetQueryRankNeighbors()

virtual void vtkPGenericIOReader::SetQueryRankNeighbors ( int  )
virtual

Set/Get whether the reader should read/render only the data of the user-supplied rank, via SetRankInQuery(),.

§ GetQueryRankNeighbors()

virtual int vtkPGenericIOReader::GetQueryRankNeighbors ( )
virtual

Set/Get whether the reader should read/render only the data of the user-supplied rank, via SetRankInQuery(),.

§ SetAppendBlockCoordinates()

virtual void vtkPGenericIOReader::SetAppendBlockCoordinates ( bool  )
virtual

Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array.

Defaults to false (Off).

§ AppendBlockCoordinatesOn()

virtual void vtkPGenericIOReader::AppendBlockCoordinatesOn ( )
virtual

Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array.

Defaults to false (Off).

§ AppendBlockCoordinatesOff()

virtual void vtkPGenericIOReader::AppendBlockCoordinatesOff ( )
virtual

Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array.

Defaults to false (Off).

§ GetAppendBlockCoordinates()

virtual bool vtkPGenericIOReader::GetAppendBlockCoordinates ( )
virtual

Set/Get whether the reader should append the coordinates of the block each point was read from as a point data array.

Defaults to false (Off).

§ GetArrayList()

virtual vtkStringArray* vtkPGenericIOReader::GetArrayList ( )
virtual

Returns the list of arrays used to select the variables to be used for the x,y and z axis.

§ GetPointDataArraySelection()

virtual vtkDataArraySelection* vtkPGenericIOReader::GetPointDataArraySelection ( )
virtual

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

§ SetController()

virtual void vtkPGenericIOReader::SetController ( vtkMultiProcessController *  )
virtual

Set/Get a multiprocess-controller for reading in parallel.

By default this parameter is set to NULL by the constructor.

§ GetController()

virtual vtkMultiProcessController* vtkPGenericIOReader::GetController ( )
virtual

Set/Get a multiprocess-controller for reading in parallel.

By default this parameter is set to NULL by the constructor.

§ GetNumberOfPointArrays()

int vtkPGenericIOReader::GetNumberOfPointArrays ( )

Returns the number of arrays in the file, i.e., the number of columns.

§ GetPointArrayName()

const char* vtkPGenericIOReader::GetPointArrayName ( int  i)

Returns the name of the ith array.

§ GetPointArrayStatus()

int vtkPGenericIOReader::GetPointArrayStatus ( const char *  name)

Returns the status of the array corresponding to the given name.

§ SetPointArrayStatus()

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

Sets the status of the array named.

If the status is 1, the array will be read in on the resulting dataset.

§ SetHaloIdVariableName()

virtual void vtkPGenericIOReader::SetHaloIdVariableName ( const char *  )
virtual

Gets/Sets the variable name for the halo id of the particle.

This is used by the requested halo selector to select only the points in the desired halos.

§ GetHaloIdVariableName()

virtual char* vtkPGenericIOReader::GetHaloIdVariableName ( )
virtual

Gets/Sets the variable name for the halo id of the particle.

This is used by the requested halo selector to select only the points in the desired halos.

§ GetRequestedHaloId()

vtkIdType vtkPGenericIOReader::GetRequestedHaloId ( vtkIdType  i)

Gets the ith requested halo id.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

§ GetNumberOfRequestedHaloIds()

vtkIdType vtkPGenericIOReader::GetNumberOfRequestedHaloIds ( )

Gets the number of requested halo ids.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

§ SetNumberOfRequestedHaloIds()

void vtkPGenericIOReader::SetNumberOfRequestedHaloIds ( vtkIdType  numIds)

Sets the number of requested halo ids.

Use SetRequestedHaloId() to se the ids after this is called If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

§ AddRequestedHaloId()

void vtkPGenericIOReader::AddRequestedHaloId ( vtkIdType  haloId)

Adds the given halo id to the list of halo ids to request.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

§ ClearRequestedHaloIds()

void vtkPGenericIOReader::ClearRequestedHaloIds ( )

Clears the list of requested halo ids.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

§ SetRequestedHaloId()

void vtkPGenericIOReader::SetRequestedHaloId ( vtkIdType  i,
vtkIdType  haloId 
)

Sets the ith requested halo id to the given haloId.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

§ RequestInformation()

virtual int vtkPGenericIOReader::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

§ RequestData()

virtual int vtkPGenericIOReader::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

§ LoadMetaData()

void vtkPGenericIOReader::LoadMetaData ( )
protected

Loads the GenericIO metadata from the file.

§ ReaderParametersChanged()

bool vtkPGenericIOReader::ReaderParametersChanged ( )
protected

This method checks if the internal reader parameters have changed.

Namely, if the I/O method or filename have changed, the method returns true.

§ GetInternalReader()

gio::GenericIOReader* vtkPGenericIOReader::GetInternalReader ( )
protected

Returns the internal reader instance according to IOType.

§ GetPointFromRawData()

void vtkPGenericIOReader::GetPointFromRawData ( int  xType,
void *  xBuffer,
int  yType,
void *  yBuffer,
int  zType,
void *  zBuffer,
vtkIdType  idx,
double  pnt[3] 
)
protected

Return the point from the raw data.

§ LoadRawVariableData()

void vtkPGenericIOReader::LoadRawVariableData ( std::string  varName)
protected

Loads the variable with the given name.

§ LoadRawData()

void vtkPGenericIOReader::LoadRawData ( )
protected

Loads the Raw data.

§ LoadCoordinates()

void vtkPGenericIOReader::LoadCoordinates ( vtkUnstructuredGrid *  grid,
std::set< vtkIdType > &  pointsInSelectedHalos 
)
protected

Loads the particle coordinates.

§ LoadData()

void vtkPGenericIOReader::LoadData ( vtkUnstructuredGrid *  grid,
const std::set< vtkIdType > &  pointsInSelectedHalos 
)
protected

Loads the particle data arrays.

§ FindRankNeighbors()

void vtkPGenericIOReader::FindRankNeighbors ( )
protected

Finds the neighbors of the user-supplied rank.

§ SelectionModifiedCallback()

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

Call-back registered with the SelectionObserver.

Member Data Documentation

§ XAxisVariableName

char* vtkPGenericIOReader::XAxisVariableName
protected

Definition at line 314 of file vtkPGenericIOReader.h.

§ YAxisVariableName

char* vtkPGenericIOReader::YAxisVariableName
protected

Definition at line 315 of file vtkPGenericIOReader.h.

§ ZAxisVariableName

char* vtkPGenericIOReader::ZAxisVariableName
protected

Definition at line 316 of file vtkPGenericIOReader.h.

§ HaloIdVariableName

char* vtkPGenericIOReader::HaloIdVariableName
protected

Definition at line 317 of file vtkPGenericIOReader.h.

§ FileName

char* vtkPGenericIOReader::FileName
protected

Definition at line 319 of file vtkPGenericIOReader.h.

§ GenericIOType

int vtkPGenericIOReader::GenericIOType
protected

Definition at line 320 of file vtkPGenericIOReader.h.

§ BlockAssignment

Definition at line 321 of file vtkPGenericIOReader.h.

§ QueryRankNeighbors

int vtkPGenericIOReader::QueryRankNeighbors
protected

Definition at line 323 of file vtkPGenericIOReader.h.

§ RankInQuery

int vtkPGenericIOReader::RankInQuery
protected

Definition at line 324 of file vtkPGenericIOReader.h.

§ BuildMetaData

bool vtkPGenericIOReader::BuildMetaData
protected

Definition at line 326 of file vtkPGenericIOReader.h.

§ AppendBlockCoordinates

bool vtkPGenericIOReader::AppendBlockCoordinates
protected

Definition at line 327 of file vtkPGenericIOReader.h.

§ Controller

vtkMultiProcessController* vtkPGenericIOReader::Controller
protected

Definition at line 329 of file vtkPGenericIOReader.h.

§ ArrayList

vtkStringArray* vtkPGenericIOReader::ArrayList
protected

Definition at line 331 of file vtkPGenericIOReader.h.

§ HaloList

vtkIdList* vtkPGenericIOReader::HaloList
protected

Definition at line 332 of file vtkPGenericIOReader.h.

§ PointDataArraySelection

vtkDataArraySelection* vtkPGenericIOReader::PointDataArraySelection
protected

Definition at line 333 of file vtkPGenericIOReader.h.

§ SelectionObserver

vtkCallbackCommand* vtkPGenericIOReader::SelectionObserver
protected

Definition at line 334 of file vtkPGenericIOReader.h.

§ Reader

gio::GenericIOReader* vtkPGenericIOReader::Reader
protected

Definition at line 336 of file vtkPGenericIOReader.h.

§ MetaData

vtkGenericIOMetaData* vtkPGenericIOReader::MetaData
protected

Definition at line 337 of file vtkPGenericIOReader.h.

§ RequestInfoCounter

int vtkPGenericIOReader::RequestInfoCounter
protected

Definition at line 339 of file vtkPGenericIOReader.h.

§ RequestDataCounter

int vtkPGenericIOReader::RequestDataCounter
protected

Definition at line 340 of file vtkPGenericIOReader.h.


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