DtSimInternalCommunicationInterface Class Reference

The handler for all SimInternal messages that are sent to and from a specified DtVrfObject. More...

Public Member Functions
virtual	~DtSimInternalCommunicationInterface ()
virtual void	sendMessage (DtVrfObjectMessage *message)
	Fills in the sender name, and sends the message out to any designated recipients. More...
virtual void	receiveMessage (const DtVrfObjectMessage *message)
	This method pushes this message into the message executive, and any appropriate callbacks are invoked. More...
virtual DtVrfObject *	vrfObject ()
virtual void	addMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called for every message that is received by this interface. More...
virtual void	removeMessageCallback (DtVrfObjectMessageCallbackFcn fcn, void *usr)
virtual void	addMessageCallback (int type, DtVrfObjectMessageCallbackFcn fcn, void *usr)
	Callback which is called when a specific type of object message is processed. More...
virtual void	removeMessageCallback (int type, DtVrfObjectMessageCallbackFcn fcn, void *usr)

Static Public Member Functions
static DtSimInternalCommunicationInterface *	create (DtVrfObject *vrfObj)
	Calls constructor and virtual init(). More...

Protected Member Functions
	DtSimInternalCommunicationInterface (DtVrfObject *vrfObj)
	Constructor. Do not call directly. Call create() instead. More...
virtual bool	init ()
	Virtual init is called by the static creator method after construction. More...

Protected Attributes
DtVrfObject *	myVrfObject
DtVrfObjectMessageExecutive	myMessageExecutive

Private Member Functions
	DtSimInternalCommunicationInterface ()
	Not implemented. More...
	DtSimInternalCommunicationInterface (const DtSimInternalCommunicationInterface &orig)
	Not implemented. More...
DtSimInternalCommunicationInterface &	operator= (const DtSimInternalCommunicationInterface &orig)
	Not implemented. More...

Detailed Description

The handler for all SimInternal messages that are sent to and from a specified DtVrfObject.

This class is the central interface of a DtVrfObject to the SimInternal message system of inter-VrfObject communication. Callbacks can be registered for message receipt and messages can be sent. Normally, components on an entity will register with DtVrfObjectCommunicationInterface instead of with this object directly.

Constructor & Destructor Documentation

DtSimInternalCommunicationInterface::DtSimInternalCommunicationInterface ( )

private

Not implemented.

DtSimInternalCommunicationInterface::DtSimInternalCommunicationInterface ( const DtSimInternalCommunicationInterface &  orig )

private

Not implemented.

DtSimInternalCommunicationInterface::DtSimInternalCommunicationInterface ( DtVrfObject *  vrfObj )

protected

Constructor. Do not call directly. Call create() instead.

virtual DtSimInternalCommunicationInterface::~DtSimInternalCommunicationInterface ( )

virtual

Member Function Documentation

DtSimInternalCommunicationInterface& DtSimInternalCommunicationInterface::operator= ( const DtSimInternalCommunicationInterface &  orig )

private

Not implemented.

static DtSimInternalCommunicationInterface* DtSimInternalCommunicationInterface::create ( DtVrfObject *  vrfObj )

static

Calls constructor and virtual init().

virtual bool DtSimInternalCommunicationInterface::init ( )

protectedvirtual

Virtual init is called by the static creator method after construction.

virtual void DtSimInternalCommunicationInterface::sendMessage ( DtVrfObjectMessage *  message )

virtual

Fills in the sender name, and sends the message out to any designated recipients.

virtual void DtSimInternalCommunicationInterface::addMessageCallback ( DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

Callback which is called for every message that is received by this interface.

virtual void DtSimInternalCommunicationInterface::removeMessageCallback ( DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

virtual void DtSimInternalCommunicationInterface::addMessageCallback ( int  type, DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

Callback which is called when a specific type of object message is processed.

The type parameter is the content type of the message.

virtual void DtSimInternalCommunicationInterface::removeMessageCallback ( int  type, DtVrfObjectMessageCallbackFcn  fcn, void *  usr  )

virtual

virtual void DtSimInternalCommunicationInterface::receiveMessage ( const DtVrfObjectMessage *  message )

virtual

This method pushes this message into the message executive, and any appropriate callbacks are invoked.

This method should only be called by the DtSimInternalCommunicationManager.

virtual DtVrfObject* DtSimInternalCommunicationInterface::vrfObject ( )

virtual

Returns

The DtVrfObject that is associated with this interface.

Member Data Documentation

DtVrfObject* DtSimInternalCommunicationInterface::myVrfObject

protected

DtVrfObjectMessageExecutive DtSimInternalCommunicationInterface::myMessageExecutive

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjcore/simInternalCommunicationInterface.h