DtTerrainDescriptorRecord Class Reference

Inheritance diagram for DtTerrainDescriptorRecord:

Public Member Functions
	DtTerrainDescriptorRecord ()
virtual	~DtTerrainDescriptorRecord ()
	DtTerrainDescriptorRecord (const DtTerrainDescriptorRecord &orig)
DtTerrainDescriptorRecord &	operator= (const DtTerrainDescriptorRecord &orig)
virtual DtString	recordTypeName () const
	Returns the type name for the particular record. More...
virtual DtConfigCategoryType	recordCategory () const
	Each record should have a category of configuration they represent. More...
virtual const DtFilename &	filename () const
virtual void	setFilename (const DtFilename &name)
virtual bool	terrainAltered () const
virtual void	setTerrainAltered (bool altered)
virtual bool	loadMtdFile (const DtFilename &name)
virtual bool	get (std::istream &stream)
	Read self from stream. More...
virtual bool	processToken (std::istream &stream, DtString &token)
	identifies a token or passes token the parent class. More...
Public Member Functions inherited from DtMetafileRecord
	DtMetafileRecord ()
	default constructor. More...
virtual	~DtMetafileRecord ()
	destructor More...
	DtMetafileRecord (const DtMetafileRecord &orig)
	copy constructor More...
DtMetafileRecord &	operator= (const DtMetafileRecord &orig)
	assignment operator More...
virtual bool	init ()
	Initialize the metafile. More...
virtual bool	canImport ()
	Tells whether the record can be included in the import process or not. More...
virtual bool	put (std::ostream &stream) const
	Write self to stream. More...
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). More...
virtual bool	setAttribute (DtString attrName, DtString value)
	Sets the value of the attribute attrName to value. More...
virtual const DtTerrainInitializer *	initializer () const
	Get the initializer. More...
virtual DtTerrainInitializer *	initializer ()
virtual void	setInitializer (DtTerrainInitializer *init)
	Sets the initializer. More...
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. More...
virtual const DtString &	recordString () const
	Get the record string. More...
virtual void	resetFileLists ()
	Clears any file lists this record holds onto. More...
virtual void	setPath (const DtFilename &)
	Parent path (if relevant) More...
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)

Static Public Member Functions
static DtMetafileRecord *	create ()

Protected Member Functions
virtual bool	writeAttributes (std::ostream &stream) const
	Write attributes to stream. This is called by put(stream) More...
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. More...
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 More...

Protected Attributes
bool	myTerrainHasBeenAltered
DtFilename	myFile
Protected Attributes inherited from DtMetafileRecord
DtTerrainInitializer *	mypInitializer
DtString	myRecordString
int	myRecordKey
DtPropertyNamesMap	myAttributeNames
bool	myCanImport
DtFilename	myPath

Static Protected Attributes
static const DtString	theParameterFile
static const DtString	theTerrainHasBeenAltered
Static Protected Attributes inherited from DtMetafileRecord
static const DtString	theImport

Constructor & Destructor Documentation

DtTerrainDescriptorRecord::DtTerrainDescriptorRecord

(

)

virtual DtTerrainDescriptorRecord::~DtTerrainDescriptorRecord ( )

virtual

DtTerrainDescriptorRecord::DtTerrainDescriptorRecord

(

const DtTerrainDescriptorRecord &

orig

)

Member Function Documentation

DtTerrainDescriptorRecord& DtTerrainDescriptorRecord::operator=

(

const DtTerrainDescriptorRecord &

orig

)

virtual DtString DtTerrainDescriptorRecord::recordTypeName ( ) const

virtual

Returns the type name for the particular record.

Descendants should have this method return some string which uniquely identifies the kind of database it represents.

Implements DtMetafileRecord.

virtual DtConfigCategoryType DtTerrainDescriptorRecord::recordCategory ( ) const

virtual

Each record should have a category of configuration they represent.

I.e does this record configure terrain source files, or vector source files, papermap files....

Implements DtMetafileRecord.

virtual const DtFilename& DtTerrainDescriptorRecord::filename ( ) const

virtual

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

virtual

virtual bool DtTerrainDescriptorRecord::terrainAltered ( ) const

virtual

virtual void DtTerrainDescriptorRecord::setTerrainAltered ( bool  altered )

virtual

virtual bool DtTerrainDescriptorRecord::loadMtdFile ( const DtFilename &  name )

virtual

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

virtual

Read self from stream.

Reimplemented from DtMetafileRecord.

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

virtual

identifies a token or passes token the parent class.

Reimplemented from DtMetafileRecord.

static DtMetafileRecord* DtTerrainDescriptorRecord::create ( )

static

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

protectedvirtual

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

Reimplemented from DtMetafileRecord.

virtual bool DtTerrainDescriptorRecord::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.

virtual bool DtTerrainDescriptorRecord::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.

Member Data Documentation

const DtString DtTerrainDescriptorRecord::theParameterFile

staticprotected

const DtString DtTerrainDescriptorRecord::theTerrainHasBeenAltered

staticprotected

bool DtTerrainDescriptorRecord::myTerrainHasBeenAltered

protected

DtFilename DtTerrainDescriptorRecord::myFile

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/terrainDbFactory/terrainDescriptorRecord.h