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

List of all members.

Public Member Functions

 DtPrbRangeList ()
 default constructor
 DtPrbRangeList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 Constructor with parameters to set up read/writability correctly.
 DtPrbRangeList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtPrbRangeList (const DtString &name, const DtPrbRangeList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtPrbRangeList (const DtSymbolString &name, const DtPrbRangeList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtPrbRangeListoperator= (const DtPrbRangeList &orig)
virtual ~DtPrbRangeList ()
 destructor
virtual DtPrbRangeListclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPrbRangeListclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void addTableEntry (const DtPrbRangeTableEntry &tableEntry)
 Adds a table entry in sorted (ascending) order.
virtual bool getProbabilities (DtReal range, DtPrbRangeTableEntry *entry) const
 Fills in the DtPrbRangeTableEntry with a category/value pair for each item on its list.
virtual double minRangeValue () const
virtual double maxRangeValue () const

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Creates a DtPrbRangeTableEntry, reads it, and adds it to the list.
void emptyList ()
 Removes all items from the list.
void copyList (const DtPrbRangeList &orig)
 Adds all entries from orig to this list.
virtual void addTableEntry (DtPrbRangeTableEntry *tableEntry)

Constructor & Destructor Documentation

default constructor

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

Constructor with parameters to set up read/writability correctly.

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

copy constructor

DtPrbRangeList::DtPrbRangeList ( const DtSymbolString name,
const DtPrbRangeList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtPrbRangeList::~DtPrbRangeList ( ) [virtual]

destructor


Member Function Documentation

const DtPrbRangeList& DtPrbRangeList::operator= ( const DtPrbRangeList orig)
virtual DtPrbRangeList* DtPrbRangeList::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]
virtual DtPrbRangeList* DtPrbRangeList::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]
virtual void DtPrbRangeList::addTableEntry ( const DtPrbRangeTableEntry tableEntry) [virtual]

Adds a table entry in sorted (ascending) order.

virtual bool DtPrbRangeList::getProbabilities ( DtReal  range,
DtPrbRangeTableEntry entry 
) const [virtual]

Fills in the DtPrbRangeTableEntry with a category/value pair for each item on its list.

Returns true if an entry was found for the specified range. If no entry was found, returns false, and returns a pointer to an entry with all 0 values.

virtual double DtPrbRangeList::minRangeValue ( ) const [virtual]
Returns:
The minimum range value specified in the list.
0 if no entries exist.
virtual double DtPrbRangeList::maxRangeValue ( ) const [virtual]
Returns:
The maximum range value specified in the list.
0 if no entries exist.
virtual DtlObjPtr DtPrbRangeList::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [protected, virtual]

Creates a DtPrbRangeTableEntry, reads it, and adds it to the list.

Implements DtRwList.

void DtPrbRangeList::emptyList ( ) [protected]

Removes all items from the list.

Non-virtual because it is called by constructors/destructors.

void DtPrbRangeList::copyList ( const DtPrbRangeList orig) [protected]

Adds all entries from orig to this list.

Does not clear local list first. Non-virtual because it is called by constructors/destructors.

virtual void DtPrbRangeList::addTableEntry ( DtPrbRangeTableEntry tableEntry) [protected, virtual]

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)