VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtAmmoSelectTable Class Reference

DtAmmoSelectTable is a readable/writable list of DtAmmoSelectEntrys. More...

Inheritance diagram for DtAmmoSelectTable:
Inheritance graph
[legend]

Public Member Functions

 DtAmmoSelectTable ()
 DtAmmoSelectTable (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor with parameters to set up read/writability correctly
 DtAmmoSelectTable (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtAmmoSelectTable (const DtString &name, const DtAmmoSelectTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtAmmoSelectTable (const DtSymbolString &name, const DtAmmoSelectTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtAmmoSelectTableoperator= (const DtAmmoSelectTable &orig)
virtual ~DtAmmoSelectTable ()
 destructor
virtual DtAmmoSelectTableclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtAmmoSelectTableclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void addAmmoSelectEntry (const DtAmmoSelectEntry &selectEntry)
 Adds a target priority entry.
virtual const DtSimMunitionListsimMunitionList (const DtEntityType &targetType, DtEntityType *bestMatch=NULL) const
 Returns the list of DtSimMunitions appropriate for the target.
- Public Member Functions inherited from DtRwList
 DtRwList ()
 default constructor
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtRwList ()
const DtRwListoperator= (const DtRwList &orig)
 Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem * add (DtReaderWriter *data)
 Add element to the end of the list.
virtual DtListItem * addToStart (DtReaderWriter *data)
 Add element to the beginning of the list.
virtual DtListItem * addToEnd (DtReaderWriter *data)
 Add element to the end of the list.
virtual void * remove (DtReaderWriter *data, DtListItem *item)
 Remove an element from the list.
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Top level to read itself from an input stream.
virtual DtListItem * addBefore (DtReaderWriter *data, DtReaderWriter *before)
 Add element to the list just before the indicated item.
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 Add element to the list just after the indicated item.
virtual void removeAll ()
 Removes all the items in the list.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
 DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 Invokes DtReaderWriter copy constructor.
 DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 Invokes DtReaderWriter copy constructor.
virtual DtListItem * addBefore (DtReaderWriter *data, const DtString &before)
 Add element to the list just before the indicated item.
virtual DtListItem * addBefore (DtReaderWriter *data, const DtSymbolString &before)
 Add element to the list just before the indicated item.
virtual DtListItem * addAfter (DtReaderWriter *data, const DtString &after)
 Add element to the list just after the indicated item.
virtual DtListItem * addAfter (DtReaderWriter *data, const DtSymbolString &after)
 Add element to the list just after the indicated item.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Creates a DtAmmoSelectEntry, reads it, and adds it to the list.
virtual DtListItem * lookupAmmoSelectEntry (const DtEntityType &targetType) const
 Lookup a DtAmmoSelectEntry, for a given target type.
virtual void emptyList ()
virtual void copyList (const DtAmmoSelectTable &orig)
virtual void addAmmoSelectEntry (DtAmmoSelectEntry *selectEntry)
- Protected Member Functions inherited from DtRwList
virtual DtListItem * addBefore (DtReaderWriter *data, DtListItem *before)
 Add element to the list just before the indicated item.
virtual DtListItem * addAfter (DtReaderWriter *data, DtListItem *after)
 Add element to the list just after the indicated item.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

DtSimMunitionList myDefaultList
 This is returned if no entry is found for the specified target; it's an empty list (count() == 0).

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.
static DtReaderWriterFactoryfactory ()
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Detailed Description

DtAmmoSelectTable is a readable/writable list of DtAmmoSelectEntrys.

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

Constructor & Destructor Documentation

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

constructor with parameters to set up read/writability correctly

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

copy constructor

DtAmmoSelectTable::DtAmmoSelectTable ( const DtSymbolString name,
const DtAmmoSelectTable orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtAmmoSelectTable::~DtAmmoSelectTable ( )
virtual

destructor

Member Function Documentation

const DtAmmoSelectTable& DtAmmoSelectTable::operator= ( const DtAmmoSelectTable orig)
virtual DtAmmoSelectTable* DtAmmoSelectTable::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual DtAmmoSelectTable* DtAmmoSelectTable::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual void DtAmmoSelectTable::addAmmoSelectEntry ( const DtAmmoSelectEntry selectEntry)
virtual

Adds a target priority entry.

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

virtual const DtSimMunitionList& DtAmmoSelectTable::simMunitionList ( const DtEntityType &  targetType,
DtEntityType *  bestMatch = NULL 
) const
virtual

Returns the list of DtSimMunitions appropriate for the target.

virtual DtlObjPtr DtAmmoSelectTable::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
protectedvirtual

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

Implements DtRwList.

virtual DtListItem* DtAmmoSelectTable::lookupAmmoSelectEntry ( const DtEntityType &  targetType) const
protectedvirtual

Lookup a DtAmmoSelectEntry, for a given target type.

Parameters
targetTypeDIS/RPR entity type enumeration for target
Returns
DtListItem* containing a DtAmmoSelectEntry*
virtual void DtAmmoSelectTable::emptyList ( )
protectedvirtual
virtual void DtAmmoSelectTable::copyList ( const DtAmmoSelectTable orig)
protectedvirtual
virtual void DtAmmoSelectTable::addAmmoSelectEntry ( DtAmmoSelectEntry selectEntry)
protectedvirtual

Member Data Documentation

DtSimMunitionList DtAmmoSelectTable::myDefaultList
protected

This is returned if no entry is found for the specified target; it's an empty list (count() == 0).


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)