DtAmmunitionParams Class Reference

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

Inheritance diagram for DtAmmunitionParams:

Public Types
typedef std::map < DtSymbolString, DtAmmunitionParamsEntry * >	AmmunitionTable
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 )()

Public Member Functions
	DtAmmunitionParams (const DtAmmunitionParams &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtAmmunitionParams &	operator= (const DtAmmunitionParams &orig)
virtual	~DtAmmunitionParams ()
virtual void	merge (const DtAmmunitionParams *rhs)
virtual void	emptyList (bool clearMemory=true)
virtual void	copyList (const DtAmmunitionParams &)
virtual DtString	displayLabelFor (const DtString &) const
virtual DtString	displayLabelFor (const DtSymbolString &) const
const AmmunitionTable &	ammunitionTable () const
bool	operator== (const DtAmmunitionParams &) const
bool	operator!= (const DtAmmunitionParams &rhs) const
virtual bool	ammunitionCanTarget (const DtString &, const DtEntityType &) const
virtual bool	load (const DtFilename &)
virtual DtAmmunitionParamsEntry *	ammunitionEntry (const DtEntityType &)
virtual const DtAmmunitionParamsEntry *	ammunitionEntry (const DtEntityType &) const
virtual DtAmmunitionParamsEntry *	ammunitionEntry (const DtSymbolString &)
virtual const DtAmmunitionParamsEntry *	ammunitionEntry (const DtSymbolString &) const
virtual DtAmmunitionParamsEntry *	ammunitionEntry (const DtString &)
virtual const DtAmmunitionParamsEntry *	ammunitionEntry (const DtString &) const
virtual DtAmmunitionParamsEntry *	addAmmunition (const DtString &)
virtual DtAmmunitionParamsEntry *	addAmmunition (const DtAmmunitionParamsEntry &)
virtual void	addAmmunition (DtAmmunitionParamsEntry *)
virtual bool	removeAmmunition (DtAmmunitionParamsEntry *)
virtual bool	removeAmmunition (const DtString &)
virtual void	changeAmmunitionName (const DtString &from, const DtString &to)
virtual DtAmmunitionParamsEntry *	createAmmunitionTableEntry () const
	DtAmmunitionParams (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtAmmunitionParams (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 ()
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())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
virtual void	removeAll ()
virtual void	removeAndDeleteAll ()
virtual void	reset ()
virtual const char *	readerWriterType () const
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
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual const char *	xmlType () const
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)
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	wasUpdatedSince (DtTime t) 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)
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)

Protected Attributes
AmmunitionTable	myAmmunitionTable
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

Private Member Functions
	DtAmmunitionParams ()

Additional Inherited Members
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)
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

Member Typedef Documentation

typedef std::map<DtSymbolString, DtAmmunitionParamsEntry*> DtAmmunitionParams::AmmunitionTable

Constructor & Destructor Documentation

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

Constructor.

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

Constructor.

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

copy constructor

Parameters

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

virtual DtAmmunitionParams::~DtAmmunitionParams ( )

virtual

DtAmmunitionParams::DtAmmunitionParams ( )

private

default constructor; not implemented

Member Function Documentation

DtAmmunitionParams& DtAmmunitionParams::operator=

(

const DtAmmunitionParams &

orig

)

assignment

virtual void DtAmmunitionParams::merge ( const DtAmmunitionParams *  rhs )

virtual

Merges the given parameters into our parameters, favoring the new values over the existing ones if there is overlap.

virtual void DtAmmunitionParams::emptyList ( bool  clearMemory = true )

virtual

Deletes all the data in the list if the clearMemory flag is true.

virtual void DtAmmunitionParams::copyList ( const DtAmmunitionParams &  )

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;.

virtual DtString DtAmmunitionParams::displayLabelFor ( const DtString &  ) const

virtual

Returns the display label for the given ammunition parameter name.

virtual DtString DtAmmunitionParams::displayLabelFor ( const DtSymbolString &  ) const

virtual

const AmmunitionTable& DtAmmunitionParams::ammunitionTable ( ) const

inline

bool DtAmmunitionParams::operator==

(

const DtAmmunitionParams &

)

const

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

inline

virtual bool DtAmmunitionParams::ammunitionCanTarget ( const DtString &  , const DtEntityType &    ) const

virtual

Returns true if the given ammunition can target the target type.

virtual bool DtAmmunitionParams::load ( const DtFilename &  )

virtual

Loads the parameters from the given file.

virtual DtAmmunitionParamsEntry* DtAmmunitionParams::ammunitionEntry ( const DtEntityType &  )

virtual

virtual const DtAmmunitionParamsEntry* DtAmmunitionParams::ammunitionEntry ( const DtEntityType &  ) const

virtual

virtual DtAmmunitionParamsEntry* DtAmmunitionParams::ammunitionEntry ( const DtSymbolString &  )

virtual

virtual const DtAmmunitionParamsEntry* DtAmmunitionParams::ammunitionEntry ( const DtSymbolString &  ) const

virtual

virtual DtAmmunitionParamsEntry* DtAmmunitionParams::ammunitionEntry ( const DtString &  )

virtual

virtual const DtAmmunitionParamsEntry* DtAmmunitionParams::ammunitionEntry ( const DtString &  ) const

virtual

virtual DtAmmunitionParamsEntry* DtAmmunitionParams::addAmmunition ( const DtString &  )

virtual

Adds a new ammunition entry with the given name and returns the new entry.

virtual DtAmmunitionParamsEntry* DtAmmunitionParams::addAmmunition ( const DtAmmunitionParamsEntry &  )

virtual

virtual void DtAmmunitionParams::addAmmunition ( DtAmmunitionParamsEntry *  )

virtual

Adds the new ammunition entry. This class will then take ownership of the memory.

virtual bool DtAmmunitionParams::removeAmmunition ( DtAmmunitionParamsEntry *  )

virtual

Removes ammunition by name or entry.

virtual bool DtAmmunitionParams::removeAmmunition ( const DtString &  )

virtual

virtual void DtAmmunitionParams::changeAmmunitionName ( const DtString &  from, const DtString &  to  )

virtual

Changes the ammunition name from the old to the new name.

virtual DtAmmunitionParamsEntry* DtAmmunitionParams::createAmmunitionTableEntry ( ) const

virtual

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

protectedvirtual

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

Implements DtRwList.

Member Data Documentation

AmmunitionTable DtAmmunitionParams::myAmmunitionTable

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/ammunitionParams.h