satellite-id-mapper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * 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
 *
 * Author: Frans Laakso <frans.laakso@magister.fi>
 */
#ifndef SATELLITE_ID_MAPPER_H
#define SATELLITE_ID_MAPPER_H
 
#include <ns3/mac48-address.h>
#include <ns3/object.h>
 
#include <map>
#include <stdint.h>
#include <string>
 
namespace ns3
{
 
class Node;
class Address;
class Mac48Address;
 
class SatIdMapper : public Object
{
  public:
    SatIdMapper();
 
    ~SatIdMapper();
 
    static TypeId GetTypeId(void);
 
    void DoDispose();
 
    /* ATTACH TO MAPS */
 
    uint32_t AttachMacToTraceId(Address mac);
 
    uint32_t AttachMacToUtId(Address mac);
 
    uint32_t AttachMacToUtUserId(Address mac);
 
    void AttachMacToSatId(Address mac, uint32_t satId);
 
    void AttachMacToBeamId(Address mac, uint32_t beamId);
 
    void AttachMacToGroupId(Address mac, uint32_t groupId);
 
    void AttachMacToGwId(Address mac, uint32_t gwId);
 
    uint32_t AttachMacToGwUserId(Address mac);
 
    void AttachMacToSatIdIsl(Mac48Address mac, uint32_t satId);
 
    void RemoveMacToSatIdIsl(Mac48Address mac);
 
    void UpdateMacToSatId(Address mac, uint32_t satId);
 
    void UpdateMacToBeamId(Address mac, uint32_t beamId);
 
    /* ID GETTERS */
 
    int32_t GetTraceIdWithMac(Address mac) const;
 
    int32_t GetUtIdWithMac(Address mac) const;
 
    int32_t GetUtUserIdWithMac(Address mac) const;
 
    int32_t GetSatIdWithMac(Address mac) const;
 
    int32_t GetBeamIdWithMac(Address mac) const;
 
    int32_t GetGroupIdWithMac(Address mac) const;
 
    int32_t GetGwIdWithMac(Address mac) const;
 
    int32_t GetGwUserIdWithMac(Address mac) const;
 
    int32_t GetSatIdWithMacIsl(Mac48Address mac) const;
 
    /* NODE GETTERS */
 
    Address GetGwMacWithNode(Ptr<Node> gwNode) const;
 
    Address GetSatMacWithNode(Ptr<Node> satNode) const;
 
    Address GetUtMacWithNode(Ptr<Node> utNode) const;
 
    Address GetUtUserMacWithNode(Ptr<Node> utUserNode) const;
 
    /* PRINT RELATED METHODS */
 
    void PrintTraceMap() const;
 
    std::string GetMacInfo(Address mac) const;
 
    void Reset();
 
    void ShowIslMap();
 
    void EnableMapPrint(bool enableMapPrint)
    {
        m_enableMapPrint = enableMapPrint;
    }
 
  private:
    uint32_t m_traceIdIndex;
 
    uint32_t m_utIdIndex;
 
    uint32_t m_utUserIdIndex;
 
    uint32_t m_gwUserIdIndex;
 
    std::map<Address, uint32_t> m_macToTraceIdMap;
 
    std::map<Address, uint32_t> m_macToUtIdMap;
 
    std::map<Address, uint32_t> m_macToUtUserIdMap;
 
    std::map<Address, uint32_t> m_macToSatIdMap;
 
    std::map<Address, uint32_t> m_macToBeamIdMap;
 
    std::map<Address, uint32_t> m_macToGroupIdMap;
 
    std::map<Address, uint32_t> m_macToGwIdMap;
 
    std::map<Address, uint32_t> m_macToGwUserIdMap;
 
    std::map<Ptr<Node>, Address> m_utNodeToGwAddressMap;
 
    bool m_enableMapPrint;
 
    std::map<Mac48Address, uint32_t> m_macToSatIdIslMap;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ID_MAPPER_H */