DtLinearObjectTransaction Class Reference

class DtLinearObjectTransaction More...

Inheritance diagram for DtLinearObjectTransaction:

Collaboration diagram for DtLinearObjectTransaction:

List of all members.

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

---

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:

• hLinObjTrans.h