DtPortalBoomInteraction Class Reference

Represents a weapon fire event. More...

Inheritance diagram for DtPortalBoomInteraction:

Public Types
typedef void(*	DtPortalBoomInteractionCb )(const DtPortalBoomInteraction &inter, void *usr)

Public Member Functions
	DtPortalBoomInteraction ()
	CTOR.
virtual	~DtPortalBoomInteraction ()
	Virtual DTOR.
virtual unsigned int	netSize () const
	NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
virtual void	writeSelfToBuffer (void *buffer) const
	Writes this message into the memory buffer provided by buffer.
virtual void	readSelfFromBuffer (const void *buffer)
	Reads this message from the memory buffer into this object.
virtual std::ostream &	printDataToStream (std::ostream &str) const
	Prints the current state of this message to the stream specified by str.
Data Exchange Attributes
	DtDEC_ATTRIBUTE (DtU32, Volume, volume)
	DtDEC_ATTRIBUTE (bool, GroundMovement, groundMovement)
Public Member Functions inherited from MAKVrExchange::DtPortalInteraction
	DtPortalInteraction (DtPortalMessageKind kind, const DtString &name)
	CTOR.
	DtPortalInteraction (const DtPortalInteraction &other)
	Copy CTOR.
virtual	~DtPortalInteraction ()
	Virtual DTOR.
virtual DtPortalInteraction &	operator= (const DtPortalInteraction &other)
	Assignment operator.
	DtDEC_ATTRIBUTE (DtString, Name, name)
	Message Name attribute.
	DtDEC_ATTRIBUTE (DtAttributeValuePairList, AttributeValuePairList, attributeValuePairList)
	The Attribute Value Pair List for the class.
Public Member Functions inherited from MAKVrExchange::DtPortalMessage
	DtPortalMessage (DtPortalMessageKind kind)
	CTOR.
	DtPortalMessage (const DtPortalMessage &other)
	Copy CTOR.
virtual	~DtPortalMessage ()
	Virtual DTOR.
virtual DtPortalMessage &	operator= (const DtPortalMessage &other)
	Assignment operator.
virtual bool	operator== (const DtPortalMessage &other) const
virtual bool	operator!= (const DtPortalMessage &other) const
	DtDEC_ATTRIBUTE (DtPortalMessageKind, Kind, kind)
	Message Kind attribute.
virtual void	setSerialNumber (unsigned int i) const
	This method should be considered private and not be used.
virtual unsigned int	serialNumber () const
	Returns a unique identifier for this message.
virtual void	setSendingBrokerId (const DtU32 &id) const
	This method should be considered private and not be used.
virtual DtU32	sendingBrokerId () const
	Returns the ID of the sending broker.
virtual void	setTimeSent (const DtTime &tm) const
	This method should be considered private and not be used.
virtual DtTime	timeSent () const
	The Time that the message was sent.
virtual void	setTimeReceived (const DtTime &tm) const
	This method should be considered private and not be used.
virtual DtTime	timeReceived () const
	The time that this message was received.

Static Public Member Functions
static void	addCallback (MAKVrExchange::DtPortalConnection *conn, DtPortalBoomInteractionCb cb, void *usr)
	Adds a callback to be called when interactions are received.
static void	removeCallback (MAKVrExchange::DtPortalConnection *conn, DtPortalBoomInteractionCb cb, void *usr)
	Removes the callback for when interactions are received.
static DtPortalMessage *	create ()

Static Public Attributes
static const MAKVrExchange::DtPortalMessageKind	theKind
	NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

Additional Inherited Members
Protected Member Functions inherited from MAKVrExchange::DtPortalMessage
virtual char *	encode (const DtString &val, char *buffer) const
virtual char *	encode (const DtU8 &val, char *buffer) const
virtual char *	encode (const DtU16 &val, char *buffer) const
virtual char *	encode (const DtU32 &val, char *buffer) const
virtual char *	encode (const DtU64 &val, char *buffer) const
virtual char *	encode (const DtInt8 &val, char *buffer) const
virtual char *	encode (const DtInt16 &val, char *buffer) const
virtual char *	encode (const DtInt32 &val, char *buffer) const
virtual char *	encode (const DtInt64 &val, char *buffer) const
virtual char *	encode (const DtFloat32 &val, char *buffer) const
virtual char *	encode (const DtFloat64 &val, char *buffer) const
virtual char *	encode (const DtVector &val, char *buffer) const
virtual char *	encode (const DtTaitBryan &val, char *buffer) const
virtual char *	encode (const bool &val, char *buffer) const
virtual char *	encode (const std::vector< char > &val, char *buffer) const
virtual char *	encode (const std::vector< DtU16 > &val, char *buffer) const
virtual char *	encode (const std::vector< DtU32 > &val, char *buffer) const
virtual char *	encode (const DtAttributeValuePairList &val, char *buffer) const
virtual char *	encode (const std::vector< DtString > &val, char *buffer) const
virtual char *	encode (const std::vector< DtVector > &val, char *buffer) const
virtual char *	encode (const DtSilentAggregateArray &val, char *buffer) const
virtual char *	encode (const DtSilentEntityArray &val, char *buffer) const
virtual char *	encode (const DtVariableLengthData &val, char *buffer) const
virtual char *	encode (const DtAttributeValuePair &val, char *buffer) const
virtual char *	encode (const DtFixedLengthData &value, char *buffer) const
virtual char *	encode (const DtFixedLengthDataArray &value, char *buffer) const
virtual char *	encode (const DtAggregateVariableDatum &val, char *buffer) const
virtual char *	encode (const DtAggregateVariableDatumArray &val, char *buffer) const
virtual char *	encode (const DtEmitterBeamData &data, char *buffer) const
virtual char *	encode (const DtEmitterBeamList &container, char *buffer) const
virtual char *	encode (const DtLinearSegmentData &data, char *buffer) const
virtual char *	encode (const DtLinearSegmentParameterList &container, char *buffer) const
virtual char *	encode (const DtActiveSonarBeamData &data, char *buffer) const
virtual char *	encode (const DtActiveSonarBeamList &container, char *buffer) const
virtual char *	encode (const DtEntityIdentifier &value, char *buffer) const
virtual char *	encode (const DtEntityType &value, char *buffer) const
virtual char *	encode (const DtArticulatedPartCollection &value, char *buffer) const
virtual char *	encode (const DtAttachedPartCollection &value, char *buffer) const
virtual char *	encode (const DtIffAtcNavaidsAltParm4 &value, char *buffer) const
virtual char *	encode (const DtSimulationAddress &value, char *buffer) const
virtual char *	encode (const DtShaftRateData &value, char *buffer) const
virtual char *	encode (const DtShaftRateDataList &value, char *buffer) const
virtual const char *	decode (DtString &val, const char *buffer) const
virtual const char *	decode (DtU8 &val, const char *buffer) const
virtual const char *	decode (DtU16 &val, const char *buffer) const
virtual const char *	decode (DtU32 &val, const char *buffer) const
virtual const char *	decode (DtU64 &val, const char *buffer) const
virtual const char *	decode (DtInt8 &val, const char *buffer) const
virtual const char *	decode (DtInt16 &val, const char *buffer) const
virtual const char *	decode (DtInt32 &val, const char *buffer) const
virtual const char *	decode (DtInt64 &val, const char *buffer) const
virtual const char *	decode (DtFloat32 &val, const char *buffer) const
virtual const char *	decode (DtFloat64 &val, const char *buffer) const
virtual const char *	decode (DtVector &val, const char *buffer) const
virtual const char *	decode (DtTaitBryan &val, const char *buffer) const
virtual const char *	decode (bool &val, const char *buffer) const
virtual const char *	decode (std::vector< char > &val, const char *buffer) const
virtual const char *	decode (std::vector< DtU16 > &val, const char *buffer) const
virtual const char *	decode (std::vector< DtU32 > &val, const char *buffer) const
virtual const char *	decode (DtAttributeValuePairList &val, const char *buffer) const
virtual const char *	decode (std::vector< DtString > &val, const char *buffer) const
virtual const char *	decode (std::vector< DtVector > &val, const char *buffer) const
virtual const char *	decode (DtSilentAggregateArray &val, const char *buffer) const
virtual const char *	decode (DtSilentEntityArray &val, const char *buffer) const
virtual const char *	decode (DtVariableLengthData &val, const char *buffer) const
virtual const char *	decode (DtAttributeValuePair &val, const char *buffer) const
virtual const char *	decode (DtFixedLengthData &value, const char *buffer) const
virtual const char *	decode (DtFixedLengthDataArray &value, const char *buffer) const
virtual const char *	decode (DtAggregateVariableDatum &val, const char *buffer) const
virtual const char *	decode (DtAggregateVariableDatumArray &val, const char *buffer) const
virtual const char *	decode (DtEmitterBeamData &data, const char *buffer) const
virtual const char *	decode (DtEmitterBeamList &container, const char *buffer) const
virtual const char *	decode (DtLinearSegmentData &data, const char *buffer) const
virtual const char *	decode (DtLinearSegmentParameterList &container, const char *buffer) const
virtual const char *	decode (DtActiveSonarBeamData &data, const char *buffer) const
virtual const char *	decode (DtActiveSonarBeamList &container, const char *buffer) const
virtual const char *	decode (DtEntityIdentifier &value, const char *buffer) const
virtual const char *	decode (DtEntityType &value, const char *buffer) const
virtual const char *	decode (DtArticulatedPartCollection &value, const char *buffer) const
virtual const char *	decode (DtAttachedPartCollection &value, const char *buffer) const
virtual const char *	decode (DtIffAtcNavaidsAltParm4 &value, const char *buffer) const
virtual const char *	decode (DtSimulationAddress &value, const char *buffer) const
virtual const char *	decode (DtShaftRateData &value, const char *buffer) const
virtual const char *	decode (DtShaftRateDataList &value, const char *buffer) const
virtual int	getSize (const DtString &val) const
virtual int	getSize (const DtVector &v) const
virtual int	getSize (const DtU8 &v) const
virtual int	getSize (const DtU16 &v) const
virtual int	getSize (const DtU32 &v) const
virtual int	getSize (const DtU64 &v) const
virtual int	getSize (const DtInt8 &v) const
virtual int	getSize (const DtInt16 &v) const
virtual int	getSize (const DtInt32 &v) const
virtual int	getSize (const DtInt64 &v) const
virtual int	getSize (const DtFloat32 &v) const
virtual int	getSize (const DtFloat64 &v) const
virtual int	getSize (const bool &v) const
virtual int	getSize (const DtTaitBryan &v) const
virtual int	getSize (const std::vector< char > &v) const
virtual int	getSize (const std::vector< DtU16 > &v) const
virtual int	getSize (const std::vector< DtU32 > &v) const
virtual int	getSize (const DtAttributeValuePairList &v) const
virtual int	getSize (const std::vector< DtString > &v) const
virtual int	getSize (const std::vector< DtVector > &v) const
virtual int	getSize (const DtSilentAggregateArray &v) const
virtual int	getSize (const DtSilentEntityArray &v) const
virtual int	getSize (const DtVariableLengthData &v) const
virtual int	getSize (const DtAttributeValuePair &v) const
virtual int	getSize (const DtFixedLengthData &value) const
virtual int	getSize (const DtFixedLengthDataArray &value) const
virtual int	getSize (const DtAggregateVariableDatum &v) const
virtual int	getSize (const DtAggregateVariableDatumArray &v) const
virtual int	getSize (const DtEmitterBeamData &data) const
virtual int	getSize (const DtEmitterBeamList &container) const
virtual int	getSize (const DtLinearSegmentData &data) const
virtual int	getSize (const DtLinearSegmentParameterList &container) const
virtual int	getSize (const DtActiveSonarBeamData &data) const
virtual int	getSize (const DtActiveSonarBeamList &container) const
virtual int	getSize (const DtEntityIdentifier &value) const
virtual int	getSize (const DtEntityType &value) const
virtual int	getSize (const DtArticulatedPartCollection &value) const
virtual int	getSize (const DtAttachedPartCollection &value) const
virtual int	getSize (const DtIffAtcNavaidsAltParm4 &value) const
virtual int	getSize (const DtSimulationAddress &value) const
virtual int	getSize (const DtShaftRateData &value) const
virtual int	getSize (const DtShaftRateDataList &value) const
Protected Attributes inherited from MAKVrExchange::DtPortalMessage
DtU32	myMutableSerialNumber
	mutable because it can be set by the PConnection.
DtU32	myMutableSendingBrokerId
	mutable because it can be set by the PConnection.
DtTime	myMutableSentTimeStamp
	mutable because it can be set by the PConnection.
DtTime	myMutableReceivedTimeStamp
	mutable because it can be set by the PConnection.

Detailed Description

Represents a weapon fire event.

DtPortalBoomInteraction represents a noise that sounds like "Boom". This example is very simple and silly, but is intended to show users to how to create portal Interaction messages.

Member Typedef Documentation

typedef void(* DtPortalBoomInteraction::DtPortalBoomInteractionCb)(const DtPortalBoomInteraction &inter, void *usr)

Constructor & Destructor Documentation

DtPortalBoomInteraction::DtPortalBoomInteraction

(

)

CTOR.

Referenced by create().

virtual DtPortalBoomInteraction::~DtPortalBoomInteraction ( )

virtual

Virtual DTOR.

Member Function Documentation

static void DtPortalBoomInteraction::addCallback ( MAKVrExchange::DtPortalConnection *  conn, DtPortalBoomInteractionCb  cb, void *  usr  )

static

Adds a callback to be called when interactions are received.

MAKVrExchange::DtPortalMessage * DtPortalBoomInteraction::create ( )

inlinestatic

References DtPortalBoomInteraction().

DtPortalBoomInteraction::DtDEC_ATTRIBUTE	(	DtU32	,
		Volume	,
		volume
	)

DtPortalBoomInteraction::DtDEC_ATTRIBUTE	(	bool	,
		GroundMovement	,
		groundMovement
	)

virtual unsigned int DtPortalBoomInteraction::netSize ( ) const

virtual

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

Reimplemented from MAKVrExchange::DtPortalInteraction.

virtual std::ostream& DtPortalBoomInteraction::printDataToStream ( std::ostream &  str ) const

virtual

Prints the current state of this message to the stream specified by str.

Objects which add attributes must override this method to print them.

Reimplemented from MAKVrExchange::DtPortalInteraction.

virtual void DtPortalBoomInteraction::readSelfFromBuffer ( const void *  buffer )

virtual

Reads this message from the memory buffer into this object.

The buffer must be initialized and be at least netSize() bytes long. Objects which add attributes must override this method to read them.

Reimplemented from MAKVrExchange::DtPortalInteraction.

static void DtPortalBoomInteraction::removeCallback ( MAKVrExchange::DtPortalConnection *  conn, DtPortalBoomInteractionCb  cb, void *  usr  )

static

Removes the callback for when interactions are received.

virtual void DtPortalBoomInteraction::writeSelfToBuffer ( void *  buffer ) const

virtual

Writes this message into the memory buffer provided by buffer.

The buffer must already be allocated and be at least netSize() bytes long. Objects which add attributes must override this method to write them.

Reimplemented from MAKVrExchange::DtPortalInteraction.

Member Data Documentation

const MAKVrExchange::DtPortalMessageKind DtPortalBoomInteraction::theKind

static

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

---

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

• pBoomInter.h