VR-Forces 5.0.3 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 Attributes
DtMunitionResource Class Reference

Contains the DtMunitionResource class declaration.

Inheritance diagram for DtMunitionResource:
Inheritance graph
[legend]

Public Member Functions

 DtMunitionResource ()
 
 DtMunitionResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=0)
 
 DtMunitionResource (const DtMunitionResource &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtMunitionResourceoperator= (const DtMunitionResource &orig)
 
virtual ~DtMunitionResource ()
 
virtual DtSimResourceclone (DtReaderWriterRegistry *parentRegistry=0) const
 
virtual DtString type () const
 
virtual const DtSimMunitionmunitionType () const
 
virtual void setMunitionType (const DtSimMunition &munitionType)
 
virtual const charreaderWriterType () const
 
- Public Member Functions inherited from DtIntegerResource
 DtIntegerResource ()
 
 DtIntegerResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtIntegerResource (const DtIntegerResource &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtIntegerResourceoperator= (const DtIntegerResource &orig)
 
virtual ~DtIntegerResource ()
 
virtual void updateAmountFromChildren ()
 
virtual void updateFullAmountFromChildren ()
 
virtual void distributeAmountToChildren ()
 
virtual void distributeFullAmountToChildren ()
 
virtual void setAmount (int amount)
 
virtual int amount () const
 
virtual void deplete (int amount=1)
 
virtual void replenish (int amount=1)
 
virtual void setFullAmount (int fullAmount)
 
virtual int fullAmount () const
 
virtual DtReal percentageFull () const
 
virtual void setPercentageFull (DtReal percent)
 
virtual int constrainAmount (int amount) const
 
virtual bool isEqual (const DtSimResource &res) const
 
virtual void merge (const DtSimResource *)
 
- Public Member Functions inherited from DtSimResource
virtual ~DtSimResource ()
 
virtual bool init ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual void addChildResource (DtSimResource *resource)
 
virtual bool removeChildResource (DtSimResource *resource)
 
virtual void copyResource (const DtSimResource &orig)
 
virtual void setResourceManager (DtSimResourceManager *resourceManager)
 
virtual DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
virtual DtSimResourceListsubresources ()
 
virtual const DtSimResourceListsubresources () const
 
virtual void setParent (DtSimResource *parent)
 
virtual DtSimResourceparent ()
 
virtual const DtSimResourceparent () const
 
bool operator!= (const DtSimResource &orig) const
 
bool operator== (const DtSimResource &orig) 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 DtReaderWriteroperator= (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 getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
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 aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const charxmlType () const
 
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 DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
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 DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
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())
 
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 DtSimResourcecreator ()
 
- Static Public Member Functions inherited from DtIntegerResource
static DtSimResourcecreator ()
 
- Static Public Member Functions inherited from DtSimResource
static DtSimResourcecreateResource (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 DtSimResourceFactoryfactory ()
 
- 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 chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Attributes

DtSimMunition myMunitionType
 
- Protected Attributes inherited from DtIntegerResource
DtRwInt myAmount
 
DtRwInt myFullAmount
 
- Protected Attributes inherited from DtSimResource
DtSimResourceManagermyResourceManager
 
DtSimResourceList mySubresources
 
DtSimResourcemyParent
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
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 )()
 
- Protected Member Functions inherited from DtSimResource
 DtSimResource ()
 
 DtSimResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSimResource (const DtSymbolString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSimResource (const DtSimResource &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtSimResourceoperator= (const DtSimResource &orig)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtSimResource
static DtSimResourceFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

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 DtMunitionResource::~DtMunitionResource ( )
virtual

destructor

Member Function Documentation

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

assignment operator

virtual DtSimResource* DtMunitionResource::clone ( DtReaderWriterRegistry parentRegistry = 0) const
virtual

Make a copy of myself.

Reimplemented from DtIntegerResource.

virtual DtString DtMunitionResource::type ( ) const
virtual

The data type of the resource. These types are defined in rsrcTypes.h.

Reimplemented from DtIntegerResource.

virtual const DtSimMunition& DtMunitionResource::munitionType ( ) const
virtual
virtual void DtMunitionResource::setMunitionType ( const DtSimMunition munitionType)
virtual
static DtSimResource* DtMunitionResource::creator ( )
static
virtual const char* DtMunitionResource::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 DtSimResource.

Member Data Documentation

DtSimMunition DtMunitionResource::myMunitionType
protected

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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)