DtPointObjectTransaction Class Reference

Instances of DtPointObjectTransaction are used to represent Point Object Transactions in the RPR FOM. More...

Inheritance diagram for DtPointObjectTransaction:

Collaboration diagram for DtPointObjectTransaction:

Public Member Functions
	DtPointObjectTransaction ()
	Default CTOR. More...
	DtPointObjectTransaction (const DtPointObjectTransaction &orig)
	Copy CTOR. More...
virtual	~DtPointObjectTransaction ()
	Virtual DTOR. More...
DtPointObjectTransaction &	operator= (const DtPointObjectTransaction &orig)
	Assignment Operator. More...
virtual void	setLocation (const DtVector &value)
	Set/Get Location. More...
virtual const DtVector &	location () const
virtual void	setOrientation (const DtTaitBryan &value)
	Set/Get Orientation. More...
virtual const DtTaitBryan &	orientation () const
virtual void	setPercentComplete (DtU32 value)
	Set/Get Percent Complete. More...
virtual DtU32	percentComplete () const
virtual void	setDamagedAppearance (DtDamageState value)
	Set/Get Damaged Appearance. More...
virtual DtDamageState	damagedAppearance () const
virtual void	setObjectPreDistributed (bool onOff)
	Set/Get Object PreDistributed. More...
virtual bool	objectPreDistributed () const
virtual void	setDeactivated (bool onOff)
	Set/Get Deactivated. More...
virtual bool	deactivated () const
virtual void	setSmoking (bool onOff)
	Set/Get Smoking. More...
virtual bool	smoking () const
virtual void	setFlaming (bool onOff)
	Set/Get Flaming. More...
virtual bool	flaming () const
virtual void	setBreachedStatus (DtBreachStatus status)
	Set/Get Breached Status. More...
virtual DtBreachStatus	breachedStatus () const
virtual void	setPercentOpacity (DtU32 value)
	Set/Get Percent Opacity. More...
virtual DtU32	percentOpacity () const
virtual void	setCylinderSize (DtU32 value)
	Set/Get Cylinder Size. More...
virtual DtU32	cylinderSize () const
virtual void	setCylinderHeight (DtU32 value)
	Set/Get Cylinder Height. More...
virtual DtU32	cylinderHeight () const
virtual void	setNumberOfBursts (DtU32 value)
	Set/Get Number Of Bursts. More...
virtual DtU32	numberOfBursts () const
virtual void	setChemicalContent (DtChemicalContent value)
	Set/Get Chemical Content. More...
virtual DtChemicalContent	chemicalContent () const
virtual void	setCraterSize (DtU32 size)
	Set/Get Crater Size. More...
virtual DtU32	craterSize () const
virtual void	setNumberOfSegments (DtU32 num)
	Set/Get Number of Segments. More...
virtual DtU32	numberOfSegments () const
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.) 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...
Public Member Functions inherited from DtEnvironmentObjectTransaction
	DtEnvironmentObjectTransaction ()
	default constructor More...
virtual	~DtEnvironmentObjectTransaction ()
	destructor More...
	DtEnvironmentObjectTransaction (const DtEnvironmentObjectTransaction &orig)
	copy constructor More...
DtEnvironmentObjectTransaction &	operator= (const DtEnvironmentObjectTransaction &orig)
	assignment operator More...
virtual void	setObjectId (const DtEntityIdentifier &identifier)
	Set/Get Environment Object ID. More...
virtual const DtEntityIdentifier &	objectId () const
virtual void	setReferencedObjectId (const DtGlobalObjectDesignator &rtiObject)
	Set/Get Referenced Object ID. More...
virtual const DtGlobalObjectDesignator &	referencedObjectId () const
virtual void	setForceId (const DtForceType value)
	Set/Get Force ID. More...
virtual DtForceType	forceId () const
virtual void	setObjectType (const DtSyntheticEnvironmentObjectType &type)
	Set/Get Object Type. More...
virtual const DtSyntheticEnvironmentObjectType &	objectType () const
virtual void	setRequestingId (const DtSimulationAddress &id)
	Set/Get Requesting ID. More...
virtual const DtSimulationAddress &	requestingId () const
virtual void	setReceivingId (const DtSimulationAddress &id)
	Set/Get Receiving ID. More...
virtual const DtSimulationAddress &	receivingId () const
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 DtEnvironmentObjectTransaction. More...
static void	addCallback (DtExerciseConn *conn, DtPointObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs. More...
static void	removeCallback (DtExerciseConn *conn, DtPointObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Static Public Member Functions inherited from DtEnvironmentObjectTransaction
static DtInteraction *	create ()
	Create a DtEnvironmentObjectTransaction. More...
static void	addCallback (DtExerciseConn *conn, DtEnvironmentObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs. More...
static void	removeCallback (DtExerciseConn *conn, DtEnvironmentObjectTransactionCb 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	myLocation
	For All Point Object Transactions. More...
DtTaitBryan	myOrientation
DtU32	myPercentComplete
DtDamageState	myDamagedAppearance
bool	myObjectPreDistributed
bool	myDeactivated
bool	mySmoking
bool	myFlaming
DtBreachStatus	myBreachedStatus
	For BreachablePointObjectTransactions. More...
DtU32	myPercentOpacity
	For BurstPointObjectTransactions. More...
DtU32	myCylinderSize
DtU32	myCylinderHeight
DtU32	myNumberOfBursts
DtChemicalContent	myChemicalContent
DtU32	myCraterSize
	For CraterObjectTransactions. More...
DtU32	myNumberOfSegments
	For RibbonBridgeObjectTransactions. More...
Protected Attributes inherited from DtEnvironmentObjectTransaction
DtEntityIdentifier	myObjectId
DtGlobalObjectDesignator	myReferencedObjectId
DtForceType	myForceId
DtSyntheticEnvironmentObjectType	myObjectType
DtSimulationAddress	myRequestingId
DtSimulationAddress	myReceivingId
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 DtPointObjectTransaction are used to represent Point Object Transactions in the RPR FOM.

Constructor & Destructor Documentation

DtPointObjectTransaction::DtPointObjectTransaction

(

)

Default CTOR.

DtPointObjectTransaction::DtPointObjectTransaction

(

const DtPointObjectTransaction &

orig

)

Copy CTOR.

virtual DtPointObjectTransaction::~DtPointObjectTransaction ( )

virtual

Virtual DTOR.

Member Function Documentation

static void DtPointObjectTransaction::addCallback ( DtExerciseConn *  conn, DtPointObjectTransactionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

virtual DtBreachStatus DtPointObjectTransaction::breachedStatus ( ) const

virtual

virtual DtChemicalContent DtPointObjectTransaction::chemicalContent ( ) const

virtual

virtual DtU32 DtPointObjectTransaction::craterSize ( ) const

virtual

static DtInteraction* DtPointObjectTransaction::create ( )

static

Create a DtEnvironmentObjectTransaction.

Caller is responsible for deletion.

virtual DtU32 DtPointObjectTransaction::cylinderHeight ( ) const

virtual

virtual DtU32 DtPointObjectTransaction::cylinderSize ( ) const

virtual

virtual DtDamageState DtPointObjectTransaction::damagedAppearance ( ) const

virtual

virtual bool DtPointObjectTransaction::deactivated ( ) const

virtual

virtual bool DtPointObjectTransaction::flaming ( ) const

virtual

virtual const DtVector& DtPointObjectTransaction::location ( ) const

virtual

virtual const char* DtPointObjectTransaction::name ( ) const

virtual

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

Reimplemented from DtEnvironmentObjectTransaction.

virtual DtU32 DtPointObjectTransaction::numberOfBursts ( ) const

virtual

virtual DtU32 DtPointObjectTransaction::numberOfSegments ( ) const

virtual

virtual bool DtPointObjectTransaction::objectPreDistributed ( ) const

virtual

DtPointObjectTransaction& DtPointObjectTransaction::operator=

(

const DtPointObjectTransaction &

orig

)

Assignment Operator.

virtual const DtTaitBryan& DtPointObjectTransaction::orientation ( ) const

virtual

virtual DtU32 DtPointObjectTransaction::percentComplete ( ) const

virtual

virtual DtU32 DtPointObjectTransaction::percentOpacity ( ) const

virtual

virtual void DtPointObjectTransaction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtEnvironmentObjectTransaction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtEnvironmentObjectTransaction.

static void DtPointObjectTransaction::removeCallback ( DtExerciseConn *  conn, DtPointObjectTransactionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual void DtPointObjectTransaction::setBreachedStatus ( DtBreachStatus  status )

virtual

Set/Get Breached Status.

virtual void DtPointObjectTransaction::setChemicalContent ( DtChemicalContent  value )

virtual

Set/Get Chemical Content.

virtual void DtPointObjectTransaction::setCraterSize ( DtU32  size )

virtual

Set/Get Crater Size.

virtual void DtPointObjectTransaction::setCylinderHeight ( DtU32  value )

virtual

Set/Get Cylinder Height.

virtual void DtPointObjectTransaction::setCylinderSize ( DtU32  value )

virtual

Set/Get Cylinder Size.

virtual void DtPointObjectTransaction::setDamagedAppearance ( DtDamageState  value )

virtual

Set/Get Damaged Appearance.

virtual void DtPointObjectTransaction::setDeactivated ( bool  onOff )

virtual

Set/Get Deactivated.

virtual void DtPointObjectTransaction::setFlaming ( bool  onOff )

virtual

Set/Get Flaming.

virtual void DtPointObjectTransaction::setLocation ( const DtVector &  value )

virtual

Set/Get Location.

virtual void DtPointObjectTransaction::setNumberOfBursts ( DtU32  value )

virtual

Set/Get Number Of Bursts.

virtual void DtPointObjectTransaction::setNumberOfSegments ( DtU32  num )

virtual

Set/Get Number of Segments.

virtual void DtPointObjectTransaction::setObjectPreDistributed ( bool  onOff )

virtual

Set/Get Object PreDistributed.

virtual void DtPointObjectTransaction::setOrientation ( const DtTaitBryan &  value )

virtual

Set/Get Orientation.

virtual void DtPointObjectTransaction::setPercentComplete ( DtU32  value )

virtual

Set/Get Percent Complete.

virtual void DtPointObjectTransaction::setPercentOpacity ( DtU32  value )

virtual

Set/Get Percent Opacity.

virtual void DtPointObjectTransaction::setSmoking ( bool  onOff )

virtual

Set/Get Smoking.

virtual bool DtPointObjectTransaction::smoking ( ) const

virtual

Member Data Documentation

DtBreachStatus DtPointObjectTransaction::myBreachedStatus

protected

For BreachablePointObjectTransactions.

DtChemicalContent DtPointObjectTransaction::myChemicalContent

protected

DtU32 DtPointObjectTransaction::myCraterSize

protected

For CraterObjectTransactions.

DtU32 DtPointObjectTransaction::myCylinderHeight

protected

DtU32 DtPointObjectTransaction::myCylinderSize

protected

DtDamageState DtPointObjectTransaction::myDamagedAppearance

protected

bool DtPointObjectTransaction::myDeactivated

protected

bool DtPointObjectTransaction::myFlaming

protected

DtVector DtPointObjectTransaction::myLocation

protected

For All Point Object Transactions.

DtU32 DtPointObjectTransaction::myNumberOfBursts

protected

DtU32 DtPointObjectTransaction::myNumberOfSegments

protected

For RibbonBridgeObjectTransactions.

bool DtPointObjectTransaction::myObjectPreDistributed

protected

DtTaitBryan DtPointObjectTransaction::myOrientation

protected

DtU32 DtPointObjectTransaction::myPercentComplete

protected

DtU32 DtPointObjectTransaction::myPercentOpacity

protected

For BurstPointObjectTransactions.

bool DtPointObjectTransaction::mySmoking

protected

---

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

• pointObjectTransaction.h