DtSimpleRadioCommModel Class Reference

An implementation of DtCommModel that models a simple radio model, using signal interaction as the network transport type. More...

Inheritance diagram for DtSimpleRadioCommModel:

List of all members.

Public Member Functions
virtual	~DtSimpleRadioCommModel ()
virtual DtString	type () const
virtual void	registerRadio (DtVrfRadio *radio)
	Overridden from base to set the ReadyToSend status of the radio to true as soon as it registers.
virtual void	sendMessage (DtVrfObjectMessage *message, DtVrfRadio *sendingRadio)
	Uses the transporter to send the message to the network.
Static Public Member Functions
static DtCommModel *	create (DtCommModelCreationParams &params)
	Static creator function that can be registered with factories.
Protected Types
enum	ConnectionMode { ConnectionModeAll = 0, ConnectionModeAggregate = 1, ConnectionModeForce = 2 }
typedef std::deque < DtVrfObjectMessageConstPtr >	DtMessageQueue
Protected Member Functions
	DtSimpleRadioCommModel (DtCommModelCreationParams &params)
	Use the create() method instead of calling the constructor.
virtual bool	init ()
	Virtual init() called from the create() method.
virtual void	tick ()
	Delivers any queued messages.
virtual DtSignalMessageTransporter *	createTransporter ()
	Creates and returns the transporter subclass that will be used for this DtSimpleRadioCommModel.
virtual bool	checkRadioConnectivity (DtVrfObject *sender, DtVrfObject *receiver)
	Checks the connectivity of the radios for delivery of message.
virtual void	deliverMessageToRecipients (const DtVrfObjectMessage *message)
	Overridden from base class to call checkRadioConnectivity() for each possible receiver of the message before delivering it.
virtual void	processMessageReceived (DtSignalMessageTransporterCallbackParams *params)
Static Protected Member Functions
static void	messageReceivedCallback (DtSignalMessageTransporterCallbackParams *params, void *usr)
Protected Attributes
DtSignalMessageTransporter *	myTransporter
DtMessageQueue	myMessagesToDeliver
const DtSimpleRadioCommModelDescriptor *	mySimpleCommDescriptor
ConnectionMode	myConnectionMode
Private Member Functions
	DtSimpleRadioCommModel ()
	Not implemented.
	DtSimpleRadioCommModel (const DtSimpleRadioCommModel &orig)
	Not implemented.
DtSimpleRadioCommModel &	operator= (const DtSimpleRadioCommModel &orig)
	Not implemented.

---

Detailed Description

An implementation of DtCommModel that models a simple radio model, using signal interaction as the network transport type.

Messages sent using this radio model are received immediately by the receiver entities. Radios connected to this comm model are always ready to send, as this model never blocks sending of messages.

---

Member Typedef Documentation

typedef std::deque<DtVrfObjectMessageConstPtr> DtSimpleRadioCommModel::DtMessageQueue [protected]

---

Member Enumeration Documentation

enum DtSimpleRadioCommModel::ConnectionMode [protected]

Enumerator:

ConnectionModeAll
ConnectionModeAggregate
ConnectionModeForce

---

Constructor & Destructor Documentation

DtSimpleRadioCommModel::DtSimpleRadioCommModel

(

)

[private]

Not implemented.

DtSimpleRadioCommModel::DtSimpleRadioCommModel

(

const DtSimpleRadioCommModel &

orig

)

[private]

Not implemented.

DtSimpleRadioCommModel::DtSimpleRadioCommModel

(

DtCommModelCreationParams &

params

)

[protected]

Use the create() method instead of calling the constructor.

virtual DtSimpleRadioCommModel::~DtSimpleRadioCommModel

(

)

[virtual]

---

Member Function Documentation

DtSimpleRadioCommModel& DtSimpleRadioCommModel::operator=

(

const DtSimpleRadioCommModel &

orig

)

[private]

Not implemented.

virtual bool DtSimpleRadioCommModel::init

(

)

[protected, virtual]

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

Calls createTransporter() to set myTransporter.

Reimplemented from DtCommModel.

Reimplemented in MyCommModel.

virtual void DtSimpleRadioCommModel::tick

(

)

[protected, virtual]

Delivers any queued messages.

Reimplemented from DtCommModel.

static DtCommModel* DtSimpleRadioCommModel::create

(

DtCommModelCreationParams &

params

)

[static]

Static creator function that can be registered with factories.

Calls the constructor, and init() on the new instance before returning it.

Reimplemented from DtCommModel.

Reimplemented in MyCommModel.

virtual DtString DtSimpleRadioCommModel::type

(

)

const [virtual]

Returns:

DtSimpleRadioCommModelType. Type strings for DtSimpleRadioCommModel subclasses are defined in commModelTypes.h.

Reimplemented from DtCommModel.

Reimplemented in MyCommModel.

virtual void DtSimpleRadioCommModel::registerRadio

(

DtVrfRadio *

radio

)

[virtual]

Overridden from base to set the ReadyToSend status of the radio to true as soon as it registers.

Reimplemented from DtCommModel.

Reimplemented in MyCommModel.

virtual void DtSimpleRadioCommModel::sendMessage	(	DtVrfObjectMessage *	message,
		DtVrfRadio *	sendingRadio
	)		[virtual]

Uses the transporter to send the message to the network.

Reimplemented from DtCommModel.

virtual DtSignalMessageTransporter* DtSimpleRadioCommModel::createTransporter

(

)

[protected, virtual]

Creates and returns the transporter subclass that will be used for this DtSimpleRadioCommModel.

virtual bool DtSimpleRadioCommModel::checkRadioConnectivity	(	DtVrfObject *	sender,
		DtVrfObject *	receiver
	)		[protected, virtual]

Checks the connectivity of the radios for delivery of message.

Returns:

True if the message is allowed to be delivered, or false of the sender/receiver radios are not connected. Results will vary, depending on the current connection mode specified in the descriptor.

Reimplemented in MyCommModel.

virtual void DtSimpleRadioCommModel::deliverMessageToRecipients

(

const DtVrfObjectMessage *

message

)

[protected, virtual]

Overridden from base class to call checkRadioConnectivity() for each possible receiver of the message before delivering it.

Reimplemented from DtCommModel.

static void DtSimpleRadioCommModel::messageReceivedCallback	(	DtSignalMessageTransporterCallbackParams *	params,
		void *	usr
	)		[static, protected]

virtual void DtSimpleRadioCommModel::processMessageReceived

(

DtSignalMessageTransporterCallbackParams *

params

)

[protected, virtual]

---

Member Data Documentation

DtSignalMessageTransporter* DtSimpleRadioCommModel::myTransporter [protected]

DtMessageQueue DtSimpleRadioCommModel::myMessagesToDeliver [protected]

const DtSimpleRadioCommModelDescriptor* DtSimpleRadioCommModel::mySimpleCommDescriptor [protected]

ConnectionMode DtSimpleRadioCommModel::myConnectionMode [protected]

---

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

• include/vrfobjcore/simpleRadioCommModel.h