DtCollisionElasticPdu Class Reference

Instances of DtCollisionElasticPdu are used to send simulated elastic collision information. More...

Inheritance diagram for DtCollisionElasticPdu:

Collaboration diagram for DtCollisionElasticPdu:

Public Member Functions
	DtCollisionElasticPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtCollisionElasticPdu (const DtNetCollisionElasticPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtCollisionElasticPdu (const DtCollisionElasticPdu &orig)
virtual	~DtCollisionElasticPdu ()
	destructor
DtCollisionElasticPdu &	operator= (const DtCollisionElasticPdu &orig)
	Assignment operator.
virtual void	setIssuingEntityID (const DtEntityIdentifier &entity)
	Set/Get issuing entity identifier.
virtual const DtEntityIdentifier &	issuingEntityID () const
virtual void	setCollidingEntityID (const DtEntityIdentifier &entity)
	Set/Get colliding entity identifier.
virtual const DtEntityIdentifier &	collidingEntityID () const
virtual void	setEventID (const DtEventID &event)
	Set/Get event ID.
virtual const DtEventID &	eventID () const
virtual void	setContactVelocity (const DtVector &velocity)
	Set/Get contact velocity.
virtual const DtVector &	contactVelocity () const
virtual void	setMass (DtFloat32 value)
	Set/Get mass.
virtual DtFloat32	mass () const
virtual void	setLocationOfImpact (const DtVector &coords)
	Set/Get location of impact.
virtual const DtVector &	locationOfImpact () const
virtual void	setCollisionInterResultXX (DtFloat32 result)
	Set/Get collision intermediate result XX.
virtual DtFloat32	collisionInterResultXX () const
virtual void	setCollisionInterResultXY (DtFloat32 result)
	Set/Get collision intermediate result XY.
virtual DtFloat32	collisionInterResultXY () const
virtual void	setCollisionInterResultXZ (DtFloat32 result)
	Set/Get collision intermediate result XZ.
virtual DtFloat32	collisionInterResultXZ () const
virtual void	setCollisionInterResultYY (DtFloat32 result)
	Set/Get collision intermediate result YY.
virtual DtFloat32	collisionInterResultYY () const
virtual void	setCollisionInterResultYZ (DtFloat32 result)
	Set/Get collision intermediate result YZ.
virtual DtFloat32	collisionInterResultYZ () const
virtual void	setCollisionInterResultZZ (DtFloat32 result)
	Set/Get collision intermediate result ZZ.
virtual DtFloat32	collisionInterResultZZ () const
virtual void	setUnitSurfaceNormal (const DtVector &coords)
	Set/Get unit surface normal.
virtual const DtVector &	unitSurfaceNormal () const
virtual void	setCoefficientOfRestitution (DtFloat32 coeff)
	Set/Get coefficient of restitution.
virtual DtFloat32	coefficientOfRestitution () const
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
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
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
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 DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Create a DtCollisionElasticPdu.
static void	addCallback (DtExerciseConn *conn, DtCollisionElasticPduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtCollisionElasticPduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetCollisionElasticPdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtCollisionElasticPdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.

Protected Attributes
DtEntityIdentifier	myEntityID
	Temporary objects for reference returns.
DtEventID	myEventID
DtVector	myVector

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero data bytes.

Detailed Description

Instances of DtCollisionElasticPdu are used to send simulated elastic collision information.

Constructor & Destructor Documentation

DtCollisionElasticPdu::DtCollisionElasticPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtCollisionElasticPdu::DtCollisionElasticPdu	(	const DtNetCollisionElasticPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtCollisionElasticPdu::DtCollisionElasticPdu

(

const DtCollisionElasticPdu &

orig

)

virtual DtCollisionElasticPdu::~DtCollisionElasticPdu ( )

virtual

destructor

Member Function Documentation

static void DtCollisionElasticPdu::addCallback ( DtExerciseConn *  conn, DtCollisionElasticPduCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual DtFloat32 DtCollisionElasticPdu::coefficientOfRestitution ( ) const

virtual

virtual const DtEntityIdentifier& DtCollisionElasticPdu::collidingEntityID ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::collisionInterResultXX ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::collisionInterResultXY ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::collisionInterResultXZ ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::collisionInterResultYY ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::collisionInterResultYZ ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::collisionInterResultZZ ( ) const

virtual

virtual const DtVector& DtCollisionElasticPdu::contactVelocity ( ) const

virtual

static DtPdu* DtCollisionElasticPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Create a DtCollisionElasticPdu.

Caller is responsible for deletion.

virtual const DtEventID& DtCollisionElasticPdu::eventID ( ) const

virtual

virtual DtPduKind DtCollisionElasticPdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual const DtEntityIdentifier& DtCollisionElasticPdu::issuingEntityID ( ) const

virtual

virtual const DtVector& DtCollisionElasticPdu::locationOfImpact ( ) const

virtual

virtual DtFloat32 DtCollisionElasticPdu::mass ( ) const

virtual

virtual DtNetCollisionElasticPdu* DtCollisionElasticPdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

Non-virtual since you can't override based on return type.

DtCollisionElasticPdu& DtCollisionElasticPdu::operator=

(

const DtCollisionElasticPdu &

orig

)

Assignment operator.

virtual void DtCollisionElasticPdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

static void DtCollisionElasticPdu::removeCallback ( DtExerciseConn *  conn, DtCollisionElasticPduCb  cb, void *  usr  )

static

DtCollisionElasticPdu* DtCollisionElasticPdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non virtual since you can't override based on return type.

virtual void DtCollisionElasticPdu::setCoefficientOfRestitution ( DtFloat32  coeff )

virtual

Set/Get coefficient of restitution.

virtual void DtCollisionElasticPdu::setCollidingEntityID ( const DtEntityIdentifier &  entity )

virtual

Set/Get colliding entity identifier.

virtual void DtCollisionElasticPdu::setCollisionInterResultXX ( DtFloat32  result )

virtual

Set/Get collision intermediate result XX.

virtual void DtCollisionElasticPdu::setCollisionInterResultXY ( DtFloat32  result )

virtual

Set/Get collision intermediate result XY.

virtual void DtCollisionElasticPdu::setCollisionInterResultXZ ( DtFloat32  result )

virtual

Set/Get collision intermediate result XZ.

virtual void DtCollisionElasticPdu::setCollisionInterResultYY ( DtFloat32  result )

virtual

Set/Get collision intermediate result YY.

virtual void DtCollisionElasticPdu::setCollisionInterResultYZ ( DtFloat32  result )

virtual

Set/Get collision intermediate result YZ.

virtual void DtCollisionElasticPdu::setCollisionInterResultZZ ( DtFloat32  result )

virtual

Set/Get collision intermediate result ZZ.

virtual void DtCollisionElasticPdu::setContactVelocity ( const DtVector &  velocity )

virtual

Set/Get contact velocity.

virtual void DtCollisionElasticPdu::setEventID ( const DtEventID &  event )

virtual

Set/Get event ID.

virtual void DtCollisionElasticPdu::setIssuingEntityID ( const DtEntityIdentifier &  entity )

virtual

Set/Get issuing entity identifier.

virtual void DtCollisionElasticPdu::setLocationOfImpact ( const DtVector &  coords )

virtual

Set/Get location of impact.

virtual void DtCollisionElasticPdu::setMass ( DtFloat32  value )

virtual

Set/Get mass.

virtual void DtCollisionElasticPdu::setUnitSurfaceNormal ( const DtVector &  coords )

virtual

Set/Get unit surface normal.

virtual const DtVector& DtCollisionElasticPdu::unitSurfaceNormal ( ) const

virtual

Member Data Documentation

DtEntityIdentifier DtCollisionElasticPdu::myEntityID

protected

Temporary objects for reference returns.

DtEventID DtCollisionElasticPdu::myEventID

protected

DtVector DtCollisionElasticPdu::myVector

protected

const int DtCollisionElasticPdu::theStaticSize

staticprotected

Size of PDU with zero data bytes.

---

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

• collisElasPdu.h