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 | Protected Member Functions | Protected Attributes | Private Member Functions
DtMunitionDetonationResultEntry Class Reference

DtMunitionDetonationResultEntry.

DtMunitionDetonationResultEntry specifies a type of munition, its impact radius, and what kind of damage it causes to the terrain.

Inheritance diagram for DtMunitionDetonationResultEntry:
Inheritance graph
[legend]

Public Member Functions

 DtMunitionDetonationResultEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtMunitionDetonationResultEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtMunitionDetonationResultEntry (const DtString &name, const DtMunitionDetonationResultEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtMunitionDetonationResultEntry (const DtSymbolString &name, const DtMunitionDetonationResultEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
const
DtMunitionDetonationResultEntry
operator= (const DtMunitionDetonationResultEntry &orig)
 
virtual ~DtMunitionDetonationResultEntry ()
 
virtual
DtMunitionDetonationResultEntry
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual
DtMunitionDetonationResultEntry
clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
bool operator== (const DtMunitionDetonationResultEntry &rhs) const
 
bool operator!= (const DtMunitionDetonationResultEntry &rhs) const
 
virtual const DtSimMunitionmunition () const
 
virtual void setMunition (const DtSimMunition &m)
 
virtual const
DtDetonationEntityImpactResultParamList
entityImpactResultList () const
 
virtual void setEntityImpactResultList (const DtDetonationEntityImpactResultParamList &results)
 
virtual const
DtDetonationSurfaceImpactResultParamList
surfaceImpactResultList () const
 
virtual void setSurfaceImpactResultList (const DtDetonationSurfaceImpactResultParamList &results)
 
virtual int midAirDetonationResult () const
 
virtual void setMidAirDetonationResult (int r)
 
- 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 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 charreaderWriterType () const
 
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 changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
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)
 

Protected Member Functions

virtual void postGetSelf ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtDetonationResultParam myMidAirDetonationResult
 
parameters

These parameters are available for setting in the OPD files.

DtSimMunition myMunition
 
DtDetonationEntityImpactResultParamList myEntityImpactResultList
 
DtDetonationSurfaceImpactResultParamList mySurfaceImpactResultList
 
DtRwString myMidAirDetonationResultString
 
- 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
 

Private Member Functions

 DtMunitionDetonationResultEntry ()
 

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

DtMunitionDetonationResultEntry::DtMunitionDetonationResultEntry ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

DtMunitionDetonationResultEntry::DtMunitionDetonationResultEntry ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtMunitionDetonationResultEntry::DtMunitionDetonationResultEntry ( const DtString name,
const DtMunitionDetonationResultEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtMunitionDetonationResultEntry::DtMunitionDetonationResultEntry ( const DtSymbolString name,
const DtMunitionDetonationResultEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtMunitionDetonationResultEntry::~DtMunitionDetonationResultEntry ( )
virtual
DtMunitionDetonationResultEntry::DtMunitionDetonationResultEntry ( )
private

default constructor not implemented

Member Function Documentation

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

assignment operator

virtual DtMunitionDetonationResultEntry* DtMunitionDetonationResultEntry::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual DtMunitionDetonationResultEntry* DtMunitionDetonationResultEntry::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual const DtSimMunition& DtMunitionDetonationResultEntry::munition ( ) const
virtual

Accessor/mutator for myMunition.

virtual void DtMunitionDetonationResultEntry::setMunition ( const DtSimMunition m)
virtual

Accessor/mutator for myMunition.

virtual const DtDetonationEntityImpactResultParamList& DtMunitionDetonationResultEntry::entityImpactResultList ( ) const
virtual

Accessor/mutator for #myEntityImpactResultist.

virtual void DtMunitionDetonationResultEntry::setEntityImpactResultList ( const DtDetonationEntityImpactResultParamList results)
virtual

Accessor/mutator for #myEntityImpactResultist.

virtual const DtDetonationSurfaceImpactResultParamList& DtMunitionDetonationResultEntry::surfaceImpactResultList ( ) const
virtual

Accessor/mutator for mySurfaceImpactResultList.

virtual void DtMunitionDetonationResultEntry::setSurfaceImpactResultList ( const DtDetonationSurfaceImpactResultParamList results)
virtual

Accessor/mutator for mySurfaceImpactResultList.

virtual int DtMunitionDetonationResultEntry::midAirDetonationResult ( ) const
virtual

Accessor/mutator for myMidAirDetonationResult.

virtual void DtMunitionDetonationResultEntry::setMidAirDetonationResult ( int  r)
virtual

Accessor/mutator for myMidAirDetonationResult.

bool DtMunitionDetonationResultEntry::operator== ( const DtMunitionDetonationResultEntry rhs) const

Equivalence operator.

bool DtMunitionDetonationResultEntry::operator!= ( const DtMunitionDetonationResultEntry rhs) const
inline
virtual void DtMunitionDetonationResultEntry::postGetSelf ( )
protectedvirtual

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

Reimplemented from DtReaderWriter.

Member Data Documentation

DtSimMunition DtMunitionDetonationResultEntry::myMunition
protected

Parameter Name: munition
Parameter Description: The type of munition that detonated.
Parameter Default Value:
.

DtDetonationEntityImpactResultParamList DtMunitionDetonationResultEntry::myEntityImpactResultList
protected

Parameter Name: entity-impact-param-list
Parameter Description: List of detonation parameters by impacted entity type.
.

DtDetonationSurfaceImpactResultParamList DtMunitionDetonationResultEntry::mySurfaceImpactResultList
protected

Parameter Name: surface-impact-param-list
Parameter Description: List of detonation parameters by impacted surface type.
.

DtRwString DtMunitionDetonationResultEntry::myMidAirDetonationResultString
protected

Parameter Name: detonation-result
Parameter Description: The detonation result to use.
Parameter Default Value: 5 (i.e. "Detonation")
Parameter Units: n/a.

DtDetonationResultParam DtMunitionDetonationResultEntry::myMidAirDetonationResult
protected

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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)