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

Instances of DtDmgSurfaceTable are (readable/writable) lists of DtDmgSurfaceEntrys. More...

Inheritance diagram for DtDmgSurfaceTable:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtDmgSurfaceTable (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor
 DtDmgSurfaceTable (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtDmgSurfaceTable (const DtString &name, const DtDmgSurfaceTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtDmgSurfaceTable (const DtSymbolString &name, const DtDmgSurfaceTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDmgSurfaceTableoperator= (const DtDmgSurfaceTable &orig)
 Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.
virtual ~DtDmgSurfaceTable ()
 destructor
virtual DtDmgSurfaceTableclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtDmgSurfaceTableclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void addSurfaceEntry (const DtDmgSurfaceEntry &surfaceEntry)
virtual void removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)
 Removes entry pointed to by surfaceEntry, but does not delete.
virtual bool getProbabilities (const DtString &surface, DtReal angleOfIncidence, DtReal range, DtPrbRangeTableEntry *rangeEntry)
 Fills in the range entry passed based on the remaining arguments.
virtual double getMaximumDamageRadius ()
 Returns the maximum radius at which the munition can do damage for this surface.

Protected Member Functions

 DtDmgSurfaceTable ()
 default constructor
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Constructs a DtDmgSurfaceEntry, reads it from the mtl stream, and then adds it to the list.
virtual void emptyList ()
 Removes all descriptors from the list, and destroys them.
virtual void copyList (const DtDmgSurfaceTable &orig)
virtual void addSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)
virtual void removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry, DtListItem *item)

Protected Attributes

DtHashlist myHashIndex

Detailed Description

Instances of DtDmgSurfaceTable are (readable/writable) lists of DtDmgSurfaceEntrys.

A string hash index is maintained for quick lookup. Given a surface, angle, and range, this class's getProbabilities() method will fill in the supplied DtPrbRangeEntry.


Constructor & Destructor Documentation

default constructor

DtDmgSurfaceTable::DtDmgSurfaceTable ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor

DtDmgSurfaceTable::DtDmgSurfaceTable ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtDmgSurfaceTable::DtDmgSurfaceTable ( const DtString name,
const DtDmgSurfaceTable orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtDmgSurfaceTable::DtDmgSurfaceTable ( const DtSymbolString name,
const DtDmgSurfaceTable orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

destructor


Member Function Documentation

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

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

virtual DtDmgSurfaceTable* DtDmgSurfaceTable::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) [virtual]
virtual DtDmgSurfaceTable* DtDmgSurfaceTable::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) [virtual]
virtual void DtDmgSurfaceTable::addSurfaceEntry ( const DtDmgSurfaceEntry surfaceEntry) [virtual]
virtual void DtDmgSurfaceTable::removeSurfaceEntry ( DtDmgSurfaceEntry surfaceEntry) [virtual]

Removes entry pointed to by surfaceEntry, but does not delete.

virtual bool DtDmgSurfaceTable::getProbabilities ( const DtString surface,
DtReal  angleOfIncidence,
DtReal  range,
DtPrbRangeTableEntry rangeEntry 
) [virtual]

Fills in the range entry passed based on the remaining arguments.

false is returned if appropriate data cannot be found.

virtual double DtDmgSurfaceTable::getMaximumDamageRadius ( ) [virtual]

Returns the maximum radius at which the munition can do damage for this surface.

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

Constructs a DtDmgSurfaceEntry, reads it from the mtl stream, and then adds it to the list.

Implements DtRwList.

virtual void DtDmgSurfaceTable::emptyList ( ) [protected, virtual]

Removes all descriptors from the list, and destroys them.

virtual void DtDmgSurfaceTable::copyList ( const DtDmgSurfaceTable orig) [protected, virtual]
virtual void DtDmgSurfaceTable::addSurfaceEntry ( DtDmgSurfaceEntry surfaceEntry) [protected, virtual]
virtual void DtDmgSurfaceTable::removeSurfaceEntry ( DtDmgSurfaceEntry surfaceEntry,
DtListItem *  item 
) [protected, virtual]

Member Data Documentation


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)