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:

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

Static Public Member Functions
static DtInteraction *	create ()
	Create a DtInfluenceInter.
static void	addCallback (DtExerciseConn *conn, DtInfluenceInterExtensionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtInfluenceInterExtensionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Static Public Member Functions inherited from DtInfluenceInteraction
static void	addCallback (DtExerciseConn *conn, DtInfluenceInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
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.
Protected Member Functions inherited from DtInfluenceInteraction
	DtInfluenceInteraction ()
	The general constructor is only accessible via the create() static function.

Protected Attributes
DtString	myWeaponType
DtString	myGuidanceSystem
DtString	myTargetPart
bool	myIsPointAttack
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	myMutableInteractionClass
	Not a parameter of the class.

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 void DtInfluenceInteractionExtension::setWeaponType ( const DtString &  val )

virtual

WeaponType mutator.

virtual const DtString& DtInfluenceInteractionExtension::weaponType ( ) const

virtual

WeaponType accessor.

virtual void DtInfluenceInteractionExtension::setGuidanceSystem ( const DtString &  val )

virtual

GuidanceSystem mutator.

virtual const DtString& DtInfluenceInteractionExtension::guidanceSystem ( ) const

virtual

GuidanceSystem accessor.

virtual void DtInfluenceInteractionExtension::setTargetPart ( const DtString &  val )

virtual

TargetPart mutator.

virtual const DtString& DtInfluenceInteractionExtension::targetPart ( ) const

virtual

TargetPart accessor.

virtual void DtInfluenceInteractionExtension::setIsPointAttack ( bool  val )

virtual

IsPointAttack mutator.

virtual bool DtInfluenceInteractionExtension::isPointAttack ( ) const

virtual

IsPointAttack accessor.

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.

Reimplemented from DtInfluenceInteraction.

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

DtString DtInfluenceInteractionExtension::myWeaponType

protected

DtString DtInfluenceInteractionExtension::myGuidanceSystem

protected

DtString DtInfluenceInteractionExtension::myTargetPart

protected

bool DtInfluenceInteractionExtension::myIsPointAttack

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfExtendedProperties/influenceInteractionExtension.h