Readable-writable class holding all parameters to configure the DtTargetingControlTable.

Inheritance diagram for DtAmmunitionPrioritiesList:

Public Member Functions
	DtAmmunitionPrioritiesList (const DtString &name, const DtAmmunitionPrioritiesList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtAmmunitionPrioritiesList (const DtSymbolString &name, const DtAmmunitionPrioritiesList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtAmmunitionPrioritiesList (const DtAmmunitionPrioritiesList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtAmmunitionPrioritiesList &	operator= (const DtAmmunitionPrioritiesList &orig)

virtual	~DtAmmunitionPrioritiesList () override

virtual void	emptyList ()

virtual void	copyList (const DtAmmunitionPrioritiesList &)

bool	operator== (const DtAmmunitionPrioritiesList &) const

bool	operator!= (const DtAmmunitionPrioritiesList &rhs) const

virtual DtAmmunitionPrioritiesListEntry *	addToBeginningOfList (const DtAmmunitionPrioritiesListEntry &)

virtual void	addToBeginningOfList (DtAmmunitionPrioritiesListEntry *)

virtual DtAmmunitionPrioritiesListEntry *	addToListBefore (const DtAmmunitionPrioritiesListEntry &, DtAmmunitionPrioritiesListEntry *)

virtual void	addToListBefore (DtAmmunitionPrioritiesListEntry , DtAmmunitionPrioritiesListEntry before)

virtual DtAmmunitionPrioritiesListEntry *	addToListBefore (const DtAmmunitionPrioritiesListEntry &, const DtEntityType &)

virtual void	addToListBefore (DtAmmunitionPrioritiesListEntry *, const DtEntityType &)

virtual DtAmmunitionPrioritiesListEntry *	addToListAfter (const DtAmmunitionPrioritiesListEntry &, DtAmmunitionPrioritiesListEntry *)

virtual void	addToListAfter (DtAmmunitionPrioritiesListEntry , DtAmmunitionPrioritiesListEntry after)

virtual DtAmmunitionPrioritiesListEntry *	addToListAfter (const DtAmmunitionPrioritiesListEntry &, const DtEntityType &)

virtual void	addToListAfter (DtAmmunitionPrioritiesListEntry *, const DtEntityType &)

virtual DtAmmunitionPrioritiesListEntry *	addAmmunitionTarget (const DtAmmunitionPrioritiesListEntry &)

virtual void	addAmmunitionTarget (DtAmmunitionPrioritiesListEntry *)

virtual DtListItem *	lookupAmmunitionTargetEntry (const DtEntityType &) const

virtual DtAmmunitionPrioritiesListEntry *	ammunitionTargetEntry (const DtEntityType &) const

virtual void	setTo (DtAmmoSelectTable &) const

virtual bool	changeEntityType (const DtEntityType &from, const DtEntityType &to)

virtual bool	removeEntry (const DtEntityType &targetType)

virtual void	removeEntry (const DtEntityType &targetType, const DtEntityType &ammunition)

virtual void	makeTopPriority (const DtEntityType &targetType, const DtEntityType &ammunition)

virtual bool	replacePriority (const DtEntityType &, const DtEntityType &oldAmmo, const DtEntityType &newAmmo)

virtual bool	lowerPriority (const DtEntityType &)

virtual bool	raisePriority (const DtEntityType &)


	DtAmmunitionPrioritiesList (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtAmmunitionPrioritiesList (const DtSymbolString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)

Public Member Functions inherited from DtRwList
	DtRwList ()

	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtRwList () override

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) override

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset () override

virtual const char *	readerWriterType () const override

bool	operator== (const DtRwList &rhs) const

bool	operator!= (const DtRwList &rhs) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual const char *	xmlType () const override

virtual std::set< DtString >	supportedXmlTypes () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Private Member Functions
	DtAmmunitionPrioritiesList ()

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtAmmunitionPrioritiesList::DtAmmunitionPrioritiesList	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructor.

DtAmmunitionPrioritiesList::DtAmmunitionPrioritiesList	(	const DtSymbolString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructor.

DtAmmunitionPrioritiesList::DtAmmunitionPrioritiesList	(	const DtString &	name,
		const DtAmmunitionPrioritiesList &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

Parameters

orig	DtPhysicalWorldParams to copy.
parentRegistry	The registry of the DtReaderWriter object to which this object belongs.

DtAmmunitionPrioritiesList::DtAmmunitionPrioritiesList	(	const DtSymbolString &	name,
		const DtAmmunitionPrioritiesList &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtAmmunitionPrioritiesList::DtAmmunitionPrioritiesList	(	const DtAmmunitionPrioritiesList &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtAmmunitionPrioritiesList::~DtAmmunitionPrioritiesList ( )

overridevirtual

DtAmmunitionPrioritiesList::DtAmmunitionPrioritiesList ( )

private

default constructor; not implemented

Member Function Documentation

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

assignment

virtual void DtAmmunitionPrioritiesList::emptyList ( )

virtual

Deletes all the data in the list.

virtual void DtAmmunitionPrioritiesList::copyList ( const DtAmmunitionPrioritiesList & )

virtual

Copies all the data from the list into this list. If there are similar named objects will replace. Also updates internal map that is used for faster reference;.

bool DtAmmunitionPrioritiesList::operator== ( const DtAmmunitionPrioritiesList & ) const

bool DtAmmunitionPrioritiesList::operator!= ( const DtAmmunitionPrioritiesList & rhs ) const

inline

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::addToBeginningOfList ( const DtAmmunitionPrioritiesListEntry & )

virtual

Adds a cloned entry to the beginning of the priority list. If the entry currently exists that entry will be moved to the beginning of the list.

virtual void DtAmmunitionPrioritiesList::addToBeginningOfList ( DtAmmunitionPrioritiesListEntry * )

virtual

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::addToListBefore	(	const DtAmmunitionPrioritiesListEntry &	,
		DtAmmunitionPrioritiesListEntry *
	)

virtual

Adds to the list before the given item. If the item already exists it is moved to the new location.

virtual void DtAmmunitionPrioritiesList::addToListBefore	(	DtAmmunitionPrioritiesListEntry *	,
		DtAmmunitionPrioritiesListEntry *	before
	)

virtual

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::addToListBefore	(	const DtAmmunitionPrioritiesListEntry &	,
		const DtEntityType &
	)

virtual

IF the entity type does not exist will add to the start of the list.

virtual void DtAmmunitionPrioritiesList::addToListBefore	(	DtAmmunitionPrioritiesListEntry *	,
		const DtEntityType &
	)

virtual

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::addToListAfter	(	const DtAmmunitionPrioritiesListEntry &	,
		DtAmmunitionPrioritiesListEntry *
	)

virtual

Adds to the list after the given item. If the item already exists it is moved to the new location.

virtual void DtAmmunitionPrioritiesList::addToListAfter	(	DtAmmunitionPrioritiesListEntry *	,
		DtAmmunitionPrioritiesListEntry *	after
	)

virtual

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::addToListAfter	(	const DtAmmunitionPrioritiesListEntry &	,
		const DtEntityType &
	)

virtual

IF the entity type does not exist will add to the end of the list.

virtual void DtAmmunitionPrioritiesList::addToListAfter	(	DtAmmunitionPrioritiesListEntry *	,
		const DtEntityType &
	)

virtual

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::addAmmunitionTarget ( const DtAmmunitionPrioritiesListEntry & )

virtual

Adds a cloned entry to the end of the priority list.

virtual void DtAmmunitionPrioritiesList::addAmmunitionTarget ( DtAmmunitionPrioritiesListEntry * )

virtual

Adds the new entry to the list. If the item exists will simply replace the existing item.

virtual DtListItem* DtAmmunitionPrioritiesList::lookupAmmunitionTargetEntry ( const DtEntityType & ) const

virtual

virtual DtAmmunitionPrioritiesListEntry* DtAmmunitionPrioritiesList::ammunitionTargetEntry ( const DtEntityType & ) const

virtual

virtual void DtAmmunitionPrioritiesList::setTo ( DtAmmoSelectTable & ) const

virtual

Takes the ammunition priorities and sets them into the ammo select table.

virtual bool DtAmmunitionPrioritiesList::changeEntityType	(	const DtEntityType &	from,
		const DtEntityType &	to
	)

virtual

Changes the target type from the specified entity type to the new entity type. Returns true if the type is found.

virtual bool DtAmmunitionPrioritiesList::removeEntry ( const DtEntityType & targetType )

virtual

Removes and deletes entry. Returns true if exists.

virtual void DtAmmunitionPrioritiesList::removeEntry	(	const DtEntityType &	targetType,
		const DtEntityType &	ammunition
	)

virtual

Removes the ammunition priority from the given target.

virtual void DtAmmunitionPrioritiesList::makeTopPriority	(	const DtEntityType &	targetType,
		const DtEntityType &	ammunition
	)

virtual

Moves the given priority to the top of the priority list.

virtual bool DtAmmunitionPrioritiesList::replacePriority	(	const DtEntityType &	,
		const DtEntityType &	oldAmmo,
		const DtEntityType &	newAmmo
	)

virtual

Replaces the ammo in the priority list with the new ammo. Will return true if the old ammo is found and replaced.

virtual bool DtAmmunitionPrioritiesList::lowerPriority ( const DtEntityType & )

virtual

If the target priority exists, lowers the priority item.

virtual bool DtAmmunitionPrioritiesList::raisePriority ( const DtEntityType & )

virtual

If the target priority exists, raises the priority.

virtual DtlObjPtr DtAmmunitionPrioritiesList::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

overrideprotectedvirtual

Constructs a DtAmmunitionPrioritiesListEntry, reads the data from the mtl stream, and adds it to the list.

Implements DtRwList.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/ammunitionPrioritiesList.h

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation