wiselib.testing/algorithms/cluster/modules/jd/bfs_jd.h

Go to the documentation of this file.

#ifndef __BFS_JOIN_DECISION_H_
#define __BFS_JOIN_DECISION_H_

namespace wiselib {

template<typename OsModel_P, typename Radio_P>
class BfsJoinDecision {
public:
   //TYPEDEFS
   typedef OsModel_P OsModel;
   // os modules
   typedef Radio_P Radio;
   typedef typename OsModel::Debug Debug;
   // data types
   typedef typename Radio::node_id_t node_id_t;
   typedef typename Radio::block_data_t block_data_t;
   typedef node_id_t cluster_id_t;

   /*
    * Constructor
    * */
   BfsJoinDecision() :
      cluster_id_(-1), hops_(0) {
   }

   /*
    * Destructor
    * */
   ~BfsJoinDecision() {
   }

   /*
    * INIT
    * initializes the values of radio and debug
    */
   void init(Radio& radio, Debug& debug) {
      radio_ = &radio;
      debug_ = &debug;
   }

   /* SET functions */

   //set the cluster id
   inline void set_cluster_id(cluster_id_t cluster_id) {
      cluster_id_ = cluster_id;
   }

   inline void set_maxhops(int hops) {
      maxhops_ = hops;
   }

   //set the hops from head
   inline void set_hops(int hops) {
      hops_ = hops;
   }

   inline int hops() {
      return hops_;
   }

   /* GET functions */

   //get the cluster id
   inline cluster_id_t cluster_id(void) {
      return cluster_id_;
   }

   //get the join request payload
   JoinClusterMsg<OsModel, Radio> get_join_request_payload() {
      JoinClusterMsg<OsModel, Radio> msg;
      msg.set_cluster_id(cluster_id_);
      msg.set_hops(hops_);

#ifdef DEBUG_PAYLOAD
      debug().debug("[%d|%x|%d]\n",JOIN,cluster_id_,hops_);
#endif
      return msg;
   }
   JoinAccClusterMsg<OsModel, Radio> get_join_accept_payload() {
      JoinAccClusterMsg<OsModel, Radio> msg;
      msg.set_node_id(radio_->id());

#ifdef DEBUG_PAYLOAD
      debug().debug("[%d|%x]\n",JOIN_ACCEPT,radio_->id());
#endif
      return msg;
   }

   /*
    * JOIN
    * respond to an JOIN message received
    * either join to a cluster or not
    * */
   bool join(uint8_t *payload, uint8_t length) {
      JoinClusterMsg<OsModel, Radio> msg;
      memcpy(&msg, payload, length);
#ifdef SHAWN
                if (msg.cluster_id()==-1) return false;
#endif
                int mess_hops = msg.hops();
   
      if (msg.cluster_id()>radio_->id()) return false;

      //if in no cluster yet
      if (cluster_id_ == Radio::NULL_NODE_ID) {
#ifdef DEBUG_CLUSTERING_EXTRA
                    debug().debug("JOIN::%x::%d<%d::%d\n",radio_->id(),mess_hops,maxhops_,msg.cluster_id());
#endif
         if (mess_hops < maxhops_) {
#ifdef DEBUG_CLUSTERING_EXTRA
                        debug().debug("Joined::%x::",radio_->id());
#endif
            //join the cluster
            cluster_id_ = msg.cluster_id();
            //set the hops from head
            hops_ = mess_hops + 1;
            //return true
            return true;
         } else {
            return false;
         }
      }//if already in a cluster
            else {
                cluster_id_t mess_cluster_id = msg.cluster_id();
                uint8_t mess_hops = msg.hops();
#ifdef DEBUG_CLUSTERING_EXTRA
                debug().debug("JOIN2::%x::%d<%d::%x<%x::", radio_->id(), mess_hops, maxhops_, mess_cluster_id, cluster_id_);
#endif
                if (mess_hops + 1 <= hops_) {
                    if (mess_cluster_id < cluster_id_) {
#ifdef DEBUG_CLUSTERING_EXTRA
                        debug().debug("Joined::%x::", radio_->id());
#endif
                        //join the cluster
                        cluster_id_ = mess_cluster_id;
                        //set the hops from head
                        hops_ = mess_hops + 1;
                        //return true
                        return true;
                    } else {
                        return false;
                    }
                } else {
                    if ((hops_ == 0) && (msg.hops() < maxhops_) && (msg.cluster_id() < cluster_id_)) {
#ifdef DEBUG_CLUSTERING_EXTRA
                        debug().debug("Joined::%x::", radio_->id());
#endif
                        //join the cluster
                        cluster_id_ = mess_cluster_id;
                        //set the hops from head
                        hops_ = mess_hops + 1;
                        //return true
                        return true;

                    }
                    //return false
                    return false;
                }
            }
        }

        /*
         * RESET
         * resets the module
         * initializes values
         * */
        inline void reset() {
            cluster_id_ = Radio::NULL_NODE_ID;
            hops_ = 0;
        }

    private:

        cluster_id_t cluster_id_; //the cluste's id
        int hops_; //hops from cluster head
        int maxhops_;

        Radio * radio_; //radio module
        Debug * debug_; //debug module
    };
}

#endif