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

DtTargetPriorityList is a readable/writable list of DtTargetPriorityEntrys. More...

Inheritance diagram for DtTargetPriorityList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtTargetPriorityList ()
 DtTargetPriorityList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor with parameters to set up read/writability correctly
 DtTargetPriorityList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtTargetPriorityList (const DtString &name, const DtTargetPriorityList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtTargetPriorityList (const DtSymbolString &name, const DtTargetPriorityList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtTargetPriorityList (const DtTargetPriorityList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtTargetPriorityListoperator= (const DtTargetPriorityList &orig)
virtual ~DtTargetPriorityList ()
 destructor
virtual DtTargetPriorityListclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtTargetPriorityListclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtTargetPriorityEntryaddTargetPriorityEntry (const DtTargetPriorityEntry &priEntry)
 Adds a target priority entry.
virtual DtTargetPriorityEntryaddTargetPriorityEntry (const DtEntityType &priEntry)
virtual int priority (const DtEntityType &entityType, DtEntityType *bestMatch=NULL) const
 Returns the priority of the entity specified.
virtual DtListItem * lookupTargetPriorityEntry (const DtEntityType &entityType) const

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Creates the DtTargetPriorityEntry, reads it, and adds it to the list.
void emptyList ()
 Non-virtual because it is called from constructor/destructor.
void copyList (const DtTargetPriorityList &orig)
 Non-virtual because it is called from constructor/destructor.
virtual DtTargetPriorityEntryaddTargetPriorityEntry (DtTargetPriorityEntry *priEntry)
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.

Detailed Description

DtTargetPriorityList is a readable/writable list of DtTargetPriorityEntrys.

It's sorted by the entity type in the entry, and will return a priority based on the best match found for the entity type indicated.


Constructor & Destructor Documentation

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

constructor with parameters to set up read/writability correctly

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

copy constructor

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

destructor


Member Function Documentation

const DtTargetPriorityList& DtTargetPriorityList::operator= ( const DtTargetPriorityList orig)
virtual DtTargetPriorityList* DtTargetPriorityList::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]
virtual DtTargetPriorityList* DtTargetPriorityList::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]

Adds a target priority entry.

List is kept in ascending order (by the entity type specified in the entry).

virtual DtTargetPriorityEntry* DtTargetPriorityList::addTargetPriorityEntry ( const DtEntityType &  priEntry) [virtual]
virtual int DtTargetPriorityList::priority ( const DtEntityType &  entityType,
DtEntityType *  bestMatch = NULL 
) const [virtual]

Returns the priority of the entity specified.

If no match is found, -1 is returned.

virtual DtListItem* DtTargetPriorityList::lookupTargetPriorityEntry ( const DtEntityType &  entityType) const [virtual]
virtual DtlObjPtr DtTargetPriorityList::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
) [protected, virtual]

Creates the DtTargetPriorityEntry, reads it, and adds it to the list.

Implements DtRwList.

void DtTargetPriorityList::emptyList ( ) [protected]

Non-virtual because it is called from constructor/destructor.

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

Non-virtual because it is called from constructor/destructor.

virtual const char* DtTargetPriorityList::readerWriterType ( ) const [protected, 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.


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)