VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes
DtSimResourceManager Class Reference

class DtSimResourceManager:

Inheritance diagram for DtSimResourceManager:
Inheritance graph
[legend]

Public Member Functions

 DtSimResourceManager ()
 
 DtSimResourceManager (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSimResourceManager (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSimResourceManager (const DtSimResourceManager &orig)
 
virtual ~DtSimResourceManager () override
 
virtual DtSimResource * addResource (const DtEntityType &, double amount, int bin=0)
 
virtual DtSimResource * addResource (const DtSimResource &)
 
virtual bool removeResource (const DtEntityType &, int bin=0)
 
virtual DtSimResource * lookupResource (const DtEntityType &resourceName, int bin=0)
 
virtual const DtSimResource * lookupResource (const DtEntityType &resourceName, int bin=0) const
 
virtual std::vector
< DtSimResource * > 		lookupResources (const std::vector< DtEntityType > &types, int bin=0)
 
virtual std::vector< const
DtSimResource * > 		lookupResources (const std::vector< DtEntityType > &types, int bin=0) const
 
virtual const char * readerWriterType () const override
 
virtual void clear ()
 
virtual void merge (const DtSimResourceManager &)
 
virtual void merge (const DtSimResourceList &)
 
virtual const char * xmlType () const override
 
virtual void restoreResources (int bin=0)
 
virtual void restoreFrom (const DtSimResourceManager &)
 
virtual std::list< DtEntityType > getResourceTypes (const std::vector< DtEntityType > &types, double greaterThanAmount=0, int bin=0) const
 
virtual DtRwTemplatedListPtr & operator= (const DtRwTemplatedListPtr &orig) override
 
DtSimResourceManager & operator= (const DtSimResourceManager &)
 
virtual bool operator== (const DtRwTemplatedListPtr &orig) const override
 
DtSimResourceManager & operator== (const DtSimResourceManager &)
 
bool operator== (const DtSimResourceManager &) const
 
virtual std::shared_ptr
< DtSimResourceList > 		resources (int bin=0)
 
virtual std::shared_ptr< const
DtSimResourceList > 		resources (int bin=0) const
 
virtual std::vector
< DtSimResource * > 		allResources ()
 
virtual std::vector< const
DtSimResource * > 		allResources () const
 
virtual void setKeepOriginalRWNames (bool)
 
bool keepOriginalRWNames () const
 
virtual std::vector< int > bins () const
 
virtual void preGetSelf () override
 
virtual void postGetSelf () override
 
virtual void prePutSelf () override
 
virtual void postPutSelf () override
 
- Public Member Functions inherited from DtRwTemplatedListPtr< DtSimResource, true >
 DtRwTemplatedListPtr ()
 
 DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwTemplatedListPtr () override
 
virtual DtReaderWriter * createPrototype (const char *name="") const override
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
 
virtual DtListItem * insertItemAt (DtSimResource *data, int index)
 
virtual DtListItem * add (DtReaderWriter *item) override
 
virtual DtListItem * add (DtSimResource *data)
 
virtual void removeAll () override
 
void * remove (DtListItem *item)
 
void * remove (DtSimResource *item)
 
virtual std::set< DtString > supportedXmlTypes () const override
 
virtual void removeAndDeleteAll () override
 
bool operator!= (const DtRwTemplatedListPtr &) const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings) override
 
DtListItem * find (boost::function< bool(const DtSimResource &)> predFcn) const
 
virtual DtString prettyPrint () const override
 
void copyList (const DtRwTemplatedListPtr &orig)
 
- 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 * 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 reset () override
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
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
 
- 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 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 &)
 
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)
 

Static Public Member Functions

static const char * theXmlType ()
 
- Static Public Member Functions inherited from DtRwTemplatedListPtr< DtSimResource, true >
static const char * theXmlType ()
 
static const char * ListReaderWriterType ()
 
- 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 Types

typedef std::map< int,
std::shared_ptr
< DtSimResourceList > > 		ResourceByBinMap
 

Protected Attributes

ResourceByBinMap myResourceByBinMap
 
bool myKeepOriginalRWNames = true
 
- Protected Attributes inherited from DtRwTemplatedListPtr< DtSimResource, true >
DtString myXmlType
 
- 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 DtRwTemplatedListPtr< DtSimResource, true >
typedef DtIteratorBase
< DtSimResource > 		iterator
 
typedef DtIteratorBase< const
DtSimResource > 		const_iterator
 
- 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 )()
 
- 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)
 
- 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<int, std::shared_ptr<DtSimResourceList> > DtSimResourceManager::ResourceByBinMap
protected

Constructor & Destructor Documentation

DtSimResourceManager::DtSimResourceManager ( )

default constructor

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

real constructor

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

copy constructor

virtual DtSimResourceManager::~DtSimResourceManager ( )
overridevirtual

destructor

Member Function Documentation

virtual DtSimResource* DtSimResourceManager::addResource ( const DtEntityType &  ,
double  amount,
int  bin = 0 
)
virtual

Adds the specified resource. If the resource already exists, add the amount to the amount already there.

virtual DtSimResource* DtSimResourceManager::addResource ( const DtSimResource &  )
virtual
virtual bool DtSimResourceManager::removeResource ( const DtEntityType &  ,
int  bin = 0 
)
virtual

Removes the specified resource from this list.

virtual DtSimResource* DtSimResourceManager::lookupResource ( const DtEntityType &  resourceName,
int  bin = 0 
)
virtual
virtual const DtSimResource* DtSimResourceManager::lookupResource ( const DtEntityType &  resourceName,
int  bin = 0 
) const
virtual
virtual std::vector<DtSimResource*> DtSimResourceManager::lookupResources ( const std::vector< DtEntityType > &  types,
int  bin = 0 
)
virtual

Returns resources from the specified that are of the given resource type. If the bin is -1, looks at all bins.

virtual std::vector<const DtSimResource*> DtSimResourceManager::lookupResources ( const std::vector< DtEntityType > &  types,
int  bin = 0 
) const
virtual
virtual const char* DtSimResourceManager::readerWriterType ( ) const
overridevirtual

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 DtRwTemplatedListPtr< DtSimResource, true >.

virtual void DtSimResourceManager::clear ( )
virtual

Clears out all resources.

virtual void DtSimResourceManager::merge ( const DtSimResourceManager &  )
virtual

Adds in new resources that don't exist in this list and increases the value of existing resources. Will take the max of the current resource full amount and the supplied full amount. If the total would be > than the new full amount, caps at new full amount.

virtual void DtSimResourceManager::merge ( const DtSimResourceList &  )
virtual
static const char* DtSimResourceManager::theXmlType ( )
static

The type that is used when archiving to an XML stream.

virtual const char* DtSimResourceManager::xmlType ( ) const
inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwTemplatedListPtr< DtSimResource, true >.

References DtRwTemplatedListPtr< T, T_autoDelete >::theXmlType().

virtual void DtSimResourceManager::restoreResources ( int  bin = 0)
virtual

Calls to each resource to restore itsef. If bin is -1 will restore resources in all bins.

virtual void DtSimResourceManager::restoreFrom ( const DtSimResourceManager &  )
virtual
virtual std::list<DtEntityType> DtSimResourceManager::getResourceTypes ( const std::vector< DtEntityType > &  types,
double  greaterThanAmount = 0,
int  bin = 0 
) const
virtual
virtual DtRwTemplatedListPtr& DtSimResourceManager::operator= ( const DtRwTemplatedListPtr &  orig)
overridevirtual

Reimplemented from DtRwTemplatedListPtr< DtSimResource, true >.

DtSimResourceManager& DtSimResourceManager::operator= ( const DtSimResourceManager &  )
virtual bool DtSimResourceManager::operator== ( const DtRwTemplatedListPtr &  ) const
overridevirtual

Equivalence operators.

Reimplemented from DtRwTemplatedListPtr< DtSimResource, true >.

DtSimResourceManager& DtSimResourceManager::operator== ( const DtSimResourceManager &  )
bool DtSimResourceManager::operator== ( const DtSimResourceManager &  ) const
virtual std::shared_ptr<DtSimResourceList> DtSimResourceManager::resources ( int  bin = 0)
virtual
virtual std::shared_ptr<const DtSimResourceList> DtSimResourceManager::resources ( int  bin = 0) const
virtual
virtual std::vector<DtSimResource*> DtSimResourceManager::allResources ( )
virtual
virtual std::vector<const DtSimResource*> DtSimResourceManager::allResources ( ) const
virtual
virtual void DtSimResourceManager::setKeepOriginalRWNames ( bool  )
virtual

On save the manager will change all resource names to be of type "resource<num>". Set this flag to true (default false) to keep original RW names.

bool DtSimResourceManager::keepOriginalRWNames ( ) const
inline
virtual std::vector<int> DtSimResourceManager::bins ( ) const
virtual

Returns the bins that this manager has in it.

virtual void DtSimResourceManager::preGetSelf ( )
overridevirtual

Called before either version of get self (file or environment). Default is no-op.

Reimplemented from DtReaderWriter.

virtual void DtSimResourceManager::postGetSelf ( )
overridevirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

virtual void DtSimResourceManager::prePutSelf ( )
overridevirtual

Called before either version of put self (file or environment). Default is no-op.

Reimplemented from DtReaderWriter.

virtual void DtSimResourceManager::postPutSelf ( )
overridevirtual

Called after either version of put self (file or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Member Data Documentation

ResourceByBinMap DtSimResourceManager::myResourceByBinMap
mutableprotected
bool DtSimResourceManager::myKeepOriginalRWNames = true
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)