lte-anr.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011, 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 * Copyright (c) 2013 Budiarto Herman
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Original work authors (from lte-enb-rrc.cc):
 * - Nicola Baldo <nbaldo@cttc.es>
 * - Marco Miozzo <mmiozzo@cttc.es>
 * - Manuel Requena <manuel.requena@cttc.es>
 *
 * Converted to ANR interface by:
 * - Budiarto Herman <budiarto.herman@magister.fi>
 */
 
#ifndef LTE_ANR_H
#define LTE_ANR_H
 
#include <ns3/lte-anr-sap.h>
#include <ns3/lte-rrc-sap.h>
#include <ns3/object.h>
 
#include <map>
 
namespace ns3
{
 
class LteAnrSapProvider;
class LteAnrSapUser;
class LteNeighbourRelation;
 
class LteAnr : public Object
{
  public:
    LteAnr(uint16_t servingCellId);
    ~LteAnr() override;
 
    static TypeId GetTypeId();
 
    void AddNeighbourRelation(uint16_t cellId);
 
    void RemoveNeighbourRelation(uint16_t cellId);
 
    virtual void SetLteAnrSapUser(LteAnrSapUser* s);
 
    virtual LteAnrSapProvider* GetLteAnrSapProvider();
 
    friend class MemberLteAnrSapProvider<LteAnr>;
 
  protected:
    // inherited from Object
    void DoInitialize() override;
    void DoDispose() override;
 
  private:
    // ANR SAP PROVIDER IMPLEMENTATION
 
    void DoReportUeMeas(LteRrcSap::MeasResults measResults);
 
    void DoAddNeighbourRelation(uint16_t cellId);
 
    bool DoGetNoRemove(uint16_t cellId) const;
 
    bool DoGetNoHo(uint16_t cellId) const;
 
    bool DoGetNoX2(uint16_t cellId) const;
 
    // ANR SAP
 
    LteAnrSapProvider* m_anrSapProvider;
 
    LteAnrSapUser* m_anrSapUser;
 
    // ATTRIBUTE
 
    uint8_t m_threshold;
 
    struct NeighbourRelation_t
    {
        bool noRemove;            
        bool noHo;                
        bool noX2;                
        bool detectedAsNeighbour; 
    };
 
    typedef std::map<uint16_t, NeighbourRelation_t> NeighbourRelationTable_t;
 
    NeighbourRelationTable_t m_neighbourRelationTable;
 
    const NeighbourRelation_t* Find(uint16_t cellId) const;
 
    uint8_t m_measId;
 
    uint16_t m_servingCellId;
 
}; // end of class LteAnr
 
} // end of namespace ns3
 
#endif /* LTE_ANR_H */