DtSimInternalCommunicationManager Class Reference

The manager for SimInternal messages on a single simulation engine. More...

List of all members.

Public Member Functions
virtual	~DtSimInternalCommunicationManager ()
virtual void	deliverMessage (const DtVrfObjectMessage *message)
	Puts this message on the message delivery queue.
virtual void	tick ()
	Delivers all messages currently on the delivery queue.
virtual void	registerCommunicationInterface (DtSimInternalCommunicationInterface *commIf)
	Add/remove a DtSimInternalCommunicationInterface from this manager.
virtual void	unregisterCommunicationInterface (DtSimInternalCommunicationInterface *commIf)
	Add/remove a DtSimInternalCommunicationInterface from this manager.
Static Public Member Functions
static DtSimInternalCommunicationManager *	create (DtSimManager *simMgr)
	Calls the constructor and the virtual init().
Protected Types
typedef std::list < DtSimInternalCommunicationInterface * >	DtCommInterfaceList
typedef std::deque < DtVrfObjectMessage * >	DtMessageDeque
Protected Member Functions
	DtSimInternalCommunicationManager (DtSimManager *simMgr)
	Use the create() method instead of the constructor.
virtual bool	init ()
	Virtual init() called by the create() method.
virtual void	deliverMessageLocally (const DtVrfObjectMessage *message)
	Sends this message to any local interfaces that should receive the messages.
virtual void	deliverMessageRemotely (const DtVrfObjectMessage *message)
	Sends this message to the network so other VRF sim engines can receive and process it.
virtual bool	objectShouldReceiveMessage (DtVrfObject *vrfObj, const DtVrfObjectMessage *msg)
Protected Attributes
DtSimManager *	mySimManager
DtCommInterfaceList	myCommInterfaceList
DtMessageDeque	myMessagesToDeliver
	Queue which stores messages that need to be delivered.
Private Member Functions
	DtSimInternalCommunicationManager ()
	Not Implemented.
	DtSimInternalCommunicationManager (const DtSimInternalCommunicationManager &orig)
	Not Implemented.
DtSimInternalCommunicationManager &	operator= (const DtSimInternalCommunicationManager &orig)
	Not Implemented.
virtual void	processDeliverRadioMessage (DtSimMessage *msg)
	Callback for processing deliver radio message types of interface messages.
static void	deliverRadioMessageCallback (DtSimMessage *msg, void *usr)
	Callback for processing deliver radio message types of interface messages.

---

Detailed Description

The manager for SimInternal messages on a single simulation engine.

This class manages the passing of DtVrfObjectMessage instances between different DtSimInternalCommunicationInterface instances. A message is passed from the communication interface to this class, which then passes it out to the appropriate destination interfaces, if any. This class is also responsible for sending the messages onto the network to other instances of this class in other VRF simulation engines.

---

Member Typedef Documentation

typedef std::list<DtSimInternalCommunicationInterface*> DtSimInternalCommunicationManager::DtCommInterfaceList [protected]

typedef std::deque<DtVrfObjectMessage*> DtSimInternalCommunicationManager::DtMessageDeque [protected]

---

Constructor & Destructor Documentation

DtSimInternalCommunicationManager::DtSimInternalCommunicationManager

(

)

[private]

Not Implemented.

DtSimInternalCommunicationManager::DtSimInternalCommunicationManager

(

const DtSimInternalCommunicationManager &

orig

)

[private]

Not Implemented.

DtSimInternalCommunicationManager::DtSimInternalCommunicationManager

(

DtSimManager *

simMgr

)

[protected]

Use the create() method instead of the constructor.

virtual DtSimInternalCommunicationManager::~DtSimInternalCommunicationManager

(

)

[virtual]

---

Member Function Documentation

DtSimInternalCommunicationManager& DtSimInternalCommunicationManager::operator=

(

const DtSimInternalCommunicationManager &

orig

)

[private]

Not Implemented.

static DtSimInternalCommunicationManager* DtSimInternalCommunicationManager::create

(

DtSimManager *

simMgr

)

[static]

Calls the constructor and the virtual init().

Returns:

Newly created object.

virtual bool DtSimInternalCommunicationManager::init

(

)

[protected, virtual]

Virtual init() called by the create() method.

virtual void DtSimInternalCommunicationManager::registerCommunicationInterface

(

DtSimInternalCommunicationInterface *

commIf

)

[virtual]

Add/remove a DtSimInternalCommunicationInterface from this manager.

Only interfaces that are registered will be able to receive messages from this manager.

virtual void DtSimInternalCommunicationManager::unregisterCommunicationInterface

(

DtSimInternalCommunicationInterface *

commIf

)

[virtual]

Add/remove a DtSimInternalCommunicationInterface from this manager.

Only interfaces that are registered will be able to receive messages from this manager.

virtual void DtSimInternalCommunicationManager::deliverMessage

(

const DtVrfObjectMessage *

message

)

[virtual]

Puts this message on the message delivery queue.

The message will be cloned by this method.

virtual void DtSimInternalCommunicationManager::tick

(

)

[virtual]

Delivers all messages currently on the delivery queue.

static void DtSimInternalCommunicationManager::deliverRadioMessageCallback	(	DtSimMessage *	msg,
		void *	usr
	)		[static, protected]

Callback for processing deliver radio message types of interface messages.

virtual void DtSimInternalCommunicationManager::processDeliverRadioMessage

(

DtSimMessage *

msg

)

[protected, virtual]

Callback for processing deliver radio message types of interface messages.

virtual void DtSimInternalCommunicationManager::deliverMessageLocally

(

const DtVrfObjectMessage *

message

)

[protected, virtual]

Sends this message to any local interfaces that should receive the messages.

virtual void DtSimInternalCommunicationManager::deliverMessageRemotely

(

const DtVrfObjectMessage *

message

)

[protected, virtual]

Sends this message to the network so other VRF sim engines can receive and process it.

virtual bool DtSimInternalCommunicationManager::objectShouldReceiveMessage	(	DtVrfObject *	vrfObj,
		const DtVrfObjectMessage *	msg
	)		[protected, virtual]

Returns:

True if the specified object should receive the message.

---

Member Data Documentation

DtSimManager* DtSimInternalCommunicationManager::mySimManager [protected]

DtCommInterfaceList DtSimInternalCommunicationManager::myCommInterfaceList [protected]

DtMessageDeque DtSimInternalCommunicationManager::myMessagesToDeliver [protected]

Queue which stores messages that need to be delivered.

---

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

• include/vrfobjcore/simInternalCommunicationManager.h