MAKVrExchange::DtPortalObject Class Reference

DtPortalObject are messages which also serve as state repositories for simulated objects. More...

Inheritance diagram for MAKVrExchange::DtPortalObject:

Public Member Functions
	DtPortalObject ()
virtual	~DtPortalObject ()
	DtPortalObject (const DtPortalObject &other)
DtPortalObject &	operator= (const DtPortalObject &other)
bool	operator!= (const DtPortalObject &other) const
bool	operator== (const DtPortalObject &other) const
virtual DtPortalMessageKind	kind () const =0
	Returns the message kind of this object.
virtual const char *	objectKindName () const =0
	Returns a string representation of this object's type.
virtual unsigned int	netSize () const
	Returns the network size of this object.
virtual void	writeSelfToBuffer (void *buffer) const
	Writes this message into the memory buffer provided by buffer.
virtual void	readSelfFromBuffer (const void *buffer)
	Fills in values in this message from the byte array specified by buffer.
virtual std::ostream &	printDataToStream (std::ostream &str) const
	Prints the current state of this message to the stream specified by str.
virtual bool	isFiltered () const
	NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
virtual void	setFiltered (bool value)
Data Exchange Attributes
	DtDEC_ATTRIBUTE (DtString, Identifier, identifier)
	Every object must have a unique Identifier which is of type string.
	DtDEC_ATTRIBUTE (bool, FinalMessage, finalMessage)
	If true this is the final message for this object, and the object has been deleted.
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.

Protected Attributes
bool	myFiltered
	Indicates if this object is not to be published.
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.

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

Detailed Description

DtPortalObject are messages which also serve as state repositories for simulated objects.

All DtPortalObjects can be marked as final, meaning the object is to be distroyed. All instances also have a unique identifier.

Constructor & Destructor Documentation

MAKVrExchange::DtPortalObject::DtPortalObject

(

)

virtual MAKVrExchange::DtPortalObject::~DtPortalObject ( )

virtual

MAKVrExchange::DtPortalObject::DtPortalObject

(

const DtPortalObject &

other

)

Member Function Documentation

DtPortalObject& MAKVrExchange::DtPortalObject::operator=

(

const DtPortalObject &

other

)

bool MAKVrExchange::DtPortalObject::operator!=

(

const DtPortalObject &

other

)

const

bool MAKVrExchange::DtPortalObject::operator==

(

const DtPortalObject &

other

)

const

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

pure virtual

Returns the message kind of this object.

The message Kind is unique integer. The kind is unique to all messages. Existing message kinds can be found in pMessageKinds.h

Implements MAKVrExchange::DtPortalMessage.

Implemented in MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalRadioReceiverObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalBaseObject, MAKVrExchange::DtPortalGenericObject, DtPortalFruit, and MAKVrExchange::DtPortalAggregate.

virtual const char* MAKVrExchange::DtPortalObject::objectKindName ( ) const

pure virtual

Returns a string representation of this object's type.

This is used by the GUI to print the kind of object.

Implemented in MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalBaseObject, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalRadioReceiverObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalGenericObject, DtPortalFruit, and MAKVrExchange::DtPortalAggregate.

virtual unsigned int MAKVrExchange::DtPortalObject::netSize ( ) const

virtual

Returns the network size of this object.

The network size is the number of bytes needed to store this message in memory.

Reimplemented from MAKVrExchange::DtPortalMessage.

Reimplemented in MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalBaseObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalRadioReceiverObject, MAKVrExchange::DtPortalDesignatorObject, DtPortalFruit, MAKVrExchange::DtPortalGenericObject, and MAKVrExchange::DtPortalAggregate.

virtual void MAKVrExchange::DtPortalObject::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 big.

Reimplemented from MAKVrExchange::DtPortalMessage.

Reimplemented in MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalBaseObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalRadioReceiverObject, MAKVrExchange::DtPortalDesignatorObject, DtPortalFruit, MAKVrExchange::DtPortalGenericObject, and MAKVrExchange::DtPortalAggregate.

virtual void MAKVrExchange::DtPortalObject::readSelfFromBuffer ( const void *  buffer )

virtual

Fills in values in this message from the byte array specified by buffer.

Buffer must be at least as big as netSize() bytes.

Reimplemented from MAKVrExchange::DtPortalMessage.

Reimplemented in MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalBaseObject, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalRadioReceiverObject, MAKVrExchange::DtPortalBaseEntity, MAKVrExchange::DtPortalDesignatorObject, DtPortalFruit, MAKVrExchange::DtPortalGenericObject, and MAKVrExchange::DtPortalAggregate.

virtual std::ostream& MAKVrExchange::DtPortalObject::printDataToStream ( std::ostream &  str ) const

virtual

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

Reimplemented from MAKVrExchange::DtPortalMessage.

Reimplemented in MAKVrExchange::DtPortalEntity, MAKVrExchange::DtPortalEnvironmentProcessObject, MAKVrExchange::DtPortalEmbeddedSystem, MAKVrExchange::DtPortalEmitterSystemObject, MAKVrExchange::DtPortalIffObject, MAKVrExchange::DtPortalRadioTransmitterObject, MAKVrExchange::DtPortalBaseObject, MAKVrExchange::DtPortalGriddedDataObject, MAKVrExchange::DtPortalRadioReceiverObject, MAKVrExchange::DtPortalDesignatorObject, MAKVrExchange::DtPortalBaseEntity, DtPortalFruit, MAKVrExchange::DtPortalGenericObject, and MAKVrExchange::DtPortalAggregate.

MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE	(	DtString	,
		Identifier	,
		identifier
	)

Every object must have a unique Identifier which is of type string.

This method sets that identifier.

MAKVrExchange::DtPortalObject::DtDEC_ATTRIBUTE	(	bool	,
		FinalMessage	,
		finalMessage
	)

If true this is the final message for this object, and the object has been deleted.

bool MAKVrExchange::DtPortalObject::isFiltered ( ) const

inlinevirtual

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

References myFiltered.

void MAKVrExchange::DtPortalObject::setFiltered ( bool  value )

inlinevirtual

References myFiltered.

Member Data Documentation

bool MAKVrExchange::DtPortalObject::myFiltered

protected

Indicates if this object is not to be published.

Referenced by isFiltered(), and setFiltered().

---

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

• pObject.h