 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtSimResource is an abstract base class that can be used to create a hierarchical resource list of a type specified by the deriving class. More...
Public Member Functions | |
| virtual | ~DtSimResource () |
| destructor | |
| virtual bool | init () |
| Base class version just returns true, but this will be called by the createResource call so that deriving classes can do virtual allocation if need be. | |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. | |
| virtual void | addChildResource (DtSimResource *resource) |
| virtual bool | removeChildResource (DtSimResource *resource) |
| Removes the specified resource from this resource's subresource list, or from the subresources of any of those resources. | |
| virtual void | copyResource (const DtSimResource &orig) |
| virtual void | updateAmountFromChildren ()=0 |
| When the deriving class's setAmount is called, this should be called on the resources parent. | |
| virtual void | updateFullAmountFromChildren ()=0 |
| When the deriving class's setFullAmount is called, this should be called on the resources parent. | |
| virtual void | distributeAmountToChildren ()=0 |
| When the deriving class's setAmount is called, this should be called if the resource has any children. | |
| virtual void | distributeFullAmountToChildren ()=0 |
| When the deriving class's setFullAmount is called, this should be called if the resource has any children. | |
| virtual DtReal | percentageFull () const =0 |
| The deriving class will also provide a function to specify the quantity (of the appropriate type) that indicates a full/complete load of the resource. | |
| virtual void | setPercentageFull (DtReal percent)=0 |
| Percent will be truncated to be between 0. and 1. | |
| virtual DtString | type () const =0 |
| The data type of the resource. These types are defined in rsrcTypes.h. | |
| virtual DtSimResource * | clone (DtReaderWriterRegistry *parentRegistry=0) const =0 |
| virtual void | setResourceManager (DtSimResourceManager *resourceManager) |
| virtual DtSimResourceManager * | resourceManager () |
| virtual const DtSimResourceManager * | resourceManager () const |
| virtual DtSimResourceList * | subresources () |
| Accessor to this resource's subresources. | |
| virtual void | setParent (DtSimResource *parent) |
| The parent pointer is actually kept in the subresources list, since it needs it as well. | |
| virtual DtSimResource * | parent () |
| virtual const DtSimResource * | parent () const |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual bool | isEqual (const DtSimResource &res) const |
| bool | operator!= (const DtSimResource &orig) const |
| Expects subclasses to implement isEqual method. Default returns false. | |
| bool | operator== (const DtSimResource &orig) const |
Static Public Member Functions | |
| static DtSimResource * | createResource (DtlObjPtr mtlStream, const DtVariableBindingsList &variableBindings) |
| static void | addResourceCreatorFcn (const DtString &type, DtSimResourceCreatorFcn fcn) |
| static void | addResourceCreatorFcn (const DtSymbolString &type, DtSimResourceCreatorFcn fcn) |
| static void | setFactory (DtSimResourceFactory *factory) |
| static DtSimResourceFactory * | factory () |
Protected Member Functions | |
| DtSimResource () | |
| default constructor | |
| DtSimResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtSimResource (const DtSymbolString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtSimResource (const DtSimResource &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor The copy constructor only calls down to the base class copy constructor. | |
| DtSimResource & | operator= (const DtSimResource &orig) |
| assignment operator | |
Protected Attributes | |
| DtSimResourceManager * | myResourceManager |
| DtSimResourceList | mySubresources |
| DtSimResource * | myParent |
Static Protected Attributes | |
| static DtSimResourceFactory * | myFactory |
DtSimResource is an abstract base class that can be used to create a hierarchical resource list of a type specified by the deriving class.
The deriving class must provide an implementation of getData that knows how to create the right kind of resource when reading from a file. It also must provide implementations of updateAmountFromChildren(), which determines the amount of this resource by summing up from any child resources, and distributeAmountToChildren().
| DtSimResource::DtSimResource | ( | ) | [protected] |
default constructor
| DtSimResource::DtSimResource | ( | const DtString & | resourceName, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) | [protected] |
real constructor
The resource name is the name that will be used to look up the resource in the resource manager.
| DtSimResource::DtSimResource | ( | const DtSymbolString & | resourceName, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) | [protected] |
| DtSimResource::DtSimResource | ( | const DtSimResource & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) | [protected] |
copy constructor The copy constructor only calls down to the base class copy constructor.
It does not copy the mySubresources member. Derived classes must do this in their copy constructor implementations as follows:
mySubresources.setParent(this); mySubresources.copyList(orig.mySubresources, parentRegistry);
| virtual DtSimResource::~DtSimResource | ( | ) | [virtual] |
destructor
| DtSimResource& DtSimResource::operator= | ( | const DtSimResource & | orig | ) | [protected] |
assignment operator
| virtual bool DtSimResource::init | ( | ) | [virtual] |
Base class version just returns true, but this will be called by the createResource call so that deriving classes can do virtual allocation if need be.
| virtual void DtSimResource::putData | ( | FILE * | fp, |
| int | indentLevel = 0 |
||
| ) | [virtual] |
putData writes our type, which is provided by the virtual type accessor of the deriving class.
Reimplemented from DtReaderWriter.
| virtual void DtSimResource::addChildResource | ( | DtSimResource * | resource | ) | [virtual] |
| virtual bool DtSimResource::removeChildResource | ( | DtSimResource * | resource | ) | [virtual] |
Removes the specified resource from this resource's subresource list, or from the subresources of any of those resources.
Does not delete the resource.
| virtual void DtSimResource::copyResource | ( | const DtSimResource & | orig | ) | [virtual] |
| virtual void DtSimResource::updateAmountFromChildren | ( | ) | [pure virtual] |
When the deriving class's setAmount is called, this should be called on the resources parent.
Implemented in DtRealResource, and DtIntegerResource.
| virtual void DtSimResource::updateFullAmountFromChildren | ( | ) | [pure virtual] |
When the deriving class's setFullAmount is called, this should be called on the resources parent.
Implemented in DtRealResource, and DtIntegerResource.
| virtual void DtSimResource::distributeAmountToChildren | ( | ) | [pure virtual] |
When the deriving class's setAmount is called, this should be called if the resource has any children.
Implemented in DtRealResource, and DtIntegerResource.
| virtual void DtSimResource::distributeFullAmountToChildren | ( | ) | [pure virtual] |
When the deriving class's setFullAmount is called, this should be called if the resource has any children.
Implemented in DtRealResource, and DtIntegerResource.
| virtual DtReal DtSimResource::percentageFull | ( | ) | const [pure virtual] |
The deriving class will also provide a function to specify the quantity (of the appropriate type) that indicates a full/complete load of the resource.
PercentageFull will return 0. to 1., amount / fullAmount Note: 1. is returned if full amount is <= 0.
Implemented in DtRealResource, and DtIntegerResource.
| virtual void DtSimResource::setPercentageFull | ( | DtReal | percent | ) | [pure virtual] |
Percent will be truncated to be between 0. and 1.
Implemented in DtRealResource, and DtIntegerResource.
| virtual DtString DtSimResource::type | ( | ) | const [pure virtual] |
The data type of the resource. These types are defined in rsrcTypes.h.
Implemented in DtRealResource, DtIntegerResource, and DtMunitionResource.
Referenced by DtMunitionResourceIterator::firstMatch().
| virtual DtSimResource* DtSimResource::clone | ( | DtReaderWriterRegistry * | parentRegistry = 0 | ) | const [pure virtual] |
Implemented in DtRealResource, DtIntegerResource, and DtMunitionResource.
| virtual void DtSimResource::setResourceManager | ( | DtSimResourceManager * | resourceManager | ) | [virtual] |
| virtual DtSimResourceManager* DtSimResource::resourceManager | ( | ) | [virtual] |
| virtual const DtSimResourceManager* DtSimResource::resourceManager | ( | ) | const [virtual] |
| virtual DtSimResourceList* DtSimResource::subresources | ( | ) | [virtual] |
Accessor to this resource's subresources.
Referenced by DtRecursiveResourceIterator::next().
| virtual void DtSimResource::setParent | ( | DtSimResource * | parent | ) | [virtual] |
The parent pointer is actually kept in the subresources list, since it needs it as well.
| virtual DtSimResource* DtSimResource::parent | ( | ) | [virtual] |
| virtual const DtSimResource* DtSimResource::parent | ( | ) | const [virtual] |
| static DtSimResource* DtSimResource::createResource | ( | DtlObjPtr | mtlStream, |
| const DtVariableBindingsList & | variableBindings | ||
| ) | [static] |
| static void DtSimResource::addResourceCreatorFcn | ( | const DtString & | type, |
| DtSimResourceCreatorFcn | fcn | ||
| ) | [static] |
| static void DtSimResource::addResourceCreatorFcn | ( | const DtSymbolString & | type, |
| DtSimResourceCreatorFcn | fcn | ||
| ) | [static] |
| static void DtSimResource::setFactory | ( | DtSimResourceFactory * | factory | ) | [static] |
| static DtSimResourceFactory* DtSimResource::factory | ( | ) | [static] |
Reimplemented from DtReaderWriter.
| virtual const char* DtSimResource::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 DtReaderWriter.
Reimplemented in DtMunitionResource.
| virtual bool DtSimResource::isEqual | ( | const DtSimResource & | res | ) | const [virtual] |
Reimplemented in DtRealResource, and DtIntegerResource.
| bool DtSimResource::operator!= | ( | const DtSimResource & | orig | ) | const [inline] |
Expects subclasses to implement isEqual method. Default returns false.
| bool DtSimResource::operator== | ( | const DtSimResource & | orig | ) | const |
DtSimResourceManager* DtSimResource::myResourceManager [protected] |
DtSimResourceList DtSimResource::mySubresources [protected] |
DtSimResource* DtSimResource::myParent [protected] |
DtSimResourceFactory* DtSimResource::myFactory [static, protected] |