class DtSimResourceManager:

Instances of DtSimResourceManager are readable/writable lists of DtSimResources. It provides hash table lookup for all of an entity's resources, including sub-resources. During initialization, resource capacity and starting values specified in any DtLocalEntityParameters are copied to the DtSimResourceManager. Subresources should NOT be placed on the resource manager explicitly. That is done automatically by DtSimResource's addChildResource (and vice versa for removeChildResource).

Inheritance diagram for DtSimResourceManager:

[legend]

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

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

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

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

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

DtSimResourceManager &	operator= (const DtSimResourceManager &orig)

bool	operator!= (const DtSimResourceManager &orig) const

bool	operator== (const DtSimResourceManager &orig) const

virtual	~DtSimResourceManager ()

virtual const char *	readerWriterType () const

virtual DtSimResource *	lookupResource (const DtString &resourceName)

virtual const DtSimResource *	lookupResource (const DtString &resourceName) const

virtual DtSimResource *	addResource (DtSimResource *resource)

virtual bool	removeResource (DtSimResource *resource)

virtual void	merge (const DtSimResourceManager &)

virtual DtSimResourceManager *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtSimResourceManager *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual void	clearResources ()

virtual void	addToHashIndex (DtSimResource *resource)

virtual void	removeFromHashIndex (DtSimResource *resource)

const std::map< DtString, DtSimResource * > &	resources () const

std::map< DtString, DtSimResource * > &	resources ()

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

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 (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 ()

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
	DtSimResourceManager ()

virtual void	removeResource (DtSimResource resource, DtListItem item)

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
std::map< DtString, DtSimResource * >	myResourceMap

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

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)

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

DtSimResourceManager::DtSimResourceManager ( )

protected

default constructor

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

real constructor

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

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

copy constructor

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

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

virtual DtSimResourceManager::~DtSimResourceManager ( )

virtual

destructor

Member Function Documentation

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

assignment operator

bool DtSimResourceManager::operator!= ( const DtSimResourceManager & orig ) const

inline

bool DtSimResourceManager::operator== ( const DtSimResourceManager & orig ) const

virtual const char* DtSimResourceManager::readerWriterType ( ) const

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.

virtual DtSimResource* DtSimResourceManager::lookupResource ( const DtString & resourceName )

virtual

virtual const DtSimResource* DtSimResourceManager::lookupResource ( const DtString & resourceName ) const

virtual

virtual DtSimResource* DtSimResourceManager::addResource ( DtSimResource * resource )

virtual

This does a clone of the resource and puts it on our main list, as well as adding the resource to the hash index.

virtual bool DtSimResourceManager::removeResource ( DtSimResource * resource )

virtual

Finds the specified resource wherever it is located in the resource hierarchy, and removes and deletes it.

Returns: True if resource was found and removed.

virtual void DtSimResourceManager::merge ( const DtSimResourceManager & )

virtual

Merges the one resource manager into this one. When merged, if there is already a resource with a given name, the existing resource will take on the maximum of the current entry vs. the new entry.

virtual DtSimResourceManager* DtSimResourceManager::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual DtSimResourceManager* DtSimResourceManager::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

virtual void DtSimResourceManager::clearResources ( )

virtual

Clears out resources and empty list.

virtual void DtSimResourceManager::addToHashIndex ( DtSimResource * resource )

virtual

The following 2 functions are provided for use by the addChildResource/ removeChildResource calls in DtSimResource. They may eventually become protected (with access to DtSimResource provided by friend functions.)

This adds the resource to our hash index, but no cloning is done.

virtual void DtSimResourceManager::removeFromHashIndex ( DtSimResource * resource )

virtual

This removes the resource from the index. The resource is NOT deleted.

const std::map<DtString, DtSimResource*>& DtSimResourceManager::resources ( ) const

inline

Returns a list of the resource keys for this manager. Can be used to iterate through the resources.
Example:
.

const DtList* munitions = resourceManager().resources(); 
if ( munitions )  
{ 
   for (DtListItem* item = munitions->first(); item; item = item->next()) 
   { 
      DtBaseHashKey* key = static_cast<DtBaseHashKey*>(item->data()); 
      if ( !key ) continue; 
      DtSimResource* resource = resourceManager().lookupResource(*key); 
      if ( !resource ) continue; 
      DtMunitionResource* munitionResource = static_cast<DtMunitionResource*>(resource);
      if ( munitionResource->amount() != 0 ) 
      { 
         munitionResource->deplete(1); 
         break; 
      } 
   }//!  end for loop 
}

std::map<DtString, DtSimResource*>& DtSimResourceManager::resources ( )

inline

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

virtual

Clears out resources before reading in new data.

Reimplemented from DtRwList.

virtual void DtSimResourceManager::removeResource	(	DtSimResource *	resource,
		DtListItem *	item
	)

protectedvirtual

This removes just from the main list, not the index.

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

protectedvirtual

This method must be overridden by a subclass. Within this method, new instances of the DtReaderWriter subclass that is being handled by this list must be created, and then retrieved from the mtl stream, using the getSelf member of that item.

: Here is some sample code that could be used to implement a override of this class: (This is used in the DtRwIntegerList::getData() method)
DtlObjPtr nameObj = DtcCar(args);

DtRwInt* value = new DtRwInt(nameObj->pname());

value->getSelf(args, searchPaths, variableBindings);

this->add(value);

return DtcCdr(DtcCdr(args));

Implements DtRwList.

Member Data Documentation

std::map<DtString, DtSimResource*> DtSimResourceManager::myResourceMap

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/simResourceManager.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation