VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtHumanParameters Class Reference

DtHumanParameters; used to hold all of the configurable parameters for the DtIndividualLifeFormStateRepository class. More...

Inheritance diagram for DtHumanParameters:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtHumanParameters (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor with parameters to set up read/writability correctly
virtual ~DtHumanParameters ()
 destructor
const DtHumanParametersoperator= (const DtHumanParameters &orig)
 assignment operator
virtual DtVrfObjectParametersclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParametersclone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString type () const
 Should return the type of object this is a parameter block for.
virtual bool inheritValues (const DtVrfObjectParameters *benefactor)
 Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual void inheritValuesFromThisType (const DtHumanParameters *benefactor)
virtual DtLifeformState initialPosture () const
 Accessor/mutator for myInitialPosture.
virtual void setInitialPosture (DtLifeformState newPosture)
 Accessor/mutator for myInitialPosture.
virtual DtWeaponState initialWeaponState () const
 Accessor/mutator for myInitialWeaponState.
virtual void setInitialWeaponState (DtWeaponState newWeaponState)
 Accessor/mutator for myInitialWeaponState.

Static Public Member Functions

static DtVrfObjectParameterscreator ()
 

Protected Member Functions

 DtHumanParameters (const DtHumanParameters &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor. Use clone instead...

Protected Attributes

Parameters

These parameters are available for setting in the OPD files.

DtRwIndividualLifeFormStateType myInitialPosture
 Parameter Name: initial-posture Parameter Description: DIS/RPR enumerated values for posture (.e.g is the person standing, crouching, and so on.
DtRwIndividualLifeFormWeaponStateType myInitialWeaponState
 Parameter Name: initial-weapon-state Parameter Description: DIS/RPR enumerated values for weapon position (e.g.

Detailed Description

DtHumanParameters; used to hold all of the configurable parameters for the DtIndividualLifeFormStateRepository class.

Contains the set of readable/writeable parameters assoicated with an individual lifeform type of entity. Developer Description: Used to hold parameters for the DtIndividualLifeFormStateRepository class.


Constructor & Destructor Documentation

DtHumanParameters::DtHumanParameters ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
)

constructor with parameters to set up read/writability correctly

destructor

DtHumanParameters::DtHumanParameters ( const DtHumanParameters orig,
const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) [protected]

copy constructor. Use clone instead...


Member Function Documentation

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

assignment operator

virtual DtVrfObjectParameters* DtHumanParameters::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual DtVrfObjectParameters* DtHumanParameters::clone ( const DtString rwName = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual DtString DtHumanParameters::type ( ) const [virtual]

Should return the type of object this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

Returns:
Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtMovingObjectParameters.

virtual bool DtHumanParameters::inheritValues ( const DtVrfObjectParameters benefactor) [virtual]

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

virtual void DtHumanParameters::inheritValuesFromThisType ( const DtHumanParameters benefactor) [virtual]
virtual DtLifeformState DtHumanParameters::initialPosture ( ) const [virtual]

Accessor/mutator for myInitialPosture.

virtual void DtHumanParameters::setInitialPosture ( DtLifeformState  newPosture) [virtual]

Accessor/mutator for myInitialPosture.

virtual DtWeaponState DtHumanParameters::initialWeaponState ( ) const [virtual]

Accessor/mutator for myInitialWeaponState.

virtual void DtHumanParameters::setInitialWeaponState ( DtWeaponState  newWeaponState) [virtual]

Accessor/mutator for myInitialWeaponState.


Member Data Documentation

Parameter Name: initial-posture Parameter Description: DIS/RPR enumerated values for posture (.e.g is the person standing, crouching, and so on.

Allowed values are

  • default
  • default
  • standing
  • walking
  • running
  • kneeling
  • prone
  • crawling
  • swimming
  • parachuting
  • jumping
  • sitting
  • squatting
  • crouching
  • wading Parameter Default Value: standing

Parameter Name: initial-weapon-state Parameter Description: DIS/RPR enumerated values for weapon position (e.g.

stowed, deployed, in firing position). Allowed values are

  • no-weapon
  • weapon-stowed
  • weapon-deployed
  • weapon-in-fire-position Parameter Default Value: weapon deployed

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)