vtkXYZMolReader Class Reference

#include <vtkXYZMolReader.h>

Inheritance diagram for vtkXYZMolReader:

[legend]

Collaboration diagram for vtkXYZMolReader:

[legend]

List of all members.

---

Detailed Description

read Molecular Data files

vtkXYZMolReader is a source object that reads Molecule files The FileName must be specified

Thanks:

Dr. Jean M. Favre who developed and contributed this class

Tests:

vtkXYZMolReader (Tests)

Definition at line 34 of file vtkXYZMolReader.h.

Public Types
typedef vtkMoleculeReaderBase	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	CanReadFile (const char *name)
virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
virtual int	GetMaxTimeStep ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXYZMolReader *	SafeDownCast (vtkObject *o)
static vtkXYZMolReader *	New ()
Protected Member Functions
	vtkXYZMolReader ()
	~vtkXYZMolReader ()
void	ReadSpecificMolecule (FILE *fp)
char *	GetNextLine (FILE *fp, char *line, int maxlen)
int	GetLine1 (const char *line, int *cnt)
int	GetLine2 (const char *line, char *name)
int	GetAtom (const char *line, char *atom, float *x)
void	InsertAtom (const char *atom, float *pos)
virtual void	SetMaxTimeStep (int)
Protected Attributes
int	TimeStep
int	MaxTimeStep

---

Member Typedef Documentation

typedef vtkMoleculeReaderBase vtkXYZMolReader::Superclass

Reimplemented from vtkMoleculeReaderBase.

Definition at line 37 of file vtkXYZMolReader.h.

---

Constructor & Destructor Documentation

vtkXYZMolReader::vtkXYZMolReader

(

)

[protected]

vtkXYZMolReader::~vtkXYZMolReader

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkXYZMolReader::GetClassName

(

)

[virtual]

Reimplemented from vtkMoleculeReaderBase.

static int vtkXYZMolReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkMoleculeReaderBase.

virtual int vtkXYZMolReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkMoleculeReaderBase.

static vtkXYZMolReader* vtkXYZMolReader::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkMoleculeReaderBase.

void vtkXYZMolReader::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 vtkMoleculeReaderBase.

static vtkXYZMolReader* vtkXYZMolReader::New

(

)

[static]

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

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkXYZMolReader::CanReadFile

(

const char *

name

)

[virtual]

Test whether the file with the given name can be read by this reader.

virtual void vtkXYZMolReader::SetTimeStep

(

int

)

[virtual]

Set the current time step. It should be greater than 0 and smaller than MaxTimeStep.

virtual int vtkXYZMolReader::GetTimeStep

(

)

[virtual]

Set the current time step. It should be greater than 0 and smaller than MaxTimeStep.

virtual int vtkXYZMolReader::GetMaxTimeStep

(

)

[virtual]

Get the maximum time step.

void vtkXYZMolReader::ReadSpecificMolecule

(

FILE *

fp

)

[protected, virtual]

Implements vtkMoleculeReaderBase.

char* vtkXYZMolReader::GetNextLine	(	FILE *	fp,
		char *	line,
		int	maxlen
	)			[protected]

Get next line that is not a comment. It returns the beginning of data on line (skips empty spaces)

int vtkXYZMolReader::GetLine1	(	const char *	line,
		int *	cnt
	)			[protected]

int vtkXYZMolReader::GetLine2	(	const char *	line,
		char *	name
	)			[protected]

int vtkXYZMolReader::GetAtom	(	const char *	line,
		char *	atom,
		float *	x
	)			[protected]

void vtkXYZMolReader::InsertAtom	(	const char *	atom,
		float *	pos
	)			[protected]

virtual void vtkXYZMolReader::SetMaxTimeStep

(

int

)

[protected, virtual]

---

Member Data Documentation

int vtkXYZMolReader::TimeStep [protected]

Definition at line 73 of file vtkXYZMolReader.h.

int vtkXYZMolReader::MaxTimeStep [protected]

Definition at line 76 of file vtkXYZMolReader.h.

---

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

• dox/IO/vtkXYZMolReader.h