ssRawDataReader Class Reference
[C++/Common/Vtk/ReaderWriter]

#include <ssRawDataReader.h>

Inheritance diagram for ssRawDataReader:

[legend]Collaboration diagram for ssRawDataReader:

[legend]List of all members.

Public Member Functions
	vtkTypeMacro (ssRawDataReader, vtkDataReader)
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the state of this object.
virtual int	OpenRawFile ()
	Open the current file.
void	TruncateFile ()
	Truncate or create a zero length file.
virtual bool	eof () const
	Give the EOF status of this object.
Static Public Member Functions
static ssRawDataReader *	New ()
	Instantiate a new object of this type.
Protected Member Functions
	ssRawDataReader ()
	Ctor.
virtual	~ssRawDataReader ()
	Dtor.
bool	RecordReaderReadCellData (vtkDataSet *ds, int numCells)
	Read the cell data in the record.
bool	RecordReaderReadPointData (vtkDataSet *ds, int numPts)
	Read the cell data in the record.
bool	RecordReaderReadHeader ()
	Read a record header.
Protected Attributes
bool	_eof

---

Detailed Description

Definition at line 21 of file ssRawDataReader.h.

---

Constructor & Destructor Documentation

ssRawDataReader::ssRawDataReader

(

)

[protected]

Ctor.

virtual ssRawDataReader::~ssRawDataReader

(

)

[protected, virtual]

Dtor.

---

Member Function Documentation

static ssRawDataReader* ssRawDataReader::New

(

)

[static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:

The new object.

Reimplemented from vtkDataReader.

Reimplemented in ssPolyDataRecordReader.

ssRawDataReader::vtkTypeMacro	(	ssRawDataReader	,
		vtkDataReader
	)

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

Print the state of this object.

Parameters:

	os	The output stream.
	indent	The indentation level. Used for formating output.

Reimplemented from vtkDataReader.

Reimplemented in ssPolyDataRecordReader.

virtual int ssRawDataReader::OpenRawFile

(

)

[virtual]

Open the current file.

Returns:

The result of the operation - 1 (true) if successfull, 0 (false) if not.

void ssRawDataReader::TruncateFile

(

)

Truncate or create a zero length file.

virtual bool ssRawDataReader::eof

(

)

const [virtual]

Give the EOF status of this object.

This function goes true during the read that leaves the file pointer at the eof. Therefore, that read may, or may no have read valid data. In the latter case a valid output will result but the number of points will be zero.

Returns:

True if this object is at EOF.

bool ssRawDataReader::RecordReaderReadCellData	(	vtkDataSet *	ds,
		int	numCells
	)			[protected]

Read the cell data in the record.

Parameters:

	ds	The dataset into with the cells are read.
	numCells	The number of cells to read. The exact number of cells must be present or an error will result.

Returns:

If the read was ok then true - false otherwise.

bool ssRawDataReader::RecordReaderReadPointData	(	vtkDataSet *	ds,
		int	numPts
	)			[protected]

Read the cell data in the record.

Parameters:

	ds	The dataset into with the cells are read.
	numPts	The number of cells to read. The exact number of points must be present or an error will result.

Returns:

If the read was ok then true - false otherwise.

bool ssRawDataReader::RecordReaderReadHeader

(

)

[protected]

Read a record header.

Returns:

If the header was sucessfully read then true.

---

Member Data Documentation

bool ssRawDataReader::_eof [protected]

Definition at line 109 of file ssRawDataReader.h.

---

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

• ssRawDataReader.h

Generated on Sat Nov 22 12:37:41 2008 for Swath Sonar by Doxygen 1.5.1