DtStopFreezeInteraction Class Reference

Instances of DtStopFreezeInteraction are used to represent StopFreeze Interactions in the RPR ROM. More...

Inheritance diagram for DtStopFreezeInteraction:

Collaboration diagram for DtStopFreezeInteraction:

Public Member Functions
	DtStopFreezeInteraction ()
	Default CTOR. More...
	DtStopFreezeInteraction (const DtStopFreezeInteraction &orig)
	Copy CTOR. More...
virtual	~DtStopFreezeInteraction ()
	Virtual DTOR. More...
DtStopFreezeInteraction &	operator= (const DtStopFreezeInteraction &orig)
	Assignment operator. More...
virtual void	printData () const
	Print the interaction's data to DtInfo. More...
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the specified stream. More...
virtual void	setSenderId (const DtEntityIdentifier &id)
	Set/Get sender ID. More...
virtual const DtEntityIdentifier &	senderId () const
virtual void	setReceiverId (const DtEntityIdentifier &id)
	Set/Get receiver ID. More...
virtual const DtEntityIdentifier &	receiverId () const
virtual void	setRealWorldTime (const DtTime time)
	Set/Get real world time. More...
virtual DtTime	realWorldTime () const
DtTimeStampType	realWorldTimeType () const
	Set/Get real world time type (represented by last bit of RealWorldTime). More...
void	setRealWorldTimeType (const DtTimeStampType type)
virtual void	setRequestId (int id)
	Set/Get request ID. More...
virtual int	requestId () const
virtual DtStopReason	reason () const
	Set/Get stopReason. More...
virtual void	setReason (DtStopReason reason)
virtual bool	reflectWhenFrozen () const
	SetGet reflectWhenFrozen flag. More...
virtual void	setReflectWhenFrozen (bool flag)
virtual bool	runClockWhenFrozen () const
	SetGet runClockWhenFrozen flag. More...
virtual void	setRunClockWhenFrozen (bool flag)
virtual bool	updateWhenFrozen () const
	SetGet updateWhenFrozen flag. More...
virtual void	setUpdateWhenFrozen (bool flag)
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.) 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	printDataToString (DtString &buff) const
	Print the interaction's data to the string provided. 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	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 DtStopFreezeInteraction. More...
static void	addCallback (DtExerciseConn *conn, DtStopFreezeInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs. More...
static void	removeCallback (DtExerciseConn *conn, DtStopFreezeInteractionCb 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
DtEntityIdentifier	myOrigEnt
DtEntityIdentifier	myReceiveEnt
int	myRequestId
DtTime	myRealTime
DtTimeStampType	myRealTimeType
DtStopReason	myReason
bool	myReflect
bool	myUpdate
bool	myRunClock
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 DtStopFreezeInteraction are used to represent StopFreeze Interactions in the RPR ROM.

Constructor & Destructor Documentation

DtStopFreezeInteraction::DtStopFreezeInteraction

(

)

Default CTOR.

DtStopFreezeInteraction::DtStopFreezeInteraction

(

const DtStopFreezeInteraction &

orig

)

Copy CTOR.

virtual DtStopFreezeInteraction::~DtStopFreezeInteraction ( )

virtual

Virtual DTOR.

Member Function Documentation

static void DtStopFreezeInteraction::addCallback ( DtExerciseConn *  conn, DtStopFreezeInteractionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

static DtInteraction* DtStopFreezeInteraction::create ( )

static

Create a DtStopFreezeInteraction.

Caller is responsible for deletion.

virtual const char* DtStopFreezeInteraction::name ( ) const

virtual

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

Implements DtInteraction.

DtStopFreezeInteraction& DtStopFreezeInteraction::operator=

(

const DtStopFreezeInteraction &

orig

)

Assignment operator.

virtual void DtStopFreezeInteraction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

virtual DtTime DtStopFreezeInteraction::realWorldTime ( ) const

virtual

DtTimeStampType DtStopFreezeInteraction::realWorldTimeType

(

)

const

Set/Get real world time type (represented by last bit of RealWorldTime).

virtual DtStopReason DtStopFreezeInteraction::reason ( ) const

virtual

Set/Get stopReason.

virtual const DtEntityIdentifier& DtStopFreezeInteraction::receiverId ( ) const

virtual

virtual bool DtStopFreezeInteraction::reflectWhenFrozen ( ) const

virtual

SetGet reflectWhenFrozen flag.

static void DtStopFreezeInteraction::removeCallback ( DtExerciseConn *  conn, DtStopFreezeInteractionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual int DtStopFreezeInteraction::requestId ( ) const

virtual

virtual bool DtStopFreezeInteraction::runClockWhenFrozen ( ) const

virtual

SetGet runClockWhenFrozen flag.

virtual const DtEntityIdentifier& DtStopFreezeInteraction::senderId ( ) const

virtual

virtual void DtStopFreezeInteraction::setRealWorldTime ( const DtTime  time )

virtual

Set/Get real world time.

void DtStopFreezeInteraction::setRealWorldTimeType

(

const DtTimeStampType

type

)

virtual void DtStopFreezeInteraction::setReason ( DtStopReason  reason )

virtual

virtual void DtStopFreezeInteraction::setReceiverId ( const DtEntityIdentifier &  id )

virtual

Set/Get receiver ID.

virtual void DtStopFreezeInteraction::setReflectWhenFrozen ( bool  flag )

virtual

virtual void DtStopFreezeInteraction::setRequestId ( int  id )

virtual

Set/Get request ID.

virtual void DtStopFreezeInteraction::setRunClockWhenFrozen ( bool  flag )

virtual

virtual void DtStopFreezeInteraction::setSenderId ( const DtEntityIdentifier &  id )

virtual

Set/Get sender ID.

virtual void DtStopFreezeInteraction::setUpdateWhenFrozen ( bool  flag )

virtual

virtual bool DtStopFreezeInteraction::updateWhenFrozen ( ) const

virtual

SetGet updateWhenFrozen flag.

Member Data Documentation

DtEntityIdentifier DtStopFreezeInteraction::myOrigEnt

protected

DtTime DtStopFreezeInteraction::myRealTime

protected

DtTimeStampType DtStopFreezeInteraction::myRealTimeType

protected

DtStopReason DtStopFreezeInteraction::myReason

protected

DtEntityIdentifier DtStopFreezeInteraction::myReceiveEnt

protected

bool DtStopFreezeInteraction::myReflect

protected

int DtStopFreezeInteraction::myRequestId

protected

bool DtStopFreezeInteraction::myRunClock

protected

bool DtStopFreezeInteraction::myUpdate

protected

---

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

• stopFreezeInteractionHLA.h