DtLinearObjectTransaction Class Reference

class DtLinearObjectTransaction More...

Inheritance diagram for DtLinearObjectTransaction:

Collaboration diagram for DtLinearObjectTransaction:

Public Member Functions
	DtLinearObjectTransaction ()
virtual	~DtLinearObjectTransaction ()
	DtLinearObjectTransaction (const DtLinearObjectTransaction &orig)
DtLinearObjectTransaction &	operator= (const DtLinearObjectTransaction &orig)
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 bool	setNumOfBreachLinearSegments (int newNumber)
	Set/Get the number of BreachableLinearObject Segment Records.
virtual int	numOfBreachLinearSegments () const
virtual bool	setBreachLinearSegment (int index, const DtBreachableSegmentRecord &record)
virtual bool	breachLinearSegment (int index, DtBreachableSegmentRecord &record) const
virtual bool	setNumOfBreachObjectSegments (int newNumber)
	Set/Get the number of BreachObject Segment Records.
virtual int	numOfBreachObjectSegments () const
virtual bool	setBreachObjectSegment (int index, const DtLinearSegmentRecord &record)
virtual bool	breachObjectSegment (int index, DtLinearSegmentRecord &record) const
virtual bool	setNumOfExhaustSmokeSegments (int newNumber)
	Set/Get the number of ExhaustSmokeObject Segment Records.
virtual int	numOfExhaustSmokeSegments () const
virtual bool	setExhaustSmokeSegment (int index, const DtExhaustSmokeRecord &record)
virtual bool	exhaustSmokeSegment (int index, DtExhaustSmokeRecord &record) const
virtual bool	setNumOfMinefldLaneMarkSegments (int newNumber)
	Set/Get the number of MinefieldLaneMarker Segment Records.
virtual int	numOfMinefldLaneMarkSegments () const
virtual bool	setMinefldLaneMarkSegment (int index, const DtMinefieldLaneMarkerRecord &record)
virtual bool	minefldLaneMarkSegment (int index, DtMinefieldLaneMarkerRecord &record) const
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)
Public Member Functions inherited from DtEnvironmentObjectTransaction
	DtEnvironmentObjectTransaction ()
	default constructor
virtual	~DtEnvironmentObjectTransaction ()
	destructor
	DtEnvironmentObjectTransaction (const DtEnvironmentObjectTransaction &orig)
	copy constructor
DtEnvironmentObjectTransaction &	operator= (const DtEnvironmentObjectTransaction &orig)
	assignment operator
virtual void	setObjectId (const DtEntityIdentifier &identifier)
	Set/Get Environment Object ID.
virtual const DtEntityIdentifier &	objectId () const
virtual void	setReferencedObjectId (const DtGlobalObjectDesignator &rtiObject)
	Set/Get Referenced Object ID.
virtual const DtGlobalObjectDesignator &	referencedObjectId () const
virtual void	setForceId (const DtForceType value)
	Set/Get Force ID.
virtual DtForceType	forceId () const
virtual void	setObjectType (const DtSyntheticEnvironmentObjectType &type)
	Set/Get Object Type.
virtual const DtSyntheticEnvironmentObjectType &	objectType () const
virtual void	setRequestingId (const DtSimulationAddress &id)
	Set/Get Requesting ID.
virtual const DtSimulationAddress &	requestingId () const
virtual void	setReceivingId (const DtSimulationAddress &id)
	Set/Get Receiving ID.
virtual const DtSimulationAddress &	receivingId () const
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.
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	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 DtLinearObjectTransaction.
static void	addCallback (DtExerciseConn *conn, DtLinearObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtLinearObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Static Public Member Functions inherited from DtEnvironmentObjectTransaction
static void	addCallback (DtExerciseConn *conn, DtEnvironmentObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtEnvironmentObjectTransactionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
int	myNumOfBreachLinearSegments
DtBreachableSegmentRecord *	myBreachLinearSegments
int	myNumOfBreachObjectSegments
DtLinearSegmentRecord *	myBreachObjectSegments
int	myNumOfExhaustSmokeSegments
DtExhaustSmokeRecord *	myExhaustSmokeSegments
int	myNumOfMinefldLaneMarkSegments
DtMinefieldLaneMarkerRecord *	myMinefldLaneMarkSegments
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.
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 DtLinearObjectTransaction

Instances of DtLinearObjectTransaction are used to implement Linear Object Transaction interactions in the RPR FOM

The type of Linear Object Transaction sent depends on the object type Object type: Exhaust Smoke – Domain = 0 (other), Kind = 5 (tactical smoke) Category = 1 Minefield Lane Marker – Domain = 1 (land), Kind = 6 (obstacle), Category = 1 Breach Object – Domain = 1 (land), Kind = 7 (obstacle breach), Category = 1 Breachable Linear Object – Couldn't figure out Object type... currently not implemented in the mapper Any object types not specified will be sent as OtherLinearObjectTransacitons

Constructor & Destructor Documentation

DtLinearObjectTransaction::DtLinearObjectTransaction

(

)

virtual DtLinearObjectTransaction::~DtLinearObjectTransaction ( )

virtual

DtLinearObjectTransaction::DtLinearObjectTransaction

(

const DtLinearObjectTransaction &

orig

)

Member Function Documentation

static void DtLinearObjectTransaction::addCallback ( DtExerciseConn *  conn, DtLinearObjectTransactionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

virtual bool DtLinearObjectTransaction::breachLinearSegment ( int  index, DtBreachableSegmentRecord &  record  ) const

virtual

virtual bool DtLinearObjectTransaction::breachObjectSegment ( int  index, DtLinearSegmentRecord &  record  ) const

virtual

static DtInteraction* DtLinearObjectTransaction::create ( )

static

Create a DtLinearObjectTransaction.

Caller is responsible for deletion.

Reimplemented from DtEnvironmentObjectTransaction.

virtual bool DtLinearObjectTransaction::exhaustSmokeSegment ( int  index, DtExhaustSmokeRecord &  record  ) const

virtual

virtual bool DtLinearObjectTransaction::minefldLaneMarkSegment ( int  index, DtMinefieldLaneMarkerRecord &  record  ) const

virtual

virtual const char* DtLinearObjectTransaction::name ( ) const

virtual

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

Reimplemented from DtEnvironmentObjectTransaction.

virtual int DtLinearObjectTransaction::numOfBreachLinearSegments ( ) const

virtual

virtual int DtLinearObjectTransaction::numOfBreachObjectSegments ( ) const

virtual

virtual int DtLinearObjectTransaction::numOfExhaustSmokeSegments ( ) const

virtual

virtual int DtLinearObjectTransaction::numOfMinefldLaneMarkSegments ( ) const

virtual

DtLinearObjectTransaction& DtLinearObjectTransaction::operator=

(

const DtLinearObjectTransaction &

orig

)

virtual void DtLinearObjectTransaction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtEnvironmentObjectTransaction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtEnvironmentObjectTransaction.

static void DtLinearObjectTransaction::removeCallback ( DtExerciseConn *  conn, DtLinearObjectTransactionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual bool DtLinearObjectTransaction::setBreachLinearSegment ( int  index, const DtBreachableSegmentRecord &  record  )

virtual

virtual bool DtLinearObjectTransaction::setBreachObjectSegment ( int  index, const DtLinearSegmentRecord &  record  )

virtual

virtual bool DtLinearObjectTransaction::setExhaustSmokeSegment ( int  index, const DtExhaustSmokeRecord &  record  )

virtual

virtual bool DtLinearObjectTransaction::setMinefldLaneMarkSegment ( int  index, const DtMinefieldLaneMarkerRecord &  record  )

virtual

virtual bool DtLinearObjectTransaction::setNumOfBreachLinearSegments ( int  newNumber )

virtual

Set/Get the number of BreachableLinearObject Segment Records.

Set returns false if the requested number is too large. Changing this number will erase all previous data.

virtual bool DtLinearObjectTransaction::setNumOfBreachObjectSegments ( int  newNumber )

virtual

Set/Get the number of BreachObject Segment Records.

Set returns false if the request number is too large. Changing this number will erase all previous data.

virtual bool DtLinearObjectTransaction::setNumOfExhaustSmokeSegments ( int  newNumber )

virtual

Set/Get the number of ExhaustSmokeObject Segment Records.

Set returns false if the requested number is too large. Changing this number will erase all previous data.

virtual bool DtLinearObjectTransaction::setNumOfMinefldLaneMarkSegments ( int  newNumber )

virtual

Set/Get the number of MinefieldLaneMarker Segment Records.

Set returns false if the request number is too large. Changing this number will erase all previous data.

Member Data Documentation

DtBreachableSegmentRecord* DtLinearObjectTransaction::myBreachLinearSegments

protected

DtLinearSegmentRecord* DtLinearObjectTransaction::myBreachObjectSegments

protected

DtExhaustSmokeRecord* DtLinearObjectTransaction::myExhaustSmokeSegments

protected

DtMinefieldLaneMarkerRecord* DtLinearObjectTransaction::myMinefldLaneMarkSegments

protected

int DtLinearObjectTransaction::myNumOfBreachLinearSegments

protected

int DtLinearObjectTransaction::myNumOfBreachObjectSegments

protected

int DtLinearObjectTransaction::myNumOfExhaustSmokeSegments

protected

int DtLinearObjectTransaction::myNumOfMinefldLaneMarkSegments

protected

---

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

• linearObjectTransaction.h