examples/addCommModel/myCommsModel.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2011 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: myCommsModel.h,v $ $Revision: 1.1 $ $State: Exp $
** Created: 9/16/11 MEM
*******************************************************************************/

//\file myCommsModel.h
//\brief An implementation of DtCommModel that models a simple radio model,
//\using signal interaction as the network transport type.
//\Will check the range between the sender and receiver. If the power of the sender's 
//\radio is too weak for the range then the receiver will not get the message.

#pragma once

#include "vrfobjcore/simpleRadioCommModel.h"

const char MyCommModelType[] = "my-comm-model";

class  MyCommModel : public DtSimpleRadioCommModel
{
private:
   //Not implemented.
   MyCommModel();
   MyCommModel(const MyCommModel& orig);
   MyCommModel& operator=(const MyCommModel& orig);

protected:
   //Use the create() method instead of calling the constructor.
   MyCommModel(DtCommModelCreationParams& params);
   //Virtual init() called from the create() method.
   //Calls createTransporter() to set myTransporter.
   virtual bool init();

public:
   //Static creator function that can be registered with factories.
   //Calls the constructor, and init() on the new instance before returning it.
   //The params passed in are those read in from the commModelParams.mtl file for your simulation
   //model set. If you'd like to add to these derive a new commModelDescriptor.
   static DtCommModel* create(DtCommModelCreationParams& params);

   virtual ~MyCommModel();

   //\return MyCommModelType.
   //Type strings for default commModel subclasses are defined in 
   //commModelTypes.h. Returns MyCommModelType.This is the string that is added to the commModelParams.mtl
   //configuration file for the simulation model set being used. Make sure the string returned here
   //matches what is in that file.
   virtual DtString type() const;

   //Overridden from base to set the ReadyToSend status of the radio to
   //true as soon as it registers. 
   virtual void registerRadio(DtVrfRadio* radio);

protected:

   //Checks the connectivity of the radios for delivery of message.
   //\return 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--default connection modes are "all"--you can send to any entity regardless of force,
   //"force"--you can send to anyone in your force type, or "aggregate"--you can only send to those in your 
   //same echelon, same aggregate.
   //For this example we will simply do a range check and see if the receiver is
   //within the power range of the sender's radio.
   virtual bool checkRadioConnectivity(DtVrfObject* sender, DtVrfObject* receiver);

protected:

};