DtMetafileRecord Class Reference

Inheritance diagram for DtMetafileRecord:

Public Member Functions
	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 DtConfigCategoryType	recordCategory () const =0
	Each record should have a category of configuration they represent.
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	get (std::istream &stream)
	Read self from stream.
virtual bool	processToken (std::istream &stream, DtString &token)
	identifies a token or passes token the parent class.
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	resetFileLists ()
	Clears any file lists this record holds onto.
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
DtTerrainInitializer *	mypInitializer
DtString	myRecordString
int	myRecordKey
DtPropertyNamesMap	myAttributeNames
bool	myCanImport
DtFilename	myPath

Static Protected Attributes
static const DtString	theImport

Constructor & Destructor Documentation

DtMetafileRecord::DtMetafileRecord

(

)

default constructor.

virtual DtMetafileRecord::~DtMetafileRecord ( )

virtual

destructor

DtMetafileRecord::DtMetafileRecord

(

const DtMetafileRecord &

orig

)

copy constructor

Member Function Documentation

DtMetafileRecord& DtMetafileRecord::operator=

(

const DtMetafileRecord &

orig

)

assignment operator

virtual bool DtMetafileRecord::init ( )

virtual

Initialize the metafile.

Reimplemented in DtKynPathDataMetafileRecord.

virtual DtString DtMetafileRecord::recordTypeName ( ) const

pure 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.

Implemented in DtOpcodeIntersectorRecord, DtSpatialSubdivisionIntersectorRecord, DtNativeIntersectorRecord, DtTerrainIntersectorRecord, DtKynPathDataMetafileRecord, DtExtentMetafileRecord, DtGdbProcessingMetafileRecord, DtMultiResPaperMapRecord, DtPixmapPaperMapRecord, DtPaperMapRecord, DtVectorDataRecord, DtShapeMetafileRecord, DtFltMetafileRecord, DtRpfPaperMapRecord, DtC4bMetafileRecord, DtDfadMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtShapeVectorMetafileRecord, DtDfdDfadMetafileRecord, DtDtedMetafileRecord, DtVmapMetafileRecord, DtTerrainDescriptorRecord, DtMetaFlightMetafileRecord, Dt3DViewMetafileRecord, and DtGdbMetafileRecord.

virtual DtConfigCategoryType DtMetafileRecord::recordCategory ( ) const

pure 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....

Implemented in DtOpcodeIntersectorRecord, DtSpatialSubdivisionIntersectorRecord, DtNativeIntersectorRecord, DtTerrainIntersectorRecord, DtAdditionalDataRecord, DtGdbProcessingMetafileRecord, DtPaperMapRecord, DtTerrainMetafileRecord, DtVectorDataRecord, DtExtentMetafileRecord, DtTerrainDescriptorRecord, and Dt3DViewMetafileRecord.

virtual bool DtMetafileRecord::canImport ( )

virtual

Tells whether the record can be included in the import process or not.

virtual bool DtMetafileRecord::put ( std::ostream &  stream ) const

virtual

Write self to stream.

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

virtual

Read self from stream.

Reimplemented in DtPaperMapRecord, DtPixmapPaperMapRecord, DtVectorDataRecord, DtGdbProcessingMetafileRecord, DtTerrainMetafileRecord, DtRpfPaperMapRecord, DtTerrainDescriptorRecord, DtMultiResPaperMapRecord, DtShapeMetafileRecord, Dt3DViewMetafileRecord, DtKynPathDataMetafileRecord, DtShapeVectorMetafileRecord, DtExtentMetafileRecord, DtFltMetafileRecord, DtC4bMetafileRecord, DtDfadMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtDfdDfadMetafileRecord, DtDtedMetafileRecord, DtVmapMetafileRecord, DtMetaFlightMetafileRecord, and DtGdbMetafileRecord.

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

virtual

identifies a token or passes token the parent class.

Reimplemented in DtSpatialSubdivisionIntersectorRecord, DtPaperMapRecord, DtPixmapPaperMapRecord, DtVectorDataRecord, DtGdbProcessingMetafileRecord, DtTerrainMetafileRecord, DtRpfPaperMapRecord, DtTerrainDescriptorRecord, DtMultiResPaperMapRecord, DtShapeMetafileRecord, Dt3DViewMetafileRecord, DtKynPathDataMetafileRecord, DtShapeVectorMetafileRecord, DtExtentMetafileRecord, DtFltMetafileRecord, DtAsciiMetafileRecord, DtC4bMetafileRecord, DtDfadMetafileRecord, DtC7bMetafileRecord, DtDfdDfadMetafileRecord, DtDtedMetafileRecord, DtVmapMetafileRecord, DtMetaFlightMetafileRecord, and DtGdbMetafileRecord.

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

virtual

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).

If the attribute is a sequence of values, they can be accessed via the index argument Returns False otherwise.

virtual bool DtMetafileRecord::setAttribute ( DtString  attrName, DtString  value  )

virtual

Sets the value of the attribute attrName to value.

Returns False if the record does not have the attribute or if the value cannot be set to the attribute

virtual const DtTerrainInitializer* DtMetafileRecord::initializer ( ) const

virtual

Get the initializer.

virtual DtTerrainInitializer* DtMetafileRecord::initializer ( )

virtual

virtual void DtMetafileRecord::setInitializer ( DtTerrainInitializer *  init )

virtual

Sets the initializer.

The initializer object is destroyed by this class destructor

virtual const int DtMetafileRecord::recordKey ( )

virtual

virtual void DtMetafileRecord::setRecordKey ( const int  key )

virtual

virtual const DtPropertyNamesMap DtMetafileRecord::properties ( ) const

virtual

Get the std::map with all the properties available for this record.

virtual const DtString& DtMetafileRecord::recordString ( ) const

virtual

Get the record string.

virtual void DtMetafileRecord::resetFileLists ( )

virtual

Clears any file lists this record holds onto.

Reimplemented in DtVectorDataRecord, DtTerrainMetafileRecord, DtShapeMetafileRecord, and DtShapeVectorMetafileRecord.

virtual void DtMetafileRecord::setPath ( const DtFilename &  )

virtual

Parent path (if relevant)

virtual const DtFilename& DtMetafileRecord::path ( ) const

virtual

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

protectedvirtual

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

Reimplemented in DtSpatialSubdivisionIntersectorRecord, DtPaperMapRecord, DtKynPathDataMetafileRecord, DtPixmapPaperMapRecord, DtVectorDataRecord, DtGdbProcessingMetafileRecord, DtRpfPaperMapRecord, DtMultiResPaperMapRecord, DtTerrainDescriptorRecord, DtTerrainMetafileRecord, DtShapeMetafileRecord, Dt3DViewMetafileRecord, DtExtentMetafileRecord, DtShapeVectorMetafileRecord, DtFltMetafileRecord, DtVmapMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtDfadMetafileRecord, DtC4bMetafileRecord, DtDfdDfadMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

virtual bool DtMetafileRecord::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 in DtSpatialSubdivisionIntersectorRecord, DtPaperMapRecord, DtKynPathDataMetafileRecord, DtPixmapPaperMapRecord, DtVectorDataRecord, DtGdbProcessingMetafileRecord, DtRpfPaperMapRecord, DtMultiResPaperMapRecord, DtTerrainDescriptorRecord, DtTerrainMetafileRecord, DtShapeMetafileRecord, Dt3DViewMetafileRecord, DtExtentMetafileRecord, DtShapeVectorMetafileRecord, DtFltMetafileRecord, DtVmapMetafileRecord, DtAsciiMetafileRecord, DtC4bMetafileRecord, DtC7bMetafileRecord, DtDfadMetafileRecord, DtDfdDfadMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

virtual bool DtMetafileRecord::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 in DtSpatialSubdivisionIntersectorRecord, DtPaperMapRecord, DtKynPathDataMetafileRecord, DtPixmapPaperMapRecord, DtVectorDataRecord, DtGdbProcessingMetafileRecord, DtRpfPaperMapRecord, DtTerrainMetafileRecord, DtMultiResPaperMapRecord, DtTerrainDescriptorRecord, DtShapeMetafileRecord, Dt3DViewMetafileRecord, DtExtentMetafileRecord, DtShapeVectorMetafileRecord, DtC4bMetafileRecord, DtFltMetafileRecord, DtVmapMetafileRecord, DtAsciiMetafileRecord, DtC7bMetafileRecord, DtDfadMetafileRecord, DtDfdDfadMetafileRecord, DtDtedMetafileRecord, DtGdbMetafileRecord, and DtMetaFlightMetafileRecord.

bool DtMetafileRecord::isInt

(

const DtString &

valueIn

)

bool DtMetafileRecord::isDouble

(

const DtString &

valueIn

)

bool DtMetafileRecord::isColor

(

const DtString &

valueIn

)

bool DtMetafileRecord::isPoint

(

const DtString &

valueIn

)

bool DtMetafileRecord::isBool

(

const DtString &

valueIn

)

bool DtMetafileRecord::toInt	(	const DtString &	valueIn,
		int &	valueOut
	)

bool DtMetafileRecord::toDouble	(	const DtString &	valueIn,
		double &	valueOut
	)

bool DtMetafileRecord::toColor	(	const DtString &	valueIn,
		DtColor &	valueOut
	)

bool DtMetafileRecord::toPoint	(	const DtString &	valueIn,
		DtPoint &	valueOut
	)

bool DtMetafileRecord::toBool	(	const DtString &	valueIn,
		bool &	valueOut
	)

Member Data Documentation

DtTerrainInitializer* DtMetafileRecord::mypInitializer

protected

DtString DtMetafileRecord::myRecordString

protected

int DtMetafileRecord::myRecordKey

protected

DtPropertyNamesMap DtMetafileRecord::myAttributeNames

protected

bool DtMetafileRecord::myCanImport

protected

DtFilename DtMetafileRecord::myPath

protected

const DtString DtMetafileRecord::theImport

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/terrainDbFactory/metafileRecord.h