satellite-bbframe-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: Sami Rantanen <sami.rantanen@magister.fi>
 */
 
#ifndef SATELLITE_BBFRAME_CONTAINER_H
#define SATELLITE_BBFRAME_CONTAINER_H
 
#include "satellite-bbframe.h"
#include "satellite-enums.h"
 
#include "ns3/simple-ref-count.h"
 
#include <deque>
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatBbFrameContainer : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatBbFrameContainer();

    SatBbFrameContainer(std::vector<SatEnums::SatModcod_t>& modcodsInUse, Ptr<SatBbFrameConf> conf);

    virtual ~SatBbFrameContainer();

    bool IsEmpty(uint32_t priorityClass, SatEnums::SatModcod_t modcod);

    void AddData(uint32_t priorityClass, SatEnums::SatModcod_t modcod, Ptr<Packet> data);

    uint32_t GetBytesLeftInTailFrame(uint32_t priorityClass, SatEnums::SatModcod_t modcod);

    uint32_t GetMaxFramePayloadInBytes(uint32_t priorityClass, SatEnums::SatModcod_t modcod);

    SatEnums::SatModcod_t GetModcod(uint32_t priorityClass, double cno);

    Ptr<SatBbFrame> GetNextFrame();
 
    void MergeBbFrames(double carrierBandwidthInHz);

    Time GetTotalDuration() const;

    uint32_t GetFrameSymbols(SatEnums::SatModcod_t modcod);

    void SetMaxSymbolRate(uint32_t maxSymbolRate);

    uint32_t GetMaxSymbolRate();

    void ClearAllFrames();
 
  private:
    typedef std::map<SatEnums::SatModcod_t, std::deque<Ptr<SatBbFrame>>> FrameContainer_t;
 
    std::deque<Ptr<SatBbFrame>> m_ctrlContainer;
    FrameContainer_t m_container;
    Time m_totalDuration;
    Ptr<SatBbFrameConf> m_bbFrameConf;
    SatEnums::SatBbFrameType_t m_defaultBbFrameType;
    uint32_t m_maxSymbolRate;

    TracedCallback<Ptr<SatBbFrame>, Ptr<SatBbFrame>> m_bbFrameMergeTrace;

    void CreateFrameToTail(uint32_t priorityClass, SatEnums::SatModcod_t modcod);
};
 
} // namespace ns3
 
#endif /* SATELLITE_BBFRAME_CONTAINER_H */