DtInfluenceInteraction Class Reference

Instances of DtInfluenceInter are used to store state data for Influence interactions. More...

Inheritance diagram for DtInfluenceInteraction:

Public Member Functions
	DtInfluenceInteraction (const DtString &influenceName)
	Constructor.
virtual	~DtInfluenceInteraction ()
	Destructor.
	DtInfluenceInteraction (const DtInfluenceInteraction &orig)
	Copy constructor.
DtInfluenceInteraction &	operator= (const DtInfluenceInteraction &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	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 const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)
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, 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

Protected Member Functions
	DtInfluenceInteraction ()
	The general constructor is only accessible via the create() static function.

Protected Attributes
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 DtInfluenceInter are used to store state data for Influence interactions.

Constructor & Destructor Documentation

DtInfluenceInteraction::DtInfluenceInteraction ( )

protected

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

It is intended only for use when receiving an interaction.

DtInfluenceInteraction::DtInfluenceInteraction

(

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 DtInfluenceInteraction::~DtInfluenceInteraction ( )

virtual

Destructor.

DtInfluenceInteraction::DtInfluenceInteraction

(

const DtInfluenceInteraction &

orig

)

Copy constructor.

Member Function Documentation

DtInfluenceInteraction& DtInfluenceInteraction::operator=

(

const DtInfluenceInteraction &

orig

)

Assignment operator.

virtual void DtInfluenceInteraction::printData ( ) const

virtual

Print the interaction's data.

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

virtual

Print the interaction's data to the specified stream.

virtual void DtInfluenceInteraction::setInfluenceName ( const DtString &  val )

virtual

InfluenceName mutator.

virtual const DtString& DtInfluenceInteraction::influenceName ( ) const

virtual

InfluenceName accessor.

virtual void DtInfluenceInteraction::setInfluenceType ( const DtString &  val )

virtual

InfluenceType mutator.

virtual const DtString& DtInfluenceInteraction::influenceType ( ) const

virtual

InfluenceType accessor.

virtual void DtInfluenceInteraction::setInfluencer ( const DtString &  val )

virtual

Influencer mutator.

virtual const DtString& DtInfluenceInteraction::influencer ( ) const

virtual

Influencer accessor.

virtual void DtInfluenceInteraction::setTarget ( const DtString &  val )

virtual

Target mutator.

virtual const DtString& DtInfluenceInteraction::target ( ) const

virtual

Target accessor.

virtual void DtInfluenceInteraction::setStrength ( DtInt32  val )

virtual

Strength mutator.

virtual DtInt32 DtInfluenceInteraction::strength ( ) const

virtual

Strength accessor.

virtual void DtInfluenceInteraction::setDuration ( DtTime  val )

virtual

Duration mutator.

virtual DtTime DtInfluenceInteraction::duration ( ) const

virtual

Duration accessor.

virtual void DtInfluenceInteraction::setLocation ( DtVector  val )

virtual

Location mutator.

virtual DtVector DtInfluenceInteraction::location ( ) const

virtual

Location accessor.

virtual void DtInfluenceInteraction::setStopInfluence ( bool  val )

virtual

Stop mutator.

virtual bool DtInfluenceInteraction::stopInfluence ( ) const

virtual

Stop accessor.

virtual void DtInfluenceInteraction::setHitFactor ( int  val )

virtual

Engagement specific methods.

Hit factor mutator.

virtual int DtInfluenceInteraction::hitFactor ( ) const

virtual

Hit factor accessor.

virtual void DtInfluenceInteraction::setProbabilityKilled ( double  val )

virtual

Probability killed mutator.

virtual double DtInfluenceInteraction::probabilityKilled ( ) const

virtual

Probability killed accessor.

virtual void DtInfluenceInteraction::setProbabilityCaptured ( double  val )

virtual

Probability captured mutator.

virtual double DtInfluenceInteraction::probabilityCaptured ( ) const

virtual

Probability captured accessor.

virtual void DtInfluenceInteraction::setProbabilityWounded ( double  val )

virtual

Probability wounded mutator.

virtual double DtInfluenceInteraction::probabilityWounded ( ) const

virtual

Probability wounded accessor.

virtual const char* DtInfluenceInteraction::name ( void  ) const

inlinevirtual

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

static DtInteraction* DtInfluenceInteraction::create ( )

static

Create a DtInfluenceInter.

Caller is responsible for deletion.

static void DtInfluenceInteraction::addCallback ( DtExerciseConn *  conn, DtInfluenceInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

static void DtInfluenceInteraction::removeCallback ( DtExerciseConn *  conn, DtInfluenceInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

Member Data Documentation

const DtString DtInfluenceInteraction::theEngagementInfluenceName

static

DtString DtInfluenceInteraction::myInfluenceName

protected

DtString DtInfluenceInteraction::myInfluenceType

protected

DtString DtInfluenceInteraction::myInfluencer

protected

DtString DtInfluenceInteraction::myTarget

protected

DtInt32 DtInfluenceInteraction::myStrength

protected

DtTime DtInfluenceInteraction::myDuration

protected

DtVector DtInfluenceInteraction::myLocation

protected

bool DtInfluenceInteraction::myStopInfluence

protected

DtInt32 DtInfluenceInteraction::myHitFactor

protected

double DtInfluenceInteraction::myProbabilityKilled

protected

double DtInfluenceInteraction::myProbabilityCaptured

protected

double DtInfluenceInteraction::myProbabilityWounded

protected

DtString DtInfluenceInteraction::myMutableInteractionClass

mutableprotected

Not a parameter of the class.

This is simply the interaction class to be used when sending this interaction.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfExtObjects/influenceInteractionHLA.h