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 More...

	DtDetonationInteraction (const DtFireInteraction &fire)
	Constructor Fills in common fields with data from Fire Interaction. More...

virtual	~DtDetonationInteraction ()
	destructor More...

	DtDetonationInteraction (const DtDetonationInteraction &orig)
	copy constructor More...

DtDetonationInteraction &	operator= (const DtDetonationInteraction &orig)
	assignment operator More...

virtual void	printData () const
	Print the interaction's data. More...

virtual void	printDataToString (DtString &str) const
	Print the interaction's data to the string provided. More...

virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the specified stream. More...

virtual void	setAttackerId (const DtGlobalObjectDesignator &id)
	Set/Get the attacker identifier. More...

virtual const DtGlobalObjectDesignator &	attackerId () const

virtual void	setTargetId (const DtGlobalObjectDesignator &id)
	Set/Get the target identifier. More...

virtual const DtGlobalObjectDesignator &	targetId () const

virtual void	setMunitionId (const DtGlobalObjectDesignator &id)
	Set/Get the munition identifier. More...

virtual const DtGlobalObjectDesignator &	munitionId () const

virtual void	setEventId (const DtEventID &id)
	Set/Get the detonation event id. More...

virtual const DtEventID &	eventId () const

virtual void	setVelocity (const DtVector32 &velocity)
	Set/Get the velocity. More...

virtual const DtVector32 &	velocity () const

virtual void	setWorldLocation (const DtVector &location)
	Set/Get the location of the detonation in world coordinates. More...

virtual const DtVector &	worldLocation () const

virtual void	setEntityLocation (const DtVector32 &location)
	Set/Get the location of the detonation in entity coordinates. More...

virtual const DtVector32 &	entityLocation () const

virtual void	setResult (DtDetonationResult result)
	Set/Get the detonation result. More...

virtual DtDetonationResult	result () const

virtual void	setFuseType (DtDetonatorFuze fuse)
	Set/Get the detonator fuze type. More...

virtual DtDetonatorFuze	fuseType () const

virtual void	setMunitionType (const DtEntityType &munType)
	Set/Get the munition type. More...

virtual const DtEntityType &	munitionType () const

virtual void	setQuantity (int quant)
	Set/Get the quantity. More...

virtual int	quantity () const

virtual void	setRate (int rate)
	Set/Get the rate. More...

virtual int	rate () const

virtual void	setWarheadType (DtWarheadType type)
	Set/Get the warhead type. More...

virtual DtWarheadType	warheadType () const

virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.) More...


virtual DtArticulatedPartCollection *	artPartList ()
	Get a pointer to an DtArtPartCollection containing the interaction's articulated part information. More...

virtual const DtArticulatedPartCollection *	artPartList () const
	Get a pointer to an DtArtPartCollection containing the interaction's articulated part information. More...


virtual void	setArticulatedParts (const DtArticulatedPartCollection &apList)
	Set/Get the articulated parts collection. More...

const DtArticulatedPartCollection &	articulatedParts () const
	Set/Get the articulated parts collection. More...

DtArticulatedPartCollection &	articulatedParts ()
	Set/Get the articulated parts collection. More...

Public Member Functions inherited from DtInteractionWithEncDec
	DtInteractionWithEncDec ()
	default constructor More...

virtual	~DtInteractionWithEncDec ()
	destructor More...

	DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
	copy constructor More...

DtInteractionWithEncDec &	operator= (const DtInteractionWithEncDec &orig)
	assignment operator More...

virtual void	setExConn (DtExerciseConn exConn, DtInterClassDesc classDesc=NULL)
	Sets the interaction's ExerciseConn and class descriptor. More...

virtual const RTI::ParameterHandleValuePairSet &	phvps () const
	Get the parameter handle value pair set for the interaction. More...

virtual void	setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList)
	Set contents from a parameter handle value pair set. More...

virtual void	useThese (DtInteractionEncoder enc, DtInteractionDecoder dec, DtInteractionRep *data)
	Specify an encoder, decoder, and interaction data repository to use in encoding and decoding. More...

virtual DtInteractionEncoder *	encoder () const
	Return the encoder we are using. More...

virtual DtInteractionDecoder *	decoder () const
	Return the decoder we are using. More...

virtual void	setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
	Set the Parameter with the given handle. More...

virtual const char *	getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given handle. More...

virtual void	setParameterByName (const DtString &name, const char *attrValue, unsigned size)
	Set the Parameter with the given name. More...

virtual const char *	getParameterByName (const DtString &name, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given name. More...

Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor More...

virtual	~DtInteraction ()
	destructor More...

	DtInteraction (const DtInteraction &orig)
	copy constructor More...

DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator More...

virtual RTI::InteractionClassHandle	interactionClassHandle () const
	Get the interaction class handle. Returns 0 if no classDesc. More...

virtual char *	interactionClassName () const
	Get the interaction class name. Returns NULL if no classDesc. More...

virtual int	numParameters () const
	Get the number of parameters. Returns 0 if no classDesc. More...

virtual bool	neededByFederation () const
	Returns true if the interaction class is needed by the federation false otherwise. More...

virtual void	print () const
	Print the interaction's host rep data, including header. More...

virtual void	printToStream (std::ostream &stream) const
	Print the interaction to a stream. More...

virtual void	printHeader () const
	Print the header info. More...

virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header info to a stream. More...

virtual void	printParams (bool withHex) const
	Print the header followed by the interaction's parameters. More...

virtual void	printParamsToStream (std::ostream &stream, bool withHex) const
	Print the header followed by the interaction's parameters to a stream. More...

virtual DtExerciseConn *	exerciseConn () const
	Get the current exercise connection. More...

virtual DtInterClassDesc *	classDesc () const
	Get the current class descriptor we're using for this interaction. More...

virtual bool	customTagSet () const
	Get whether a custom tag has been set on the interaction or not. More...

virtual void	setCustomTag (const DtString &a_tag)
	Set the user-defined tag. More...

virtual void	setTag (const DtString &tag)
	Set the user-defined tag. More...

virtual const DtString &	tag () const
	Get the user-defined tag. More...

virtual const RTI::Region *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message. More...

virtual void	setConveyedRegion (const RTI::Region *region)

virtual void	setProducingFederateHandle (RTI::FederateHandle federateHandle)
	HLA Evolved added an argument that provides the FederateHandle of the federate that produced the interaction being received. More...

virtual RTI::FederateHandle	producingFederateHandle () const
	The producing federate handle. Invalid if not enabled (or could be from MOM). More...

virtual const DtString &	producingFederateName () const
	The producing federate handle is used to get the federate name (cached after first access). More...

virtual void	setTransportationTypeHandle (RTI::TransportationTypeHandle transportationTypeHandle)
	HLA 4 added an argument that provides the TransportationTypeHandle. More...

virtual RTI::TransportationTypeHandle	transportationTypeHandle () const
	The transportation type handle. More...

virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the time of validity of the message, and whether this represents relative or absolute time. More...

virtual DtTime	timeStamp () const
	Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp. More...

virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp. More...

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. More...

virtual void	setFedTime (const RTI::FedTime &ft)
	This is used for TSO interactions. More...

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. More...

virtual void	setEventRetractionHandle (const RTI::EventRetractionHandle &handle)
	Get/Set the EventRetractionHandle. More...

virtual RTI::EventRetractionHandle	eventRetractionHandle () const
	Get the event retraction handle. For more info see setEventRetractionHandle. More...

Static Public Member Functions
static DtInteraction *	create ()
	Create a DtDetonationInteraction. More...

static void	addCallback (DtExerciseConn conn, DtDetonationInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs. More...

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

Static Public Member Functions inherited from DtInteraction
static void	setTagIsAsciiTime (bool val)
	Set/Get flag that tells us whether we're using the RPR FOM convention that the UserDefinedTag in updates and interactions represents a DIS-style timestamp. More...

static bool	tagIsAsciiTime ()

static void	addCallback (DtExerciseConn conn, const std::vector< DtString > classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Register/Deregister callback function cb with conn, on all interaction class name (char*) contained in classes. More...

static void	removeCallback (DtExerciseConn conn, const std::vector< DtString > classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

static void	addCallback (DtExerciseConn conn, const char className, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Can be used instead of above for a single class. More...

static void	removeCallback (DtExerciseConn conn, const char className, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtVector	myWorldLocation

DtDetonationResult	myResult

DtEventID	myEventId

DtGlobalObjectDesignator	myAttackerId

DtVector32	myVelocity

DtDetonatorFuze	myFuseType

DtGlobalObjectDesignator	myMunitionId

DtEntityType	myMunitionType

int	myQuantity

int	myRate

DtVector32	myEntityLocation

DtGlobalObjectDesignator	myTargetId

DtWarheadType	myWarheadType

DtArticulatedPartCollection	myPartList

Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder

DtInteractionEncoder *	myEncoder

DtInteractionRep *	myData

std::map< RTI::ParameterHandle, DtGenericParameterInfo * >	myParametersByHandle
	parameters by handle. More...

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

const RTI::Region *	myConveyedRegion

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. More...

virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const
	Called by encoderToUse to obtain a new'ed encoder. More...

virtual DtInteractionDecoder *	decoderToUse (DtExerciseConn *exConn) const
	Returns a decoder to use for decoding the interaction. More...

virtual DtInteractionEncoder *	encoderToUse (DtExerciseConn *exConn) const
	Returns an encoder to use for encoding the interaction. More...

Protected Member Functions inherited from DtInteraction
virtual const char *	interactionClassToUse (DtExerciseConn *exConn) const
	Returns the FOM interaction class name to use. More...

virtual RTI::ParameterHandleValuePairSet *	privPvList () const
	Returns a pointer to a private pvList that can be used as a return value by phvps. More...

DtInteraction *	self () const
	Get rid of const-ness on the "this" pointer in order to access non-const functions from const member functions (such as simple accessors). More...

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.

DtArticulatedPartCollection& DtDetonationInteraction::articulatedParts ( )

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 DtVector32& 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 DtVector32 & 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 DtVector32 & 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 DtVector32& DtDetonationInteraction::velocity ( ) const

virtual

virtual DtWarheadType DtDetonationInteraction::warheadType ( ) const

virtual

virtual const DtVector& DtDetonationInteraction::worldLocation ( ) const

virtual

Member Data Documentation

DtGlobalObjectDesignator DtDetonationInteraction::myAttackerId

protected

DtVector32 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

DtVector32 DtDetonationInteraction::myVelocity

protected

DtWarheadType DtDetonationInteraction::myWarheadType

protected

DtVector DtDetonationInteraction::myWorldLocation

protected

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

detonationInteractionHLA.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation