vtkParticleReader Class Reference

#include <vtkParticleReader.h>

Inheritance diagram for vtkParticleReader:

[legend]

Collaboration diagram for vtkParticleReader:

[legend]

List of all members.

Detailed Description

Read ASCII or binary particle data and (optionally) one scalar value associated with each particle.

vtkParticleReader reads either a binary or a text file of particles. Each particle can have associated with it an optional scalar value. So the format is: x, y, z, scalar (all floats or doubles). The text file can consist of a comma delimited set of values. In most cases vtkParticleReader can automatically determine whether the file is text or binary. The data can be either float or double. Progress updates are provided. With respect to binary files, random access into the file to read pieces is supported.

Examples:: vtkParticleReader (Examples)

Tests:: vtkParticleReader (Tests)

Definition at line 48 of file vtkParticleReader.h.


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

virtual void	SetFileName (const char *)
virtual char *	GetFileName ()

void	SetDataByteOrderToBigEndian ()
void	SetDataByteOrderToLittleEndian ()
int	GetDataByteOrder ()
void	SetDataByteOrder (int)
const char *	GetDataByteOrderAsString ()

virtual void	SetSwapBytes (int)
int	GetSwapBytes ()
virtual void	SwapBytesOn ()
virtual void	SwapBytesOff ()

virtual void	SetHasScalar (int)
virtual int	GetHasScalar ()
virtual void	HasScalarOn ()
virtual void	HasScalarOff ()

virtual void	SetFileType (int)
virtual int	GetFileType ()
void	SetFileTypeToUnknown ()
void	SetFileTypeToText ()
void	SetFileTypeToBinary ()

virtual void	SetDataType (int)
virtual int	GetDataType ()
void	SetDataTypeToFloat ()
void	SetDataTypeToDouble ()
Static Public Member Functions
static vtkParticleReader *	New ()
static int	IsTypeOf (const char *type)
static vtkParticleReader *	SafeDownCast (vtkObject *o)
Protected Types

enum	FILE_TYPE { FILE_TYPE_IS_UNKNOWN = 0, FILE_TYPE_IS_TEXT, FILE_TYPE_IS_BINARY }
Protected Member Functions
	vtkParticleReader ()
	~vtkParticleReader ()
void	OpenFile ()
int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	DetermineFileType ()
void	DoProgressUpdate (size_t &bytesRead, size_t &fileLength)

int	ProduceOutputFromTextFileDouble (vtkInformationVector *outputVector)
int	ProduceOutputFromTextFileFloat (vtkInformationVector *outputVector)

int	ProduceOutputFromBinaryFileDouble (vtkInformationVector *outputVector)
int	ProduceOutputFromBinaryFileFloat (vtkInformationVector *outputVector)
Protected Attributes
char *	FileName
ifstream *	File
int	HasScalar
int	SwapBytes
size_t	NumberOfPoints

int	FileType
int	DataType

size_t	Alliquot
size_t	Count

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkParticleReader::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 52 of file vtkParticleReader.h.

Member Enumeration Documentation

enum vtkParticleReader::FILE_TYPE [protected]

Enumerate the supported file types.

 - FILE_TYPE_IS_UNKNOWN,
      (default) the class will attempt to determine the file type. -
      FILE_TYPE_IS_TEXT, the file type is text. - FILE_TYPE_IS_BINARY, the
      file type is binary.

Enumerator:

FILE_TYPE_IS_UNKNOWN
FILE_TYPE_IS_TEXT
FILE_TYPE_IS_BINARY

Definition at line 170 of file vtkParticleReader.h.

Constructor & Destructor Documentation

vtkParticleReader::vtkParticleReader ( ) [protected]

vtkParticleReader::~vtkParticleReader ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkParticleReader::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataAlgorithm.

static int vtkParticleReader::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 vtkPolyDataAlgorithm.

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

static vtkParticleReader* vtkParticleReader::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

void vtkParticleReader::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 vtkPolyDataAlgorithm.

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

Specify file name.

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

Specify file name.

void vtkParticleReader::SetDataByteOrderToBigEndian ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

void vtkParticleReader::SetDataByteOrderToLittleEndian ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

int vtkParticleReader::GetDataByteOrder ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

void vtkParticleReader::SetDataByteOrder ( int )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

const char* vtkParticleReader::GetDataByteOrderAsString ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

virtual void vtkParticleReader::SetSwapBytes ( int ) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

int vtkParticleReader::GetSwapBytes ( ) [inline]

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

Definition at line 84 of file vtkParticleReader.h.

virtual void vtkParticleReader::SwapBytesOn ( ) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

virtual void vtkParticleReader::SwapBytesOff ( ) [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

virtual void vtkParticleReader::SetHasScalar ( int ) [virtual]

Default: 1. If 1 then each particle has a value associated with it.

virtual int vtkParticleReader::GetHasScalar ( ) [virtual]

Default: 1. If 1 then each particle has a value associated with it.

virtual void vtkParticleReader::HasScalarOn ( ) [virtual]

Default: 1. If 1 then each particle has a value associated with it.

virtual void vtkParticleReader::HasScalarOff ( ) [virtual]

Default: 1. If 1 then each particle has a value associated with it.

virtual void vtkParticleReader::SetFileType ( int ) [virtual]