DtGdbTerrainReader Class Reference

The DtGdbTerrainReader class is responsible for loading a GDB terrain database from file, presumably on disk, into a specified DtTerrainDatabase in memory. More...

Inheritance diagram for DtGdbTerrainReader:

List of all members.

Public Member Functions
	DtGdbTerrainReader ()
	Default constructor.
virtual	~DtGdbTerrainReader ()
	Destructor.
virtual bool	loadTerrain (const DtFilename &filename, DtTerrainDatabase *terrain)
	Loads terrain database file named filename, returning the data in terrain.
virtual bool	loadTerrain (const DtFilename &filename, DtTerrainDatabase *terrain, const DtTerrainInitializer *initializer)
	Loads terrain database file named filename, returning the data in terrain.
virtual const DtString	dataType () const
	Returns the type of file this database was loaded from.
virtual bool	readFromFile (const DtFilename &basename, DtTerrainDatabase *terrain)
virtual Coordinate_System *	coordinateSystem (const DtFilename &filename)
virtual int	optionalFileFlags (const DtFilename &filename)
Static Public Member Functions
static DtTerrainReader *	create ()
Protected Member Functions
bool	testInvariant () const
bool	createTerrain (const DtFilename &filename, DtTerrainDatabase &terrainDb, const DtGdbReaderInitializer &gdbInitializer)
bool	loadTerrainFromFile (const DtFilename &filename, DtTerrainDatabase &terrainDb, const DtGdbReaderInitializer &gdbInitializer)
virtual bool	readCoordinateSystem (FILE *fp)
virtual bool	readVersionNumber (const DtFilename &basename, DtTerrainFileVersionNumber &versionNumber)
	Opens the file if possible, and then reads the filename.
virtual bool	readVersionNumberFromFile (FILE *fp)
	Reads version number from open file pointer and leaves file open.
virtual bool	loadTerrainUsingGdbReader (const DtFilename &basename, const DtTerrainFileVersionNumber versionNumber, DtTerrainDatabase *terrain)
virtual DtTerrainFileVersionNumber	versionNumberFromFile () const
virtual void	setVersionNumberFromFile (DtTerrainFileVersionNumber versionNumber)
virtual bool	verifyFileType (DtString filename, const DtString &type="gdb")
virtual bool	loadSpatialSubdivision (FILE *fp, DtSpatialSubdivisionTerrainIntersectorDescriptor &descriptor) const
	Reads the spatial subdivision info from the file and fills it into the descriptor.
Private Member Functions
	DtGdbTerrainReader (const DtGdbTerrainReader &original)
	Copy constructor and Assignment operator not implemented This class is not copyable or assignable.
const DtGdbTerrainReader &	operator= (const DtGdbTerrainReader &original)
Private Attributes
DtTerrainFileVersionNumber	myVersionNumberFromFile

---

Detailed Description

The DtGdbTerrainReader class is responsible for loading a GDB terrain database from file, presumably on disk, into a specified DtTerrainDatabase in memory.

---

Constructor & Destructor Documentation

DtGdbTerrainReader::DtGdbTerrainReader

(

)

Default constructor.

virtual DtGdbTerrainReader::~DtGdbTerrainReader

(

)

[virtual]

Destructor.

DtGdbTerrainReader::DtGdbTerrainReader

(

const DtGdbTerrainReader &

original

)

[private]

Copy constructor and Assignment operator not implemented This class is not copyable or assignable.

---

Member Function Documentation

const DtGdbTerrainReader& DtGdbTerrainReader::operator=

(

const DtGdbTerrainReader &

original

)

[private]

virtual bool DtGdbTerrainReader::loadTerrain	(	const DtFilename &	filename,
		DtTerrainDatabase *	terrain
	)		[virtual]

Loads terrain database file named filename, returning the data in terrain.

The terrain pointer passed in must be initialized before calling loadTerrain.

Implements DtTerrainReader.

virtual bool DtGdbTerrainReader::loadTerrain	(	const DtFilename &	filename,
		DtTerrainDatabase *	terrain,
		const DtTerrainInitializer *	initializer
	)		[virtual]

Loads terrain database file named filename, returning the data in terrain.

The initializer object is used to pass in additional information about the terrain to be loaded. The terrain pointer passed in must be initialized before calling loadTerrain.

Implements DtTerrainReader.

static DtTerrainReader* DtGdbTerrainReader::create

(

)

[static]

Reimplemented in DtGdbTerrainV203Reader, DtOldGdbTerrainReader, DtGdbTerrainV205Reader, DtGdbTerrainV209Reader, and DtGdbTerrainV204Reader.

virtual const DtString DtGdbTerrainReader::dataType

(

)

const [virtual]

Returns the type of file this database was loaded from.

This class returns "gdb". Override this function in derived terrain db classes.

Implements DtTerrainReader.

Reimplemented in DtGdbTerrainV203Reader, DtOldGdbTerrainReader, DtGdbTerrainV205Reader, DtGdbTerrainV209Reader, and DtGdbTerrainV204Reader.

virtual bool DtGdbTerrainReader::readFromFile	(	const DtFilename &	basename,
		DtTerrainDatabase *	terrain
	)		[virtual]

Reimplemented in DtGdbTerrainV203Reader, DtOldGdbTerrainReader, DtGdbTerrainV205Reader, DtGdbTerrainV209Reader, and DtGdbTerrainV204Reader.

virtual Coordinate_System* DtGdbTerrainReader::coordinateSystem

(

const DtFilename &

filename

)

[virtual]

Implements DtTerrainReader.

virtual int DtGdbTerrainReader::optionalFileFlags

(

const DtFilename &

filename

)

[virtual]

Implements DtTerrainReader.

bool DtGdbTerrainReader::testInvariant

(

)

const [protected]

bool DtGdbTerrainReader::createTerrain	(	const DtFilename &	filename,
		DtTerrainDatabase &	terrainDb,
		const DtGdbReaderInitializer &	gdbInitializer
	)		[protected]

bool DtGdbTerrainReader::loadTerrainFromFile	(	const DtFilename &	filename,
		DtTerrainDatabase &	terrainDb,
		const DtGdbReaderInitializer &	gdbInitializer
	)		[protected]

virtual bool DtGdbTerrainReader::readCoordinateSystem

(

FILE *

fp

)

[protected, virtual]

Reimplemented in DtOldGdbTerrainReader, DtGdbTerrainV205Reader, and DtGdbTerrainV209Reader.

virtual bool DtGdbTerrainReader::readVersionNumber	(	const DtFilename &	basename,
		DtTerrainFileVersionNumber &	versionNumber
	)		[protected, virtual]

Opens the file if possible, and then reads the filename.

virtual bool DtGdbTerrainReader::readVersionNumberFromFile

(

FILE *

fp

)

[protected, virtual]

Reads version number from open file pointer and leaves file open.

virtual bool DtGdbTerrainReader::loadTerrainUsingGdbReader	(	const DtFilename &	basename,
		const DtTerrainFileVersionNumber	versionNumber,
		DtTerrainDatabase *	terrain
	)		[protected, virtual]

virtual DtTerrainFileVersionNumber DtGdbTerrainReader::versionNumberFromFile

(

)

const [protected, virtual]

virtual void DtGdbTerrainReader::setVersionNumberFromFile

(

DtTerrainFileVersionNumber

versionNumber

)

[protected, virtual]

virtual bool DtGdbTerrainReader::verifyFileType	(	DtString	filename,
		const DtString &	type = "gdb"
	)		[protected, virtual]

Note:

The filename parameter is passed by copy on purpose, as the copy is modified inside this function.

virtual bool DtGdbTerrainReader::loadSpatialSubdivision	(	FILE *	fp,
		DtSpatialSubdivisionTerrainIntersectorDescriptor &	descriptor
	)		const [protected, virtual]

Reads the spatial subdivision info from the file and fills it into the descriptor.

---

Member Data Documentation

DtTerrainFileVersionNumber DtGdbTerrainReader::myVersionNumberFromFile [private]

---

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

• include/gdb/gdbTerrainReader.h