Instances of DtFireInteraction are used to represent the firing of a weapon. More...

Inheritance diagram for DtFireInteraction:

Collaboration diagram for DtFireInteraction:

Public Member Functions
	DtFireInteraction ()
	default constructor
virtual	~DtFireInteraction ()
	destructor
	DtFireInteraction (const DtFireInteraction &orig)
	copy constructor
DtFireInteraction &	operator= (const DtFireInteraction &orig)
	assignment operator
virtual void	printData () const
	Print the interaction's data to DtInfo.
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the specified stream.
virtual void	printDataToString (DtString &buffer) const
	Put the interaction's data into the given buffer.
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 event id.
virtual const DtEventID &	eventId () const
virtual void	setFireMissionIndex (unsigned long i)
	Set/Get the fire mission index.
virtual unsigned long	fireMissionIndex () const
virtual void	setLocation (const DtVector &location)
	Set/Get the location in world coordinates.
virtual const DtVector &	location () const
virtual void	setVelocity (const DtVector32 &velocity)
	Set/Get the velocity.
virtual const DtVector32 &	velocity () const
virtual void	setRange (double range)
	Set/Get the range.
virtual double	range () const
virtual void	setFuseType (DtDetonatorFuze f)
	Set/Get the detonator fuse type.
virtual DtDetonatorFuze	fuseType () const
virtual void	setMunitionType (const DtEntityType &t)
	Set/Get the munition type.
virtual const DtEntityType &	munitionType () const
virtual void	setQuantity (int q)
	Set/Get the quantity.
virtual int	quantity () const
virtual void	setRate (int r)
	Set/Get the rate.
virtual int	rate () const
virtual void	setWarheadType (DtWarheadType t)
	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.)
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.
virtual void	setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
	Set the Parameter with the given handle.
virtual const char *	getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given handle.
virtual void	setParameterByName (const DtString &name, const char *attrValue, unsigned size)
	Set the Parameter with the given name.
virtual const char *	getParameterByName (const DtString &name, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given name.
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 RTI::Region *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message.
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.
virtual RTI::FederateHandle	producingFederateHandle () const
	The producing federate handle. Invalid if not enabled (or could be from MOM).
virtual const DtString &	producingFederateName () const
	The producing federate handle is used to get the federate name (cached after first access).
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 DtFireInteraction.
static void	addCallback (DtExerciseConn conn, DtFireInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn conn, DtFireInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtGlobalObjectDesignator	myAttackerId
DtGlobalObjectDesignator	myTargetId
DtGlobalObjectDesignator	myMunitionId
DtEventID	myEventId
unsigned long	myFireMissionIndex
DtVector	myLocation
DtVector32	myVelocity
double	myRange
DtDetonatorFuze	myFuseType
DtEntityType	myMunitionType
int	myQuantity
int	myRate
DtWarheadType	myWarheadType
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
std::map< RTI::ParameterHandle, DtGenericParameterInfo * >	myParametersByHandle
	parameters by handle.
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.
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 DtFireInteraction are used to represent the firing of a weapon.

Examples

Talk
Listen

Constructor & Destructor Documentation

DtFireInteraction::DtFireInteraction ( )

default constructor

virtual DtFireInteraction::~DtFireInteraction ( )

virtual

destructor

DtFireInteraction::DtFireInteraction ( const DtFireInteraction & orig )

copy constructor

Member Function Documentation

static void DtFireInteraction::addCallback	(	DtExerciseConn *	conn,
		DtFireInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)

static

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

virtual const DtGlobalObjectDesignator& DtFireInteraction::attackerId ( ) const

virtual

static DtInteraction* DtFireInteraction::create ( )

static

Create a DtFireInteraction.

Caller is responsible for deletion.

Reimplemented in MyFireInteraction.

virtual const DtEventID& DtFireInteraction::eventId ( ) const

virtual

virtual unsigned long DtFireInteraction::fireMissionIndex ( ) const

virtual

virtual DtDetonatorFuze DtFireInteraction::fuseType ( ) const

virtual

virtual const DtVector& DtFireInteraction::location ( ) const

virtual

virtual const DtGlobalObjectDesignator& DtFireInteraction::munitionId ( ) const

virtual

virtual const DtEntityType& DtFireInteraction::munitionType ( ) const

virtual

virtual const char* DtFireInteraction::name ( ) const

virtual

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

Implements DtInteraction.

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

assignment operator

virtual void DtFireInteraction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

Reimplemented in MyFireInteraction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

virtual void DtFireInteraction::printDataToString ( DtString & buffer ) const

virtual

Put the interaction's data into the given buffer.

Reimplemented from DtInteraction.

virtual int DtFireInteraction::quantity ( ) const

virtual

virtual double DtFireInteraction::range ( ) const

virtual

virtual int DtFireInteraction::rate ( ) const

virtual

static void DtFireInteraction::removeCallback	(	DtExerciseConn *	conn,
		DtFireInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)

static

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

virtual

Set/Get the attacker identifier.

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

virtual

Set/Get the event id.

virtual void DtFireInteraction::setFireMissionIndex ( unsigned long i )

virtual

Set/Get the fire mission index.

virtual void DtFireInteraction::setFuseType ( DtDetonatorFuze f )

virtual

Set/Get the detonator fuse type.

virtual void DtFireInteraction::setLocation ( const DtVector & location )

virtual

Set/Get the location in world coordinates.

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

virtual

Set/Get the munition identifier.

virtual void DtFireInteraction::setMunitionType ( const DtEntityType & t )

virtual

Set/Get the munition type.

virtual void DtFireInteraction::setQuantity ( int q )

virtual

Set/Get the quantity.

virtual void DtFireInteraction::setRange ( double range )

virtual

Set/Get the range.

virtual void DtFireInteraction::setRate ( int r )

virtual

Set/Get the rate.

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

virtual

Set/Get the target identifier.

virtual void DtFireInteraction::setVelocity ( const DtVector32 & velocity )

virtual

Set/Get the velocity.

virtual void DtFireInteraction::setWarheadType ( DtWarheadType t )

virtual

Set/Get the warhead type.

virtual const DtGlobalObjectDesignator& DtFireInteraction::targetId ( ) const

virtual

virtual const DtVector32& DtFireInteraction::velocity ( ) const

virtual

virtual DtWarheadType DtFireInteraction::warheadType ( ) const

virtual

Member Data Documentation

DtGlobalObjectDesignator DtFireInteraction::myAttackerId

protected

DtEventID DtFireInteraction::myEventId

protected

unsigned long DtFireInteraction::myFireMissionIndex

protected

DtDetonatorFuze DtFireInteraction::myFuseType

protected

DtVector DtFireInteraction::myLocation

protected

DtGlobalObjectDesignator DtFireInteraction::myMunitionId

protected

DtEntityType DtFireInteraction::myMunitionType

protected

int DtFireInteraction::myQuantity

protected

double DtFireInteraction::myRange

protected

int DtFireInteraction::myRate

protected

DtGlobalObjectDesignator DtFireInteraction::myTargetId

protected

DtVector32 DtFireInteraction::myVelocity

protected

DtWarheadType DtFireInteraction::myWarheadType

protected

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

fireInteractionHLA.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation