VR-Forces 4.8 Class Documentation
 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 | Static Public Attributes | Protected Member Functions
DtInfluenceInteractionExtension Class Reference

Instances of DtInfluenceInteractionExtension are used to store state data for Influence interactions with the added GuidanceSystem parameter. More...

Inheritance diagram for DtInfluenceInteractionExtension:
Inheritance graph
[legend]

Public Member Functions

 DtInfluenceInteractionExtension (const DtString &influenceName)
 Constructor. More...
 
virtual ~DtInfluenceInteractionExtension ()
 Destructor. More...
 
 DtInfluenceInteractionExtension (const DtInfluenceInteractionExtension &orig)
 Copy constructor. More...
 
DtInfluenceInteractionExtensionoperator= (const DtInfluenceInteractionExtension &orig)
 Assignment operator. More...
 
virtual void printData () const
 Print the interaction's data. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the interaction's data to the specified stream. More...
 
virtual const charname () const
 Name of the interaction. (Not necessarily the ClassName from the FOM.) More...
 
- Public Member Functions inherited from DtInfluenceInteraction
 DtInfluenceInteraction (const DtString &influenceName)
 Constructor. More...
 
virtual ~DtInfluenceInteraction ()
 Destructor. More...
 
 DtInfluenceInteraction (const DtInfluenceInteraction &orig)
 Copy constructor. More...
 
DtInfluenceInteractionoperator= (const DtInfluenceInteraction &orig)
 Assignment operator. More...
 
virtual void printDataToString (DtString &buff) const
 Print the interaction's data to the string provided. More...
 
virtual void setInfluenceName (const DtString &val)
 InfluenceName mutator. More...
 
virtual const DtStringinfluenceName () const
 InfluenceName accessor. More...
 
virtual void setInfluenceType (const DtString &val)
 InfluenceType mutator. More...
 
virtual const DtStringinfluenceType () const
 InfluenceType accessor. More...
 
virtual void setInfluencer (const DtString &val)
 Influencer mutator. More...
 
virtual const DtStringinfluencer () const
 Influencer accessor. More...
 
virtual void setTarget (const DtString &val)
 Target mutator. More...
 
virtual const DtStringtarget () const
 Target accessor. More...
 
virtual void setStrength (DtInt32 val)
 Strength mutator. More...
 
virtual DtInt32 strength () const
 Strength accessor. More...
 
virtual void setDuration (DtTime val)
 Duration mutator. More...
 
virtual DtTime duration () const
 Duration accessor. More...
 
virtual void setLocation (DtVector val)
 Location mutator. More...
 
virtual DtVector location () const
 Location accessor. More...
 
virtual void setStopInfluence (bool val)
 Stop mutator. More...
 
virtual bool stopInfluence () const
 Stop accessor. More...
 
virtual void setHitFactor (int val)
 Engagement specific methods. More...
 
virtual int hitFactor () const
 Hit factor accessor. More...
 
virtual void setProbabilityKilled (double val)
 Probability killed mutator. More...
 
virtual double probabilityKilled () const
 Probability killed accessor. More...
 
virtual void setProbabilityCaptured (double val)
 Probability captured mutator. More...
 
virtual double probabilityCaptured () const
 Probability captured accessor. More...
 
virtual void setProbabilityWounded (double val)
 Probability wounded mutator. More...
 
virtual double probabilityWounded () const
 Probability wounded accessor. More...
 
virtual void setWeaponType (const DtString &val)
 WeaponType mutator. More...
 
virtual const DtStringweaponType () const
 WeaponType accessor. More...
 
virtual void setGuidanceSystem (const DtString &val)
 GuidanceSystem mutator. More...
 
virtual const DtStringguidanceSystem () const
 GuidanceSystem accessor. More...
 
virtual void setTargetPart (const DtString &val)
 TargetPart mutator. More...
 
virtual const DtStringtargetPart () const
 TargetPart accessor. More...
 
virtual void setIsPointAttack (bool val)
 IsPointAttack mutator. More...
 
virtual bool isPointAttack () const
 IsPointAttack accessor. More...
 

Static Public Member Functions

static DtInteractioncreate ()
 Create a DtInfluenceInter. More...
 
static void addCallback (DtExerciseConn *conn, DtInfluenceInterExtensionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register)/Remove (deregister) function to be called when interaction occurs. More...
 
static void removeCallback (DtExerciseConn *conn, DtInfluenceInterExtensionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 
- Static Public Member Functions inherited from DtInfluenceInteraction
static DtInteractioncreate ()
 Create a DtInfluenceInter. More...
 
static void addCallback (DtExerciseConn *conn, DtInfluenceInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register)/Remove (deregister) function to be called when interaction occurs. More...
 
static void removeCallback (DtExerciseConn *conn, DtInfluenceInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 

Static Public Attributes

static const DtString theEngagementInfluenceName
 
- Static Public Attributes inherited from DtInfluenceInteraction
static const DtString theEngagementInfluenceName
 

Protected Member Functions

 DtInfluenceInteractionExtension ()
 The general constructor is only accessible via the create() static function. More...
 
- Protected Member Functions inherited from DtInfluenceInteraction
 DtInfluenceInteraction ()
 The general constructor is only accessible via the create() static function. More...
 

Additional Inherited Members

- Protected Attributes inherited from DtInfluenceInteraction
DtString myInfluenceName
 
DtString myInfluenceType
 
DtString myInfluencer
 
DtString myTarget
 
DtInt32 myStrength
 
DtTime myDuration
 
DtVector myLocation
 
bool myStopInfluence
 
DtInt32 myHitFactor
 
double myProbabilityKilled
 
double myProbabilityCaptured
 
double myProbabilityWounded
 
DtString myWeaponType
 
DtString myGuidanceSystem
 
DtString myTargetPart
 
bool myIsPointAttack
 
DtString myMutableInteractionClass
 Not a parameter of the class. More...
 

Detailed Description

Instances of DtInfluenceInteractionExtension are used to store state data for Influence interactions with the added GuidanceSystem parameter.

Ultimately this parameter should be added to DtInfluenceInteraction at which time this class can be removed.

Constructor & Destructor Documentation

DtInfluenceInteractionExtension::DtInfluenceInteractionExtension ( )
protected

The general constructor is only accessible via the create() static function.

It is intended only for use when receiving an interaction.

DtInfluenceInteractionExtension::DtInfluenceInteractionExtension ( const DtString influenceName)

Constructor.

Requires the influence name, which is equivalent to the subclass of the Influence FOM class. For instance, if you wanted to send an Influence.Engagement interaction, you would pass the string "Engagement". If you wanted to send an Influence.Engagement.AntiAir interaction, you would pass the string "Engagement.AntiAir".

virtual DtInfluenceInteractionExtension::~DtInfluenceInteractionExtension ( )
virtual

Destructor.

DtInfluenceInteractionExtension::DtInfluenceInteractionExtension ( const DtInfluenceInteractionExtension orig)

Copy constructor.

Member Function Documentation

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

Assignment operator.

virtual void DtInfluenceInteractionExtension::printData ( ) const
virtual

Print the interaction's data.

Reimplemented from DtInfluenceInteraction.

virtual void DtInfluenceInteractionExtension::printDataToStream ( std::ostream &  stream) const
virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInfluenceInteraction.

virtual const char* DtInfluenceInteractionExtension::name ( void  ) const
inlinevirtual

Name of the interaction. (Not necessarily the ClassName from the FOM.)

Reimplemented from DtInfluenceInteraction.

static DtInteraction* DtInfluenceInteractionExtension::create ( )
static

Create a DtInfluenceInter.

Caller is responsible for deletion.

static void DtInfluenceInteractionExtension::addCallback ( DtExerciseConn *  conn,
DtInfluenceInterExtensionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
)
static

Add (register)/Remove (deregister) function to be called when interaction occurs.

static void DtInfluenceInteractionExtension::removeCallback ( DtExerciseConn *  conn,
DtInfluenceInterExtensionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
)
static

Member Data Documentation

const DtString DtInfluenceInteractionExtension::theEngagementInfluenceName
static

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)