satellite-tbtp-container.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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SATELLITE_TBTP_CONTAINER_H_
#define SATELLITE_TBTP_CONTAINER_H_
 
#include "satellite-control-message.h"
#include "satellite-frame-conf.h"
#include "satellite-superframe-sequence.h"
 
#include "ns3/mac48-address.h"
#include "ns3/object.h"
 
#include <map>
#include <stdint.h>
 
namespace ns3
{

class SortTimeSlots
{
  public:
    SortTimeSlots()
    {
    }

    bool operator()(Ptr<SatTimeSlotConf> p1, Ptr<SatTimeSlotConf> p2)
    {
        return p1->GetStartTime() < p2->GetStartTime();
    }
};

class SatTbtpContainer : public Object
{
  public:
    SatTbtpContainer();

    SatTbtpContainer(Ptr<SatSuperframeSeq> seq);

    ~SatTbtpContainer();

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    void SetMacAddress(Mac48Address address);

    void Add(Time startTime, Ptr<SatTbtpMessage> tbtp);
 
    void Clear();

    bool HasScheduledTimeSlots();
 
  private:
    void RemovePastTbtps();
 
    typedef std::multimap<Time, Ptr<SatTbtpMessage>> TbtpMap_t;
    TbtpMap_t m_tbtps;

    Mac48Address m_address;

    Ptr<SatSuperframeSeq> m_superframeSeq;

    uint32_t m_maxStoredTbtps;

    uint32_t m_rcvdTbtps;

    Time m_superFrameDuration;
};
 
} // namespace ns3
 
#endif /* SATELLITE_TBTP_CONTAINER_H_ */