satellite-bbframe.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_H_
#define SATELLITE_BBFRAME_H_
 
#include "satellite-bbframe-conf.h"
#include "satellite-enums.h"
 
#include "ns3/nstime.h"
#include "ns3/packet.h"
#include "ns3/simple-ref-count.h"
#include "ns3/traced-callback.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatBbFrame : public SimpleRefCount<SatBbFrame>
{
  public:
    typedef std::vector<Ptr<Packet>> SatBbFramePayload_t;

    SatBbFrame();

    SatBbFrame(SatEnums::SatModcod_t modCod,
               SatEnums::SatBbFrameType_t type,
               Ptr<SatBbFrameConf> conf);

    virtual ~SatBbFrame();

    const SatBbFramePayload_t& GetPayload();

    uint32_t AddPayload(Ptr<Packet> packet);

    uint32_t GetSpaceLeftInBytes() const;

    uint32_t GetSpaceUsedInBytes() const;

    uint32_t GetMaxSpaceInBytes() const;

    double GetOccupancy() const;

    double GetSpectralEfficiency(double carrierBandwidthInHz) const;

    double GetOccupancyIfMerged(Ptr<SatBbFrame> mergedFrame) const;

    bool MergeWithFrame(Ptr<SatBbFrame> mergedFrame,
                        TracedCallback<Ptr<SatBbFrame>, Ptr<SatBbFrame>> mergeTraceCb);

    Time Shrink(Ptr<SatBbFrameConf> conf);

    Time Extend(Ptr<SatBbFrameConf> conf);

    inline Time GetDuration() const
    {
        return m_duration;
    }

    inline SatEnums::SatBbFrameType_t GetFrameType() const
    {
        return m_frameType;
    }

    inline SatEnums::SatModcod_t GetModcod() const
    {
        return m_modCod;
    }

    inline uint8_t GetSliceId() const
    {
        return m_sliceId;
    }

    void SetSliceId(uint8_t sliceId)
    {
        m_sliceId = sliceId;
    }

    inline uint32_t GetFrameHeaderSize() const
    {
        return m_headerSizeInBytes;
    }

    typedef void (*BbFrameCallback)(Ptr<SatBbFrame> bbFrame);

    typedef void (*BbFrameMergeCallback)(Ptr<SatBbFrame> to, Ptr<SatBbFrame> from);
 
  private:
    SatEnums::SatModcod_t m_modCod;
    uint8_t m_sliceId;
    uint32_t m_freeSpaceInBytes;
    uint32_t m_maxSpaceInBytes;
    uint32_t m_headerSizeInBytes;
    SatBbFramePayload_t m_framePayload;
    Time m_duration;
    SatEnums::SatBbFrameType_t m_frameType;
};
 
} // namespace ns3
 
#endif /* SATELLITE_BBFRAME_H_ */