MyCommModel Class Reference

Inheritance diagram for MyCommModel:

Public Member Functions
virtual	~MyCommModel ()
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.
Public Member Functions inherited from DtSimpleRadioCommModel
virtual	~DtSimpleRadioCommModel ()
virtual void	sendMessage (DtVrfObjectMessage *message, DtVrfRadio *sendingRadio)
	Uses the transporter to send the message to the network.
Public Member Functions inherited from DtCommModel
virtual	~DtCommModel ()
virtual void	unregisterRadio (DtVrfRadio *radio)
	Removes a radio from the comm model.
virtual bool	publishTransmitters () const
	Returns true if radios registered to this comm model should publish transmitters.

Static Public Member Functions
static DtCommModel *	create (DtCommModelCreationParams &params)
	Static creator function that can be registered with factories.

Protected Member Functions
	MyCommModel (DtCommModelCreationParams &params)
virtual bool	init ()
	Virtual init() called from the create() method.
virtual bool	checkRadioConnectivity (DtVrfObject *sender, DtVrfObject *receiver)
	Checks the connectivity of the radios for delivery of message.
Protected Member Functions inherited from DtSimpleRadioCommModel
	DtSimpleRadioCommModel (DtCommModelCreationParams &params)
	Use the create() method instead of calling the constructor.
virtual void	tick ()
	Delivers any queued messages.
virtual DtSignalMessageTransporter *	createTransporter ()
	Creates and returns the transporter subclass that will be used for this DtSimpleRadioCommModel.
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)
Protected Member Functions inherited from DtCommModel
	DtCommModel (DtCommModelCreationParams &params)
	Use the create() method instead of calling the constructor.
virtual DtVrfRadio *	findRadioByObjectName (const DtString &objectName, int radioId) const
	Finds a radio registered with this comm model by object name and radio ID.
virtual DtVrfRadio *	findRadio (const DtEntityIdentifier &entityId, int radioId) const
	Finds a radio registered with this comm model by entity ID and radio ID.
virtual bool	addressMatchesObject (const DtString &addressText, bool addressIsEchelonId, const DtVrfObject *object)

Private Member Functions
	MyCommModel ()
	MyCommModel (const MyCommModel &orig)
MyCommModel &	operator= (const MyCommModel &orig)

Additional Inherited Members
Protected Types inherited from DtSimpleRadioCommModel
enum	ConnectionMode { ConnectionModeAll = 0, ConnectionModeAggregate = 1, ConnectionModeForce = 2 }
typedef std::deque < DtVrfObjectMessageConstPtr >	DtMessageQueue
Static Protected Member Functions inherited from DtSimpleRadioCommModel
static void	messageReceivedCallback (DtSignalMessageTransporterCallbackParams *params, void *usr)
Protected Attributes inherited from DtSimpleRadioCommModel
DtSignalMessageTransporter *	myTransporter
DtMessageQueue	myMessagesToDeliver
const DtSimpleRadioCommModelDescriptor *	mySimpleCommDescriptor
ConnectionMode	myConnectionMode
Static Protected Attributes inherited from DtCommModel
static DtCommModelFactory *	theFactory

Constructor & Destructor Documentation

MyCommModel::MyCommModel ( )

private

MyCommModel::MyCommModel ( const MyCommModel &  orig )

private

MyCommModel::MyCommModel ( DtCommModelCreationParams &  params )

protected

virtual MyCommModel::~MyCommModel ( )

virtual

Member Function Documentation

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

private

virtual bool MyCommModel::init ( )

protectedvirtual

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

Calls createTransporter() to set myTransporter.

Reimplemented from DtSimpleRadioCommModel.

static DtCommModel* MyCommModel::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 DtSimpleRadioCommModel.

virtual DtString MyCommModel::type ( ) const

virtual

Returns

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

Reimplemented from DtSimpleRadioCommModel.

virtual void MyCommModel::registerRadio ( DtVrfRadio *  radio )

virtual

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

Reimplemented from DtSimpleRadioCommModel.

virtual bool MyCommModel::checkRadioConnectivity ( DtVrfObject *  sender, DtVrfObject *  receiver  )

protectedvirtual

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 from DtSimpleRadioCommModel.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/addCommModel/myCommsModel.h