 |
VR-Forces Development_Version Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces Development_Version Class Documentation
|
Contains the DtMunitionResource class declaration. More...
Public Member Functions | |
| DtMunitionResource () | |
| default constructor; used by resource factory | |
| DtMunitionResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtMunitionResource (const DtMunitionResource &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtMunitionResource & | operator= (const DtMunitionResource &orig) |
| assignment operator | |
| virtual | ~DtMunitionResource () |
| destructor | |
| virtual DtSimResource * | clone (DtReaderWriterRegistry *parentRegistry=0) const |
| Make a copy of myself. | |
| virtual DtString | type () const |
| The data type of the resource. These types are defined in rsrcTypes.h. | |
| virtual const DtSimMunition & | munitionType () const |
| virtual void | setMunitionType (const DtSimMunition &munitionType) |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
 Public Member Functions inherited from DtIntegerResource | |
| DtIntegerResource () | |
| Default constructor; used by resource factory. | |
| DtIntegerResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| DtIntegerResource (const DtIntegerResource &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtIntegerResource & | operator= (const DtIntegerResource &orig) |
| assignment operator | |
| virtual | ~DtIntegerResource () |
| destructor | |
| virtual void | updateAmountFromChildren () |
| This is called when a child's value changes (or a new child is added). | |
| virtual void | updateFullAmountFromChildren () |
| When the deriving class's setFullAmount is called, this should be called on the resources parent. | |
| virtual void | distributeAmountToChildren () |
| This is called when my amount changes (via setAmount()). | |
| virtual void | distributeFullAmountToChildren () |
| When the deriving class's setFullAmount is called, this should be called if the resource has any children. | |
| virtual void | setAmount (int amount) |
| Amount is set to the amount specified, but will not go over full amount or less than 0. | |
| virtual int | amount () const |
| virtual void | deplete (int amount=1) |
| Amount is reduced by the amount specified, but will not go below 0. | |
| virtual void | replenish (int amount=1) |
| Amount is increased by the amount specified, but will not go above full amount. | |
| virtual void | setFullAmount (int fullAmount) |
| virtual int | fullAmount () const |
| virtual DtReal | percentageFull () const |
| 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) |
| Percent will be truncated to be between 0. and 1. | |
| virtual int | constrainAmount (int amount) const |
| If amount < 0, returns 0. | |
| virtual bool | isEqual (const DtSimResource &res) const |
| Returns true if myAmount and myFullAmount are the same as the resource coming in. | |
| Public Member Functions inherited from DtSimResource | |
| 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 (std::string &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 | 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 |
| bool | operator!= (const DtSimResource &orig) const |
| Expects subclasses to implement isEqual method. Default returns false. | |
| bool | operator== (const DtSimResource &orig) const |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual DtReaderWriter * | defaultRWValue () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restires object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Static Public Member Functions | |
| static DtSimResource * | creator () |
Protected Attributes | |
| DtSimMunition | myMunitionType |
| Protected Attributes inherited from DtIntegerResource | |
| DtRwInt | myAmount |
| DtRwInt | myFullAmount |
| Protected Attributes inherited from DtSimResource | |
| DtSimResourceManager * | myResourceManager |
| DtSimResourceList | mySubresources |
| DtSimResource * | myParent |
| 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 |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
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 )() |
| Protected Member Functions inherited from DtSimResource | |
| 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 | |
| Static Protected Attributes inherited from DtSimResource | |
| static DtSimResourceFactory * | myFactory |
Contains the DtMunitionResource class declaration.
| DtMunitionResource::DtMunitionResource | ( | ) |
default constructor; used by resource factory
| DtMunitionResource::DtMunitionResource | ( | const DtString & | resourceName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
The resource name is the name that will be used to look up the resource in the resource manager.
| DtMunitionResource::DtMunitionResource | ( | const DtMunitionResource & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
| DtMunitionResource& DtMunitionResource::operator= | ( | const DtMunitionResource & | orig | ) |
assignment operator
|
virtual |
Make a copy of myself.
Reimplemented from DtIntegerResource.
|
virtual |
The data type of the resource. These types are defined in rsrcTypes.h.
Reimplemented from DtIntegerResource.
|
virtual |
|
virtual |
|
static |
Reimplemented from DtIntegerResource.
|
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 DtSimResource.
|
protected |