The base class for all messages passed through the portal. More...

Inheritance diagram for MAKVrExchange::DtPortalMessage:

Public Member Functions
	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 DtPortalMessageKind	kind () const =0
	Returns the type of this message.
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 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 std::ostream &	printDataToStream (std::ostream &str) const
	Prints the internal state of this message to the stream passed in.
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.

Protected Member Functions
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
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

The base class for all messages passed through the portal.

DtPortalMessage class is the base class for all messages passed through the portal. All derived classes must have a unique message kind and be able to copy, serialize and unserialize themselves.

Constructor & Destructor Documentation

MAKVrExchange::DtPortalMessage::DtPortalMessage ( )

The default CTOR.

virtual MAKVrExchange::DtPortalMessage::~DtPortalMessage ( )

virtual

The default DTOR.

MAKVrExchange::DtPortalMessage::DtPortalMessage ( const DtPortalMessage & other )

Copy CTOR, this class is copyable.

Member Function Documentation

DtPortalMessage& MAKVrExchange::DtPortalMessage::operator= ( const DtPortalMessage & other )

Assignment Operator, this class is copyable.

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

pure virtual

Returns the type of this message.

virtual unsigned int MAKVrExchange::DtPortalMessage::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.

virtual void MAKVrExchange::DtPortalMessage::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().

virtual void MAKVrExchange::DtPortalMessage::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().

virtual unsigned int MAKVrExchange::DtPortalMessage::serialNumber ( ) const

virtual

Returns a unique identifier for this message.

The serial number is unique to the DtPortalConnection instance which processed this message. The serial number may wrap around if a significant amount of messages are sent. This attribute is only valid for DtPortalMessage instances received from the DtPortalConnection instance.

virtual DtU32 MAKVrExchange::DtPortalMessage::sendingBrokerId ( ) const

virtual

Returns the ID of the sending broker.

This is filled in by the DtPortalConnection instance when a message is sent. As such it is only valid when the message has been received and sent properly.

virtual DtTime MAKVrExchange::DtPortalMessage::timeSent ( ) const

virtual

The Time that the message was sent.

This value is filled in by the DtPortalConnection instance when a message is sent. Its value is set from the simTime on the sending DtPortalConnection instance.

virtual DtTime MAKVrExchange::DtPortalMessage::timeReceived ( ) const

virtual

The time that this message was received.

This value is filled in by the DtPortalConnection instance which received the message. It is set from the simTime value held by the clock on the DtPortalConnection instance.

virtual std::ostream& MAKVrExchange::DtPortalMessage::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.

virtual void MAKVrExchange::DtPortalMessage::setTimeSent ( const DtTime & tm ) const

virtual

This method should be considered private and not be used.

This method is called by DtPortalConnection.

virtual void MAKVrExchange::DtPortalMessage::setTimeReceived ( const DtTime & tm ) const

virtual

This method should be considered private and not be used.

This method is called by DtPortalConnection.

virtual void MAKVrExchange::DtPortalMessage::setSendingBrokerId ( const DtU32 & id ) const

virtual

This method should be considered private and not be used.

This method is called by DtPortalConnection.

virtual void MAKVrExchange::DtPortalMessage::setSerialNumber ( unsigned int i ) const

virtual

This method should be considered private and not be used.

This method is called by DtPortalConnection.

char* MAKVrExchange::DtPortalMessage::encode	(	const DtString &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtU8 &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtU16 &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtU32 &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtU64 &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtFloat32 &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtFloat64 &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtVector &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtTaitBryan &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const bool &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const std::vector< char > &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const std::vector< DtU16 > &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const std::vector< DtU32 > &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtAttributeValuePairList &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const std::vector< DtString > &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtSilentAggregateArray &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtSilentEntityArray &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtVariableLengthData &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtAttributeValuePair &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtFixedLengthData &	value,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtFixedLengthDataArray &	value,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtAggregateVariableDatum &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtAggregateVariableDatumArray &	val,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtEmitterBeamData &	data,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtEmitterBeamList &	container,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtEntityIdentifier &	value,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtEntityType &	value,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtArticulatedPartCollection &	value,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtAttachedPartCollection &	value,
		char *	buffer
	)		const

protected

char* MAKVrExchange::DtPortalMessage::encode	(	const DtIffAtcNavaidsAltParm4 &	value,
		char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtString &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtU8 &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtU16 &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtU32 &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtU64 &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtFloat32 &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtFloat64 &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtVector &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtTaitBryan &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	bool &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	std::vector< char > &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	std::vector< DtU16 > &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	std::vector< DtU32 > &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtAttributeValuePairList &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	std::vector< DtString > &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtSilentAggregateArray &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtSilentEntityArray &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtVariableLengthData &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtAttributeValuePair &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtFixedLengthData &	value,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtFixedLengthDataArray &	value,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtAggregateVariableDatum &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtAggregateVariableDatumArray &	val,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtEmitterBeamData &	data,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtEmitterBeamList &	container,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtEntityIdentifier &	value,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtEntityType &	value,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtArticulatedPartCollection &	value,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtAttachedPartCollection &	value,
		const char *	buffer
	)		const

protected

const char* MAKVrExchange::DtPortalMessage::decode	(	DtIffAtcNavaidsAltParm4 &	value,
		const char *	buffer
	)		const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtString & val ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtVector & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtU8 & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtU16 & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtU32 & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtU64 & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtFloat32 & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtFloat64 & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const bool & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtTaitBryan & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const std::vector< char > & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const std::vector< DtU16 > & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const std::vector< DtU32 > & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtAttributeValuePairList & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const std::vector< DtString > & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtSilentAggregateArray & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtSilentEntityArray & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtVariableLengthData & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtAttributeValuePair & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtFixedLengthData & value ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtFixedLengthDataArray & value ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtAggregateVariableDatum & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtAggregateVariableDatumArray & v ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtEmitterBeamData & data ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtEmitterBeamList & container ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtEntityIdentifier & value ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtEntityType & value ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtArticulatedPartCollection & value ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtAttachedPartCollection & value ) const

protected

int MAKVrExchange::DtPortalMessage::getSize ( const DtIffAtcNavaidsAltParm4 & value ) const

protected

Member Data Documentation

DtU32 MAKVrExchange::DtPortalMessage::myMutableSerialNumber

mutableprotected

mutable because it can be set by the PConnection.

Not considered part of the classes state.

DtU32 MAKVrExchange::DtPortalMessage::myMutableSendingBrokerId

mutableprotected

mutable because it can be set by the PConnection.

Not considered part of the classes state.

DtTime MAKVrExchange::DtPortalMessage::myMutableSentTimeStamp

mutableprotected

mutable because it can be set by the PConnection.

Not considered part of the classes state.

DtTime MAKVrExchange::DtPortalMessage::myMutableReceivedTimeStamp

mutableprotected

mutable because it can be set by the PConnection.

Not considered part of the classes state.

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

pMessage.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation