DtDetonationInteraction Class Reference

Instances of DtDetonationInteraction are used to communicate information associated with the impact or detonation of a munition. More...

Inheritance diagram for DtDetonationInteraction:

Collaboration diagram for DtDetonationInteraction:

Public Member Functions
	DtDetonationInteraction ()
	default constructor
	DtDetonationInteraction (const DtFireInteraction &fire)
	Constructor Fills in common fields with data from Fire Interaction.
virtual	~DtDetonationInteraction ()
	destructor
	DtDetonationInteraction (const DtDetonationInteraction &orig)
	copy constructor
DtDetonationInteraction &	operator= (const DtDetonationInteraction &orig)
	assignment operator
virtual void	printData () const
	Print the interaction's data.
virtual void	printDataToString (DtString &str) const
	Print the interaction's data to the string provided.
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the specified stream.
virtual void	setAttackerId (const DtGlobalObjectDesignator &id)
	Set/Get the attacker identifier.
virtual const DtGlobalObjectDesignator &	attackerId () const
virtual void	setTargetId (const DtGlobalObjectDesignator &id)
	Set/Get the target identifier.
virtual const DtGlobalObjectDesignator &	targetId () const
virtual void	setMunitionId (const DtGlobalObjectDesignator &id)
	Set/Get the munition identifier.
virtual const DtGlobalObjectDesignator &	munitionId () const
virtual void	setEventId (const DtEventID &id)
	Set/Get the detonation event id.
virtual const DtEventID &	eventId () const
virtual void	setVelocity (const DtVector &velocity)
	Set/Get the velocity.
virtual const DtVector &	velocity () const
virtual void	setWorldLocation (const DtVector &location)
	Set/Get the location of the detonation in world coordinates.
virtual const DtVector &	worldLocation () const
virtual void	setEntityLocation (const DtVector &location)
	Set/Get the location of the detonation in entity coordinates.
virtual const DtVector &	entityLocation () const
virtual void	setResult (DtDetonationResult result)
	Set/Get the detonation result.
virtual DtDetonationResult	result () const
virtual void	setFuseType (DtDetonatorFuze fuse)
	Set/Get the detonator fuze type.
virtual DtDetonatorFuze	fuseType () const
virtual void	setMunitionType (const DtEntityType &munType)
	Set/Get the munition type.
virtual const DtEntityType &	munitionType () const
virtual void	setQuantity (int quant)
	Set/Get the quantity.
virtual int	quantity () const
virtual void	setRate (int rate)
	Set/Get the rate.
virtual int	rate () const
virtual void	setWarheadType (DtWarheadType type)
	Set/Get the warhead type.
virtual DtWarheadType	warheadType () const
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)
virtual DtArticulatedPartCollection *	artPartList ()
	Get a pointer to an DtArtPartCollection containing the interaction's articulated part information.
virtual const DtArticulatedPartCollection *	artPartList () const
	Get a pointer to an DtArtPartCollection containing the interaction's articulated part information.
virtual void	setArticulatedParts (const DtArticulatedPartCollection &apList)
	Set/Get the articulated parts collection.
const DtArticulatedPartCollection &	articulatedParts () const
	Set/Get the articulated parts collection.
Public Member Functions inherited from DtInteractionWithEncDec
	DtInteractionWithEncDec ()
	default constructor
virtual	~DtInteractionWithEncDec ()
	destructor
	DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
	copy constructor
DtInteractionWithEncDec &	operator= (const DtInteractionWithEncDec &orig)
	assignment operator
virtual void	setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL)
	Sets the interaction's ExerciseConn and class descriptor.
virtual const RTI::ParameterHandleValuePairSet &	phvps () const
	Get the parameter handle value pair set for the interaction.
virtual void	setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList)
	Set contents from a parameter handle value pair set.
virtual void	useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data)
	Specify an encoder, decoder, and interaction data repository to use in encoding and decoding.
virtual DtInteractionEncoder *	encoder () const
	Return the encoder we are using.
virtual DtInteractionDecoder *	decoder () const
	Return the decoder we are using.
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
virtual RTI::InteractionClassHandle	interactionClassHandle () const
	Get the interaction class handle. Returns 0 if no classDesc.
virtual char *	interactionClassName () const
	Get the interaction class name. Returns NULL if no classDesc.
virtual int	numParameters () const
	Get the number of parameters. Returns 0 if no classDesc.
virtual bool	neededByFederation () const
	Returns true if the interaction class is needed by the federation false otherwise.
virtual void	print () const
	Print the interaction's host rep data, including header.
virtual void	printToStream (std::ostream &stream) const
	Print the interaction to a stream.
virtual void	printHeader () const
	Print the header info.
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header info to a stream.
virtual void	printParams (bool withHex) const
	Print the header followed by the interaction's parameters.
virtual void	printParamsToStream (std::ostream &stream, bool withHex) const
	Print the header followed by the interaction's parameters to a stream.
virtual DtExerciseConn *	exerciseConn () const
	Get the current exercise connection.
virtual DtInterClassDesc *	classDesc () const
	Get the current class descriptor we're using for this interaction.
virtual bool	customTagSet () const
	Get whether a custom tag has been set on the interaction or not.
virtual void	setCustomTag (const DtString &a_tag)
	Set the user-defined tag.
virtual void	setTag (const DtString &tag)
	Set the user-defined tag.
virtual const DtString &	tag () const
	Get the user-defined tag.
virtual const DtDDMRegion *	region () const
virtual DtDDMRegion *	region ()
virtual void	setRegion (const DtDDMRegion &region)
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the time of validity of the message, and whether this represents relative or absolute time.
virtual DtTime	timeStamp () const
	Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual void	setFedTime (const RTI::FedTime &ft)
	This is used for TSO interactions.
virtual const RTI::FedTime *	fedTime () const
	When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set.
virtual void	setEventRetractionHandle (const RTI::EventRetractionHandle &handle)
	Get/Set the EventRetractionHandle.
virtual RTI::EventRetractionHandle	eventRetractionHandle () const
	Get the event retraction handle. For more info see setEventRetractionHandle.

Static Public Member Functions
static DtInteraction *	create ()
	Create a DtDetonationInteraction.
static void	addCallback (DtExerciseConn *conn, DtDetonationInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtDetonationInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtVector	myWorldLocation
DtDetonationResult	myResult
DtEventID	myEventId
DtGlobalObjectDesignator	myAttackerId
DtVector	myVelocity
DtDetonatorFuze	myFuseType
DtGlobalObjectDesignator	myMunitionId
DtEntityType	myMunitionType
int	myQuantity
int	myRate
DtVector	myEntityLocation
DtGlobalObjectDesignator	myTargetId
DtWarheadType	myWarheadType
DtArticulatedPartCollection	myPartList
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
Protected Attributes inherited from DtInteraction
DtInterClassDesc *	myClassDesc
DtExerciseConn *	myExConn
DtTime	myTime
DtTimeStampType	myTimeType
DtString	myTag
RTI::ParameterHandleValuePairSet *	myPvList
int	myPvListMaxSize
RTI::FedTime *	myFedTime
RTI::EventRetractionHandle	myRetractionHandle
DtDDMRegion *	myRegion
bool	myCustomTagSet

Additional Inherited Members
Protected Member Functions inherited from DtInteractionWithEncDec
virtual DtInteractionDecoder *	createDecoder (DtExerciseConn *exConn) const
	Called by decoderToUse to obtain a new'ed decoder.
virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const
	Called by encoderToUse to obtain a new'ed encoder.
virtual DtInteractionDecoder *	decoderToUse (DtExerciseConn *exConn) const
	Returns a decoder to use for decoding the interaction.
virtual DtInteractionEncoder *	encoderToUse (DtExerciseConn *exConn) const
	Returns an encoder to use for encoding the interaction.
Static Protected Attributes inherited from DtInteraction
static bool	theTagIsAsciiTime

Detailed Description

Instances of DtDetonationInteraction are used to communicate information associated with the impact or detonation of a munition.

This class is associated with the RPR FOM Detonation Interaction

Constructor & Destructor Documentation

DtDetonationInteraction::DtDetonationInteraction

(

)

default constructor

DtDetonationInteraction::DtDetonationInteraction

(

const DtFireInteraction &

fire

)

Constructor Fills in common fields with data from Fire Interaction.

virtual DtDetonationInteraction::~DtDetonationInteraction ( )

virtual

destructor

DtDetonationInteraction::DtDetonationInteraction

(

const DtDetonationInteraction &

orig

)

copy constructor

Member Function Documentation

static void DtDetonationInteraction::addCallback ( DtExerciseConn *  conn, DtDetonationInteractionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

const DtArticulatedPartCollection& DtDetonationInteraction::articulatedParts

(

)

const

Set/Get the articulated parts collection.

virtual DtArticulatedPartCollection* DtDetonationInteraction::artPartList ( )

virtual

Get a pointer to an DtArtPartCollection containing the interaction's articulated part information.

These methods are primarily for backwards compatibility. setArticulatedParts() and articulatedParts() are protocol independent and preferred.

virtual const DtArticulatedPartCollection* DtDetonationInteraction::artPartList ( ) const

virtual

Get a pointer to an DtArtPartCollection containing the interaction's articulated part information.

These methods are primarily for backwards compatibility. setArticulatedParts() and articulatedParts() are protocol independent and preferred.

virtual const DtGlobalObjectDesignator& DtDetonationInteraction::attackerId ( ) const

virtual

static DtInteraction* DtDetonationInteraction::create ( )

static

Create a DtDetonationInteraction.

Caller is responsible for deletion.

virtual const DtVector& DtDetonationInteraction::entityLocation ( ) const

virtual

virtual const DtEventID& DtDetonationInteraction::eventId ( ) const

virtual

virtual DtDetonatorFuze DtDetonationInteraction::fuseType ( ) const

virtual

virtual const DtGlobalObjectDesignator& DtDetonationInteraction::munitionId ( ) const

virtual

virtual const DtEntityType& DtDetonationInteraction::munitionType ( ) const

virtual

virtual const char* DtDetonationInteraction::name ( ) const

virtual

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

Implements DtInteraction.

DtDetonationInteraction& DtDetonationInteraction::operator=

(

const DtDetonationInteraction &

orig

)

assignment operator

virtual void DtDetonationInteraction::printData ( ) const

virtual

Print the interaction's data.

Reimplemented from DtInteraction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

virtual void DtDetonationInteraction::printDataToString ( DtString &  buff ) const

virtual

Print the interaction's data to the string provided.

Reimplemented from DtInteraction.

virtual int DtDetonationInteraction::quantity ( ) const

virtual

virtual int DtDetonationInteraction::rate ( ) const

virtual

static void DtDetonationInteraction::removeCallback ( DtExerciseConn *  conn, DtDetonationInteractionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual DtDetonationResult DtDetonationInteraction::result ( ) const

virtual

virtual void DtDetonationInteraction::setArticulatedParts ( const DtArticulatedPartCollection &  apList )

virtual

Set/Get the articulated parts collection.

virtual void DtDetonationInteraction::setAttackerId ( const DtGlobalObjectDesignator &  id )

virtual

Set/Get the attacker identifier.

virtual void DtDetonationInteraction::setEntityLocation ( const DtVector &  location )

virtual

Set/Get the location of the detonation in entity coordinates.

virtual void DtDetonationInteraction::setEventId ( const DtEventID &  id )

virtual

Set/Get the detonation event id.

virtual void DtDetonationInteraction::setFuseType ( DtDetonatorFuze  fuse )

virtual

Set/Get the detonator fuze type.

virtual void DtDetonationInteraction::setMunitionId ( const DtGlobalObjectDesignator &  id )

virtual

Set/Get the munition identifier.

virtual void DtDetonationInteraction::setMunitionType ( const DtEntityType &  munType )

virtual

Set/Get the munition type.

virtual void DtDetonationInteraction::setQuantity ( int  quant )

virtual

Set/Get the quantity.

virtual void DtDetonationInteraction::setRate ( int  rate )

virtual

Set/Get the rate.

virtual void DtDetonationInteraction::setResult ( DtDetonationResult  result )

virtual

Set/Get the detonation result.

virtual void DtDetonationInteraction::setTargetId ( const DtGlobalObjectDesignator &  id )

virtual

Set/Get the target identifier.

virtual void DtDetonationInteraction::setVelocity ( const DtVector &  velocity )

virtual

Set/Get the velocity.

virtual void DtDetonationInteraction::setWarheadType ( DtWarheadType  type )

virtual

Set/Get the warhead type.

virtual void DtDetonationInteraction::setWorldLocation ( const DtVector &  location )

virtual

Set/Get the location of the detonation in world coordinates.

virtual const DtGlobalObjectDesignator& DtDetonationInteraction::targetId ( ) const

virtual

virtual const DtVector& DtDetonationInteraction::velocity ( ) const

virtual

virtual DtWarheadType DtDetonationInteraction::warheadType ( ) const

virtual

virtual const DtVector& DtDetonationInteraction::worldLocation ( ) const

virtual

Member Data Documentation

DtGlobalObjectDesignator DtDetonationInteraction::myAttackerId

protected

DtVector DtDetonationInteraction::myEntityLocation

protected

DtEventID DtDetonationInteraction::myEventId

protected

DtDetonatorFuze DtDetonationInteraction::myFuseType

protected

DtGlobalObjectDesignator DtDetonationInteraction::myMunitionId

protected

DtEntityType DtDetonationInteraction::myMunitionType

protected

DtArticulatedPartCollection DtDetonationInteraction::myPartList

protected

int DtDetonationInteraction::myQuantity

protected

int DtDetonationInteraction::myRate

protected

DtDetonationResult DtDetonationInteraction::myResult

protected

DtGlobalObjectDesignator DtDetonationInteraction::myTargetId

protected

DtVector DtDetonationInteraction::myVelocity

protected

DtWarheadType DtDetonationInteraction::myWarheadType

protected

DtVector DtDetonationInteraction::myWorldLocation

protected

---

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

• hDetInter.h