Public Member Functions

FltRecordReader Class Reference

This class turns an istream into a sequence of FltRecords by reading a sequence of Datagrams and extracting the opcode from each one. More...

#include "fltRecordReader.h"

List of all members.

Public Member Functions

 FltRecordReader (istream &in)
FltError advance (bool ok_eof=false)
 Extracts the next record from the file.
bool eof () const
 Returns true if end-of-file has been reached without error.
bool error () const
 Returns true if some error has been encountered while reading (for instance, a truncated file).
const Datagram & get_datagram ()
 Returns the datagram representing the entire record, less the four-byte header.
DatagramIterator & get_iterator ()
 Returns an iterator suitable for extracting data from the current record.
FltOpcode get_opcode () const
 Returns the opcode associated with the current record.
int get_record_length () const
 Returns the entire length of the record, including the four-byte header.

Detailed Description

This class turns an istream into a sequence of FltRecords by reading a sequence of Datagrams and extracting the opcode from each one.

It remembers where it is in the file and what the current record is.

Definition at line 34 of file fltRecordReader.h.

Member Function Documentation

FltError FltRecordReader::advance ( bool  ok_eof = false)

Extracts the next record from the file.

Returns true if there is another record, or false if the end of file has been reached.

Definition at line 114 of file fltRecordReader.cxx.

References Datagram::append_data().

Referenced by FltHeader::read_flt(), and FltRecord::read_record_and_children().

bool FltRecordReader::eof ( ) const

Returns true if end-of-file has been reached without error.

Definition at line 220 of file fltRecordReader.cxx.

Referenced by FltHeader::read_flt(), and FltRecord::read_record_and_children().

bool FltRecordReader::error ( ) const

Returns true if some error has been encountered while reading (for instance, a truncated file).

Definition at line 231 of file fltRecordReader.cxx.

Referenced by FltRecord::read_record_and_children().

const Datagram & FltRecordReader::get_datagram ( )

Returns the datagram representing the entire record, less the four-byte header.

Definition at line 87 of file fltRecordReader.cxx.

References DatagramIterator::get_datagram().

Referenced by FltUnsupportedRecord::extract_record().

DatagramIterator & FltRecordReader::get_iterator ( )

Returns an iterator suitable for extracting data from the current record.

Definition at line 75 of file fltRecordReader.cxx.

Referenced by FltRecord::extract_ancillary(), FltBeadID::extract_ancillary(), FltVertexList::extract_record(), FltVertex::extract_record(), FltVectorRecord::extract_record(), FltTransformTranslate::extract_record(), FltTransformScale::extract_record(), FltTransformRotateScale::extract_record(), FltTransformRotateAboutPoint::extract_record(), FltTransformRotateAboutEdge::extract_record(), FltTransformPut::extract_record(), FltTransformGeneralMatrix::extract_record(), FltTexture::extract_record(), FltObject::extract_record(), FltMeshPrimitive::extract_record(), FltMesh::extract_record(), FltMaterial::extract_record(), FltLOD::extract_record(), FltLocalVertexPool::extract_record(), FltLightSourceDefinition::extract_record(), FltInstanceRef::extract_record(), FltInstanceDefinition::extract_record(), FltHeader::extract_record(), FltGroup::extract_record(), FltGeometry::extract_record(), FltFace::extract_record(), FltExternalReference::extract_record(), FltCurve::extract_record(), and FltBeadID::extract_record().

FltOpcode FltRecordReader::get_opcode ( ) const

Returns the opcode associated with the current record.

Definition at line 63 of file fltRecordReader.cxx.

Referenced by FltRecord::extract_ancillary(), FltMesh::extract_ancillary(), FltHeader::extract_ancillary(), FltBeadID::extract_ancillary(), FltBead::extract_ancillary(), FltVertexList::extract_record(), FltVertex::extract_record(), FltVectorRecord::extract_record(), FltUnsupportedRecord::extract_record(), FltTransformTranslate::extract_record(), FltTransformScale::extract_record(), FltTransformRotateScale::extract_record(), FltTransformRotateAboutPoint::extract_record(), FltTransformRotateAboutEdge::extract_record(), FltTransformPut::extract_record(), FltTransformGeneralMatrix::extract_record(), FltTexture::extract_record(), FltObject::extract_record(), FltMeshPrimitive::extract_record(), FltMesh::extract_record(), FltMaterial::extract_record(), FltLOD::extract_record(), FltLocalVertexPool::extract_record(), FltLightSourceDefinition::extract_record(), FltInstanceRef::extract_record(), FltInstanceDefinition::extract_record(), FltHeader::extract_record(), FltGroup::extract_record(), FltFace::extract_record(), FltExternalReference::extract_record(), FltCurve::extract_record(), and FltRecord::read_record_and_children().

int FltRecordReader::get_record_length ( ) const

Returns the entire length of the record, including the four-byte header.

Definition at line 102 of file fltRecordReader.cxx.

Referenced by FltHeader::extract_ancillary().

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