radio_entity.h

Go to the documentation of this file.

#ifndef RADIO_ENTITY_H
#define RADIO_ENTITY_H

namespace argos {
   class CRadioEntity;
   class CRadioMedium;
}

#include <argos3/core/simulator/entity/positional_entity.h>
#include <argos3/core/utility/datatypes/set.h>
#include <argos3/core/utility/math/vector3.h>
#include <argos3/core/utility/datatypes/byte_array.h>
#include <argos3/core/simulator/space/positional_indices/space_hash.h>
#include <argos3/core/simulator/space/positional_indices/grid.h>

namespace argos {

   class CRadioEntity : public CPositionalEntity {

   public:

      ENABLE_VTABLE();

   public:

      typedef std::vector<CRadioEntity*> TList;

   public:

      CRadioEntity(CComposableEntity* pc_parent);

      CRadioEntity(CComposableEntity* pc_parent,
                   const std::string& str_id,
                   Real f_transmit_range);
                                            
      virtual ~CRadioEntity() {}

      virtual void Init(TConfigurationNode& t_tree);

      virtual void Reset();

      virtual void Destroy();

      virtual void SetEnabled(bool b_enabled);

      inline const std::vector<std::pair<CVector3, CByteArray> >& GetData() const {
         return m_vecData;
      }

      inline std::vector<std::pair<CVector3, CByteArray> >& GetData() {
         return m_vecData;
      }

      inline void ReceiveData(const CVector3& c_tx_location, const CByteArray& c_tx_data) {
         m_vecData.emplace_back(c_tx_location, c_tx_data);
      }

      inline bool HasData() const {
         return !m_vecData.empty();
      }

      inline Real GetRange() const {
         return m_fRange;
      }

      inline void SetRange(Real f_range) {
         m_fRange = f_range;
      }

      virtual std::string GetTypeDescription() const {
         return "radio";
      }

      inline bool HasMedium() const {
         return m_pcMedium != nullptr;
      }

      CRadioMedium& GetMedium() const;

      void SetMedium(CRadioMedium& c_medium);

   protected:

      Real m_fRange;
      std::vector<std::pair<CVector3, CByteArray> > m_vecData;
      CRadioMedium* m_pcMedium;

   };

   /****************************************/
   /****************************************/

   class CRadioEntitySpaceHashUpdater : public CSpaceHashUpdater<CRadioEntity> {

   public:

      virtual void operator()(CAbstractSpaceHash<CRadioEntity>& c_space_hash,
                              CRadioEntity& c_element);

   private:

      SInt32 m_nI, m_nJ, m_nK;

   };

   /****************************************/
   /****************************************/

   class CRadioEntityGridUpdater : public CGrid<CRadioEntity>::COperation {

   public:

      CRadioEntityGridUpdater(CGrid<CRadioEntity>& c_grid);
      virtual bool operator()(CRadioEntity& c_entity);

   private:

      CGrid<CRadioEntity>& m_cGrid;
      SInt32 m_nI, m_nJ, m_nK;

   };

   /****************************************/
   /****************************************/

}

#endif