DtIfObjectIndexMessage Class Reference

Class DtIfObjectIndexMessage is the message content that contains information the names of the sim engine's local objects. More...

Inheritance diagram for DtIfObjectIndexMessage:

Public Member Functions
	DtIfObjectIndexMessage ()
	default constructor
	DtIfObjectIndexMessage (const DtString &simAddress, const DtNameToObjectIdMap &objectNames, const DtStringSet &objectIds)
	constructor
	DtIfObjectIndexMessage (const DtIfObjectIndexMessage &orig)
	copy constructor
const DtIfObjectIndexMessage &	operator= (const DtIfObjectIndexMessage &orig)
	assignment operator; same as copy costructor.
virtual	~DtIfObjectIndexMessage ()
	destructor
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
	Make a copy of this content.
virtual DtString	stringRep () const
	Get a readable string representation of this content.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Decodes content from buffer.
virtual bool	setToNet ()
	Encodes content into buffer.
virtual void	setSimAddress (const DtString &simAddress)
	See mySimAddress.
virtual DtString	simAddress () const
virtual void	setObjectNames (const DtNameToObjectIdMap &objectNames)
	See myObjectNames.
virtual const DtNameToObjectIdMap &	objectNames () const
virtual void	setObjectIds (const DtStringSet &objectIds)
	See myObjectIds.
virtual const DtStringSet &	objectIds () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	printDataToString (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
	Creator function. Returns new instance of this class.
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtString	mySimAddress
	Sim address of this sim engine.
DtNameToObjectIdMap	myObjectNames
	Map of object names to object ids. Used to search by names, or find an objectId for a name.
DtStringSet	myObjectIds
	Set of object ids. Used for searching by Ids.
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Detailed Description

Class DtIfObjectIndexMessage is the message content that contains information the names of the sim engine's local objects.

This is used to ensure sim engines do not get hung up on organization manager operations they may never be able to complete.

Constructor & Destructor Documentation

DtIfObjectIndexMessage::DtIfObjectIndexMessage

(

)

default constructor

DtIfObjectIndexMessage::DtIfObjectIndexMessage	(	const DtString &	simAddress,
		const DtNameToObjectIdMap &	objectNames,
		const DtStringSet &	objectIds
	)

constructor

DtIfObjectIndexMessage::DtIfObjectIndexMessage

(

const DtIfObjectIndexMessage &

orig

)

copy constructor

virtual DtIfObjectIndexMessage::~DtIfObjectIndexMessage ( )

virtual

destructor

Member Function Documentation

const DtIfObjectIndexMessage& DtIfObjectIndexMessage::operator=

(

const DtIfObjectIndexMessage &

orig

)

assignment operator; same as copy costructor.

static DtSimInterfaceContent* DtIfObjectIndexMessage::creator ( )

static

Creator function. Returns new instance of this class.

virtual int DtIfObjectIndexMessage::type ( ) const

virtual

Returns

DtIfObjectIndexDataType (defined in ddmMessageTypes.h)

Implements DtSimInterfaceContent.

virtual void DtIfObjectIndexMessage::setSimAddress ( const DtString &  simAddress )

virtual

See mySimAddress.

virtual DtString DtIfObjectIndexMessage::simAddress ( ) const

virtual

virtual void DtIfObjectIndexMessage::setObjectNames ( const DtNameToObjectIdMap &  objectNames )

virtual

See myObjectNames.

virtual const DtNameToObjectIdMap& DtIfObjectIndexMessage::objectNames ( ) const

virtual

virtual void DtIfObjectIndexMessage::setObjectIds ( const DtStringSet &  objectIds )

virtual

See myObjectIds.

virtual const DtStringSet& DtIfObjectIndexMessage::objectIds ( ) const

virtual

virtual DtSimInterfaceContent* DtIfObjectIndexMessage::clone ( ) const

virtual

Make a copy of this content.

Returns a pointer to a newly created copy of this class.

Implements DtSimInterfaceContent.

virtual DtString DtIfObjectIndexMessage::stringRep ( ) const

virtual

Get a readable string representation of this content.

virtual int DtIfObjectIndexMessage::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfObjectIndexMessage::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Decodes content from buffer.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfObjectIndexMessage::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtSimInterfaceContent.

Member Data Documentation

DtString DtIfObjectIndexMessage::mySimAddress

protected

Sim address of this sim engine.

This is used when the message is received to filter out our own messages.

DtNameToObjectIdMap DtIfObjectIndexMessage::myObjectNames

protected

Map of object names to object ids. Used to search by names, or find an objectId for a name.

DtStringSet DtIfObjectIndexMessage::myObjectIds

protected

Set of object ids. Used for searching by Ids.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifObjectIndexMessage.h