VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtMetafileRecord Class Reference
Inheritance diagram for DtMetafileRecord:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtMetafileRecord ()
 default constructor.
virtual ~DtMetafileRecord ()
 destructor
 DtMetafileRecord (const DtMetafileRecord &orig)
 copy constructor
DtMetafileRecordoperator= (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 DtTerrainInitializerinitializer ()
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 DtStringrecordString () 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

DtTerrainInitializermypInitializer
DtString myRecordString
int myRecordKey
DtPropertyNamesMap myAttributeNames
bool myCanImport
DtFilename myPath

Static Protected Attributes

static const DtString theImport

Constructor & Destructor Documentation

default constructor.

virtual DtMetafileRecord::~DtMetafileRecord ( ) [virtual]

destructor

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]
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]
virtual bool DtMetafileRecord::processToken ( std::istream &  stream,
DtString token 
) [virtual]
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 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 [protected, virtual]
virtual bool DtMetafileRecord::getAttribute ( const DtString  attrName,
DtString value,
unsigned  index = 0 
) [protected, virtual]
virtual bool DtMetafileRecord::setToken ( const DtString token,
const DtString  value 
) [protected, virtual]
bool DtMetafileRecord::isInt ( 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

DtFilename DtMetafileRecord::myPath [protected]
const DtString DtMetafileRecord::theImport [static, protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)