DtTerrainMetafileRecord Class Reference

This is the abstract base class for all terrain records in a metafile. More...

Inheritance diagram for DtTerrainMetafileRecord:

Public Member Functions
	DtTerrainMetafileRecord ()
	default constructor.
virtual	~DtTerrainMetafileRecord ()
	destructor
	DtTerrainMetafileRecord (const DtTerrainMetafileRecord &orig)
	copy constructor
DtTerrainMetafileRecord &	operator= (const DtTerrainMetafileRecord &orig)
	assignment operator
virtual const DtFilename &	filename () const
	Returns filename of database.
virtual void	setFilename (const DtFilename &name)
virtual DtConfigCategoryType	recordCategory () const
	Returns DtConfigTerrainType;.
virtual const unsigned int	terrainType () const
	Specfic kind of terrain source.
virtual void	resetFileLists ()
	Clears the terrain file initializer list.
virtual bool	get (std::istream &stream)
	Read self from stream.
virtual bool	processToken (std::istream &stream, DtString &token)
	Identifies a token or passes it to the parent class.
Public Member Functions inherited from DtMetafileRecord
	DtMetafileRecord ()
	default constructor.
virtual	~DtMetafileRecord ()
	destructor
	DtMetafileRecord (const DtMetafileRecord &orig)
	copy constructor
DtMetafileRecord &	operator= (const DtMetafileRecord &orig)
	assignment operator
virtual bool	init ()
	Initialize the metafile.
virtual DtString	recordTypeName () const =0
	Returns the type name for the particular record.
virtual bool	canImport ()
	Tells whether the record can be included in the import process or not.
virtual bool	put (std::ostream &stream) const
	Write self to stream.
virtual bool	getAttribute (const DtString attrName, DtString &value, DtString &type, unsigned index=0)
	Given the name of a record's attribute, returns True if the record has the attribute (the value is returned in value and the type in type).
virtual bool	setAttribute (DtString attrName, DtString value)
	Sets the value of the attribute attrName to value.
virtual const DtTerrainInitializer *	initializer () const
	Get the initializer.
virtual DtTerrainInitializer *	initializer ()
virtual void	setInitializer (DtTerrainInitializer *init)
	Sets the initializer.
virtual const int	recordKey ()
virtual void	setRecordKey (const int key)
virtual const DtPropertyNamesMap	properties () const
	Get the std::map with all the properties available for this record.
virtual const DtString &	recordString () const
	Get the record string.
virtual void	setPath (const DtFilename &)
	Parent path (if relevant)
virtual const DtFilename &	path () const
bool	isInt (const DtString &valueIn)
bool	isDouble (const DtString &valueIn)
bool	isColor (const DtString &valueIn)
bool	isPoint (const DtString &valueIn)
bool	isBool (const DtString &valueIn)
bool	toInt (const DtString &valueIn, int &valueOut)
bool	toDouble (const DtString &valueIn, double &valueOut)
bool	toColor (const DtString &valueIn, DtColor &valueOut)
bool	toPoint (const DtString &valueIn, DtPoint &valueOut)
bool	toBool (const DtString &valueIn, bool &valueOut)

Protected Member Functions
virtual bool	writeAttributes (std::ostream &stream) const
	Write attributes to stream. This is called by put(stream)
virtual bool	getAttribute (const DtString attrName, DtString &value, unsigned index=0)
	Given the name of a record's attribute, returns its value in the 'value' parameter.
virtual bool	setToken (const DtString &token, const DtString value)
	identifies a token and returns true if the value can be set to it, false otherwise

Protected Attributes
long	myZone
DtPoint	myDatabaseOrigin
bool	myOriginSet
DtFilename	myFile
unsigned int	myTerrainType
Protected Attributes inherited from DtMetafileRecord
DtTerrainInitializer *	mypInitializer
DtString	myRecordString
int	myRecordKey
DtPropertyNamesMap	myAttributeNames
bool	myCanImport
DtFilename	myPath

Static Protected Attributes
static const DtString	theZone
	These variables will be used to override any latitude/longitude or zone information found in header files.
static const DtString	theOrigin
	Note that latitude and longitude origin will be defined as latitude, longitude, 0.0 (the z value must be 0.0)
static const DtString	theNumVertices
static const DtString	theNumSurfaces
static const DtString	theIsLargeTerrain
Static Protected Attributes inherited from DtMetafileRecord
static const DtString	theImport

Detailed Description

This is the abstract base class for all terrain records in a metafile.

Constructor & Destructor Documentation

DtTerrainMetafileRecord::DtTerrainMetafileRecord

(

)

default constructor.

virtual DtTerrainMetafileRecord::~DtTerrainMetafileRecord ( )

virtual

destructor

DtTerrainMetafileRecord::DtTerrainMetafileRecord

(

const DtTerrainMetafileRecord &

orig

)

copy constructor

Member Function Documentation

DtTerrainMetafileRecord& DtTerrainMetafileRecord::operator=

(

const DtTerrainMetafileRecord &

orig

)

assignment operator

virtual const DtFilename& DtTerrainMetafileRecord::filename ( ) const

virtual

Returns filename of database.

virtual void DtTerrainMetafileRecord::setFilename ( const DtFilename &  name )

virtual

Reimplemented in DtC7bMetafileRecord.

virtual DtConfigCategoryType DtTerrainMetafileRecord::recordCategory ( ) const

virtual

Returns DtConfigTerrainType;.

Implements DtMetafileRecord.

virtual const unsigned int DtTerrainMetafileRecord::terrainType ( ) const

virtual

Specfic kind of terrain source.

virtual void DtTerrainMetafileRecord::resetFileLists ( )

virtual

Clears the terrain file initializer list.

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord.

virtual bool DtTerrainMetafileRecord::get ( std::istream &  stream )

virtual

Read self from stream.

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtFltMetafileRecord, DtC4bMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtDtedMetafileRecord, DtMetaFlightMetafileRecord, and DtGdbMetafileRecord.

virtual bool DtTerrainMetafileRecord::processToken ( std::istream &  stream, DtString &  token  )

virtual

Identifies a token or passes it to the parent class.

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC4bMetafileRecord, DtC7bMetafileRecord, DtDtedMetafileRecord, DtMetaFlightMetafileRecord, and DtGdbMetafileRecord.

virtual bool DtTerrainMetafileRecord::writeAttributes ( std::ostream &  stream ) const

protectedvirtual

Write attributes to stream. This is called by put(stream)

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtC4bMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

virtual bool DtTerrainMetafileRecord::getAttribute ( const DtString  attrName, DtString &  value, unsigned  index = 0  )

protectedvirtual

Given the name of a record's attribute, returns its value in the 'value' parameter.

Returns True if successful; false otherwise

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC4bMetafileRecord, DtC7bMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

virtual bool DtTerrainMetafileRecord::setToken ( const DtString &  token, const DtString  value  )

protectedvirtual

identifies a token and returns true if the value can be set to it, false otherwise

Reimplemented from DtMetafileRecord.

Reimplemented in DtShapeMetafileRecord, DtC4bMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

Member Data Documentation

const DtString DtTerrainMetafileRecord::theZone

staticprotected

These variables will be used to override any latitude/longitude or zone information found in header files.

const DtString DtTerrainMetafileRecord::theOrigin

staticprotected

Note that latitude and longitude origin will be defined as latitude, longitude, 0.0 (the z value must be 0.0)

const DtString DtTerrainMetafileRecord::theNumVertices

staticprotected

const DtString DtTerrainMetafileRecord::theNumSurfaces

staticprotected

const DtString DtTerrainMetafileRecord::theIsLargeTerrain

staticprotected

long DtTerrainMetafileRecord::myZone

protected

DtPoint DtTerrainMetafileRecord::myDatabaseOrigin

protected

bool DtTerrainMetafileRecord::myOriginSet

protected

DtFilename DtTerrainMetafileRecord::myFile

protected

unsigned int DtTerrainMetafileRecord::myTerrainType

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/terrainDbFactory/terrainMetafileRecord.h