DtPortalBoomInteraction Class Reference

Inheritance diagram for DtPortalBoomInteraction:

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

Public Member Functions
	DtPortalBoomInteraction ()
virtual	~DtPortalBoomInteraction ()
	DtDEC_ATTRIBUTE (DtU32, Volume, volume)
	DtDEC_ATTRIBUTE (bool, GroundMovement, groundMovement)
virtual MAKVrExchange::DtPortalMessageKind	kind () const
	Returns the type of this message.
virtual const char *	interactionKindName () const
	returns a well formated string representation of this interactions type
virtual unsigned int	netSize () const
	Returns the network size of the message.
virtual void	writeSelfToBuffer (void *buffer) const
	Writes the message to a buffer.
virtual void	readSelfFromBuffer (const void *buffer)
	fills out this message instance from the buffer provided.
virtual std::ostream &	printDataToStream (std::ostream &str) const
	Prints the internal state of this message to the stream passed in.
Public Member Functions inherited from MAKVrExchange::DtPortalInteraction
	DtPortalInteraction ()
	The Default CTOR.
virtual	~DtPortalInteraction ()
	The Default DTOR.
	DtPortalInteraction (const DtPortalInteraction &other)
	Copy CTOR - this class is copyable.
DtPortalInteraction &	operator= (const DtPortalInteraction &other)
	Assignment Operator - this class is copyable.
Public Member Functions inherited from MAKVrExchange::DtPortalMessage
	DtPortalMessage ()
	The default CTOR.
virtual	~DtPortalMessage ()
	The default DTOR.
	DtPortalMessage (const DtPortalMessage &other)
	Copy CTOR, this class is copyable.
DtPortalMessage &	operator= (const DtPortalMessage &other)
	Assignment Operator, this class is copyable.
virtual unsigned int	serialNumber () const
	Returns a unique identifier for this message.
virtual DtU32	sendingBrokerId () const
	Returns the ID of the sending broker.
virtual DtTime	timeSent () const
	The Time that the message was sent.
virtual DtTime	timeReceived () const
	The time that this message was received.
virtual void	setTimeSent (const DtTime &tm) const
	This method should be considered private and not be used.
virtual void	setTimeReceived (const DtTime &tm) const
	This method should be considered private and not be used.
virtual void	setSendingBrokerId (const DtU32 &id) const
	This method should be considered private and not be used.
virtual void	setSerialNumber (unsigned int i) const
	This method should be considered private and not be used.

Static Public Member Functions
static DtPortalMessage *	create ()
static void	addCallback (MAKVrExchange::DtPortalConnection *conn, DtPortalBoomInteractionCb cb, void *usr)
static void	removeCallback (MAKVrExchange::DtPortalConnection *conn, DtPortalBoomInteractionCb cb, void *usr)

Static Public Attributes
static const MAKVrExchange::DtPortalMessageKind	theKind

Additional Inherited Members
Protected Member Functions inherited from MAKVrExchange::DtPortalMessage
char *	encode (const DtString &val, char *buffer) const
char *	encode (const DtU8 &val, char *buffer) const
char *	encode (const DtU16 &val, char *buffer) const
char *	encode (const DtU32 &val, char *buffer) const
char *	encode (const DtU64 &val, char *buffer) const
char *	encode (const DtFloat32 &val, char *buffer) const
char *	encode (const DtFloat64 &val, char *buffer) const
char *	encode (const DtVector &val, char *buffer) const
char *	encode (const DtTaitBryan &val, char *buffer) const
char *	encode (const bool &val, char *buffer) const
char *	encode (const std::vector< char > &val, char *buffer) const
char *	encode (const std::vector< DtU16 > &val, char *buffer) const
char *	encode (const std::vector< DtU32 > &val, char *buffer) const
char *	encode (const DtAttributeValuePairList &val, char *buffer) const
char *	encode (const std::vector< DtString > &val, char *buffer) const
char *	encode (const DtSilentAggregateArray &val, char *buffer) const
char *	encode (const DtSilentEntityArray &val, char *buffer) const
char *	encode (const DtVariableLengthData &val, char *buffer) const
char *	encode (const DtAttributeValuePair &val, char *buffer) const
char *	encode (const DtFixedLengthData &value, char *buffer) const
char *	encode (const DtFixedLengthDataArray &value, char *buffer) const
char *	encode (const DtAggregateVariableDatum &val, char *buffer) const
char *	encode (const DtAggregateVariableDatumArray &val, char *buffer) const
char *	encode (const DtEmitterBeamData &data, char *buffer) const
char *	encode (const DtEmitterBeamList &container, char *buffer) const
char *	encode (const DtEntityIdentifier &value, char *buffer) const
char *	encode (const DtEntityType &value, char *buffer) const
char *	encode (const DtArticulatedPartCollection &value, char *buffer) const
char *	encode (const DtAttachedPartCollection &value, char *buffer) const
char *	encode (const DtIffAtcNavaidsAltParm4 &value, char *buffer) const
const char *	decode (DtString &val, const char *buffer) const
const char *	decode (DtU8 &val, const char *buffer) const
const char *	decode (DtU16 &val, const char *buffer) const
const char *	decode (DtU32 &val, const char *buffer) const
const char *	decode (DtU64 &val, const char *buffer) const
const char *	decode (DtFloat32 &val, const char *buffer) const
const char *	decode (DtFloat64 &val, const char *buffer) const
const char *	decode (DtVector &val, const char *buffer) const
const char *	decode (DtTaitBryan &val, const char *buffer) const
const char *	decode (bool &val, const char *buffer) const
const char *	decode (std::vector< char > &val, const char *buffer) const
const char *	decode (std::vector< DtU16 > &val, const char *buffer) const
const char *	decode (std::vector< DtU32 > &val, const char *buffer) const
const char *	decode (DtAttributeValuePairList &val, const char *buffer) const
const char *	decode (std::vector< DtString > &val, const char *buffer) const
const char *	decode (DtSilentAggregateArray &val, const char *buffer) const
const char *	decode (DtSilentEntityArray &val, const char *buffer) const
const char *	decode (DtVariableLengthData &val, const char *buffer) const
const char *	decode (DtAttributeValuePair &val, const char *buffer) const
const char *	decode (DtFixedLengthData &value, const char *buffer) const
const char *	decode (DtFixedLengthDataArray &value, const char *buffer) const
const char *	decode (DtAggregateVariableDatum &val, const char *buffer) const
const char *	decode (DtAggregateVariableDatumArray &val, const char *buffer) const
const char *	decode (DtEmitterBeamData &data, const char *buffer) const
const char *	decode (DtEmitterBeamList &container, const char *buffer) const
const char *	decode (DtEntityIdentifier &value, const char *buffer) const
const char *	decode (DtEntityType &value, const char *buffer) const
const char *	decode (DtArticulatedPartCollection &value, const char *buffer) const
const char *	decode (DtAttachedPartCollection &value, const char *buffer) const
const char *	decode (DtIffAtcNavaidsAltParm4 &value, const char *buffer) const
int	getSize (const DtString &val) const
int	getSize (const DtVector &v) const
int	getSize (const DtU8 &v) const
int	getSize (const DtU16 &v) const
int	getSize (const DtU32 &v) const
int	getSize (const DtU64 &v) const
int	getSize (const DtFloat32 &v) const
int	getSize (const DtFloat64 &v) const
int	getSize (const bool &v) const
int	getSize (const DtTaitBryan &v) const
int	getSize (const std::vector< char > &v) const
int	getSize (const std::vector< DtU16 > &v) const
int	getSize (const std::vector< DtU32 > &v) const
int	getSize (const DtAttributeValuePairList &v) const
int	getSize (const std::vector< DtString > &v) const
int	getSize (const DtSilentAggregateArray &v) const
int	getSize (const DtSilentEntityArray &v) const
int	getSize (const DtVariableLengthData &v) const
int	getSize (const DtAttributeValuePair &v) const
int	getSize (const DtFixedLengthData &value) const
int	getSize (const DtFixedLengthDataArray &value) const
int	getSize (const DtAggregateVariableDatum &v) const
int	getSize (const DtAggregateVariableDatumArray &v) const
int	getSize (const DtEmitterBeamData &data) const
int	getSize (const DtEmitterBeamList &container) const
int	getSize (const DtEntityIdentifier &value) const
int	getSize (const DtEntityType &value) const
int	getSize (const DtArticulatedPartCollection &value) const
int	getSize (const DtAttachedPartCollection &value) const
int	getSize (const DtIffAtcNavaidsAltParm4 &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.

Member Typedef Documentation

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

Constructor & Destructor Documentation

DtPortalBoomInteraction::DtPortalBoomInteraction

(

)

virtual DtPortalBoomInteraction::~DtPortalBoomInteraction ( )

virtual

Member Function Documentation

DtPortalBoomInteraction::DtDEC_ATTRIBUTE	(	DtU32	,
		Volume	,
		volume
	)

DtPortalBoomInteraction::DtDEC_ATTRIBUTE	(	bool	,
		GroundMovement	,
		groundMovement
	)

virtual MAKVrExchange::DtPortalMessageKind DtPortalBoomInteraction::kind ( ) const

virtual

Returns the type of this message.

Implements MAKVrExchange::DtPortalInteraction.

virtual const char* DtPortalBoomInteraction::interactionKindName ( ) const

inlinevirtual

returns a well formated string representation of this interactions type

Implements MAKVrExchange::DtPortalInteraction.

virtual unsigned int DtPortalBoomInteraction::netSize ( ) const

virtual

Returns the network size of the message.

This is the number of bytes needed to store this message in a packet. This function is mainly called by the DtPortalConnection instance.

Returns

Size of the network message.

Precondition

Only calculates pduAttributes set up prior to calling this function.

Postcondition

If pduAttributes are changed, and your code had previously called netSize() to set a variable; then recalcuate the value of the the variable by calling netSize() again.

Reimplemented from MAKVrExchange::DtPortalInteraction.

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

virtual

Writes the message to a buffer.

This function should only be called by the DtPortalConnection instance.

Parameters

[in]

buffer

Precondition

buffer must be at least the size returned by netSize().

Reimplemented from MAKVrExchange::DtPortalInteraction.

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

virtual

fills out this message instance from the buffer provided.

This function is only called by the DtPortalConnection instance.

Parameters

[in]

buffer

Precondition

buffer must be at least the size returned by netSize().

Reimplemented from MAKVrExchange::DtPortalInteraction.

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

virtual

Prints the internal state of this message to the stream passed in.

All subclasses of DtPortalMessage should implement this.

Reimplemented from MAKVrExchange::DtPortalInteraction.

static DtPortalMessage* DtPortalBoomInteraction::create ( )

static

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

static

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

static

Member Data Documentation

const MAKVrExchange::DtPortalMessageKind DtPortalBoomInteraction::theKind

static

---

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

• pBoomInter.h