VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions
DtRwSoilSpeedFactorList Class Reference

class DtRwSoilSpeedFactorList: More...

Inheritance diagram for DtRwSoilSpeedFactorList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtRwSoilSpeedFactorList ()
 default constructor
 DtRwSoilSpeedFactorList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 constructor
 DtRwSoilSpeedFactorList (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwSoilSpeedFactorList (const DtRwSoilSpeedFactorList &orig)
 copy constructor
DtRwSoilSpeedFactorListoperator= (const DtRwSoilSpeedFactorList &orig)
 assignment operator
virtual ~DtRwSoilSpeedFactorList ()
 destructor
bool lookup (const DtString &soilType, double &speedFactor) const
 Lookup speed factor given a soil type string.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
void clearList ()
 Removes and deletes all entries from the list.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Constructs a DtRwReal item, and then retrieves it from the stream.
virtual void copyList (const DtRwSoilSpeedFactorList &orig)
 Copies the contents of the target list into this one without clearing out the current list.

Detailed Description

class DtRwSoilSpeedFactorList:

Instances of DtRwSoilSpeedFactorList are lists of items.


Constructor & Destructor Documentation

default constructor

DtRwSoilSpeedFactorList::DtRwSoilSpeedFactorList ( const DtString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

constructor

DtRwSoilSpeedFactorList::DtRwSoilSpeedFactorList ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

copy constructor

destructor


Member Function Documentation

DtRwSoilSpeedFactorList& DtRwSoilSpeedFactorList::operator= ( const DtRwSoilSpeedFactorList orig)

assignment operator

bool DtRwSoilSpeedFactorList::lookup ( const DtString soilType,
double &  speedFactor 
) const

Lookup speed factor given a soil type string.

Allowable soil types are given in soilTypes.h.

virtual const char* DtRwSoilSpeedFactorList::readerWriterType ( ) const [virtual]

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtRwList.

Removes and deletes all entries from the list.

Non-virtual since it is called from the constructors/destructor.

virtual DtlObjPtr DtRwSoilSpeedFactorList::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [protected, virtual]

Constructs a DtRwReal item, and then retrieves it from the stream.

Implements DtRwList.

virtual void DtRwSoilSpeedFactorList::copyList ( const DtRwSoilSpeedFactorList orig) [protected, virtual]

Copies the contents of the target list into this one without clearing out the current list.


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)