satellite-superframe-allocator.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2019 CNES
 *
 * 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: Joaquin Muguerza <jmuguerza@viveris.fr>
 */
 
#ifndef SAT_SUPERFRAME_ALLOCATOR_H
#define SAT_SUPERFRAME_ALLOCATOR_H
 
#include "satellite-control-message.h"
#include "satellite-frame-allocator.h"
#include "satellite-frame-conf.h"
 
#include "ns3/address.h"
#include "ns3/simple-ref-count.h"
#include "ns3/traced-callback.h"
 
#include <stdint.h>
 
namespace ns3
{

class SatSuperframeAllocator : public Object
{
  public:
    SatSuperframeAllocator(Ptr<SatSuperframeConf> superFrameConf);

    virtual ~SatSuperframeAllocator();

    static TypeId GetTypeId(void);

    inline Time GetSuperframeDuration() const
    {
        return m_superframeConf->GetDuration();
    }

    virtual void ReserveMinimumRate(uint32_t minimumRateBytes, bool controlSlotsEnabled) = 0;

    virtual void ReleaseMinimumRate(uint32_t minimumRateBytes, bool controlSlotsEnabled) = 0;

    virtual void PreAllocateSymbols(SatFrameAllocator::SatFrameAllocContainer_t& allocReqs) = 0;

    virtual void GenerateTimeSlots(SatFrameAllocator::TbtpMsgContainer_t& tbtpContainer,
                                   uint32_t maxSizeInBytes,
                                   SatFrameAllocator::UtAllocInfoContainer_t& utAllocContainer,
                                   TracedCallback<uint32_t> waveformTrace,
                                   TracedCallback<uint32_t, uint32_t> utLoadTrace,
                                   TracedCallback<uint32_t, double> loadTrace) = 0;
 
  protected:
    // super frame  configuration
    Ptr<SatSuperframeConf> m_superframeConf;
};
 
} // namespace ns3
 
#endif /* SAT_SUPERFRAME_ALLOCATOR_H */