VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtMunitionResource Class Reference

Contains the DtMunitionResource class declaration. More...

Inheritance diagram for DtMunitionResource:
Inheritance graph
[legend]

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
virtual ~DtMunitionResource ()
 destructor
virtual DtSimResourceclone (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 DtSimMunitionmunitionType () 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
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 (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 setResourceManager (DtSimResourceManager *resourceManager)
virtual DtSimResourceManagerresourceManager ()
virtual const
DtSimResourceManager
resourceManager () const
virtual DtSimResourceListsubresources ()
 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 DtSimResourceparent ()
virtual const DtSimResourceparent () 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *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 bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
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 DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static DtSimResourcecreator ()

Protected Member Functions

DtMunitionResourceoperator= (const DtMunitionResource &orig)
 assignment operator; not implemented
- Protected Member Functions inherited from DtIntegerResource
DtIntegerResourceoperator= (const DtIntegerResource &orig)
 assignment operator; not implemented
- 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.
DtSimResourceoperator= (const DtSimResource &orig)
 assignment operator
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
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 DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

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
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
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::pair
< DtSymbolString, DtString
DtVariableNameType
- Static Protected Attributes inherited from DtSimResource
static DtSimResourceFactorymyFactory

Detailed Description

Contains the DtMunitionResource class declaration.

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

assignment operator; not implemented

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

Reimplemented from DtIntegerResource.

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 Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)