class DtRemoveEntityInteraction: More...

Inheritance diagram for DtRemoveEntityInteraction:

Collaboration diagram for DtRemoveEntityInteraction:

Public Member Functions
	DtRemoveEntityInteraction ()
	default constructor
virtual	~DtRemoveEntityInteraction ()
	destructor
	DtRemoveEntityInteraction (const DtRemoveEntityInteraction &orig)
	copy constructor
DtRemoveEntityInteraction &	operator= (const DtRemoveEntityInteraction &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	setSenderId (const DtEntityIdentifier &id)
	Set/Get sender ID.
virtual const DtEntityIdentifier &	senderId () const
virtual void	setReceiverId (const DtEntityIdentifier &id)
	Set/Get receiver ID.
virtual const DtEntityIdentifier &	receiverId () const
virtual void	setRequestId (int id)
	Set/Get request ID.
virtual int	requestId () 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::ParameterHandleValueMap &	phvm () const
	Get the parameter handle value pair set for the interaction.
virtual void	setFromPhvm (const RTI::ParameterHandleValueMap &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	printDataToString (DtString &buff) const
	Print the interaction's data to the string provided.
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 RTI::VariableLengthData &a_tag)
	Set the user-defined tag.
virtual void	setTag (const RTI::VariableLengthData &tag)
	Set the user-defined tag.
virtual const RTI::VariableLengthData &	tag () const
	Get the user-defined tag.
virtual const RTI::RegionHandleSet *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message.
virtual void	setConveyedRegion (const RTI::RegionHandleSet *sentRegionHandleSet)
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::LogicalTime &ft)
	This is used for TSO interactions.
virtual const RTI::LogicalTime *	fedTime () const
	When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set.
virtual void	setMessageRetractionHandle (const RTI::MessageRetractionHandle &handle)
	Get/Set the MessageRetractionHandle.
virtual RTI::MessageRetractionHandle	messageRetractionHandle () const
	Get the message retraction handle. For more info see setMessageRetractionHandle.

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

Protected Attributes
DtEntityIdentifier	myOrigEnt
DtEntityIdentifier	myReceiveEnt
int	myRequestId
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
Protected Attributes inherited from DtInteraction
DtInterClassDesc *	myClassDesc
DtExerciseConn *	myExConn
DtTime	myTime
DtTimeStampType	myTimeType
RTI::LogicalTime *	myFedTime
RTI::ParameterHandleValueMap	myPvList
RTI::MessageRetractionHandle	myRetractionHandle
RTI::VariableLengthData	myTag
const RTI::RegionHandleSet *	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

class DtRemoveEntityInteraction:

Instances of DtRemoveEntityInteraction are used to represent RemoveEntity Interactions in the RPR FOM.

Constructor & Destructor Documentation

DtRemoveEntityInteraction::DtRemoveEntityInteraction ( )

default constructor

virtual DtRemoveEntityInteraction::~DtRemoveEntityInteraction ( )

virtual

destructor

DtRemoveEntityInteraction::DtRemoveEntityInteraction ( const DtRemoveEntityInteraction & orig )

copy constructor

Member Function Documentation

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

static

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

static DtInteraction* DtRemoveEntityInteraction::create ( )

static

Create a DtRemoveEntityInteraction.

Caller is responsible for deletion.

const char * DtRemoveEntityInteraction::name ( ) const

inlinevirtual

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

Implements DtInteraction.

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

assignment operator

virtual void DtRemoveEntityInteraction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

const DtEntityIdentifier & DtRemoveEntityInteraction::receiverId ( ) const

inlinevirtual

References myReceiveEnt.

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

static

int DtRemoveEntityInteraction::requestId ( ) const

inlinevirtual

References myRequestId.

const DtEntityIdentifier & DtRemoveEntityInteraction::senderId ( ) const

inlinevirtual

References myOrigEnt.

void DtRemoveEntityInteraction::setReceiverId ( const DtEntityIdentifier & id )

inlinevirtual

Set/Get receiver ID.

References myReceiveEnt.

void DtRemoveEntityInteraction::setRequestId ( int id )

inlinevirtual

Set/Get request ID.

References myRequestId.

void DtRemoveEntityInteraction::setSenderId ( const DtEntityIdentifier & id )

inlinevirtual

Set/Get sender ID.

References myOrigEnt.

Member Data Documentation

DtEntityIdentifier DtRemoveEntityInteraction::myOrigEnt

protected

Referenced by senderId(), and setSenderId().

DtEntityIdentifier DtRemoveEntityInteraction::myReceiveEnt

protected

Referenced by receiverId(), and setReceiverId().

int DtRemoveEntityInteraction::myRequestId

protected

Referenced by requestId(), and setRequestId().

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

removeEntityInteractionHLA.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation