satellite-superframe-sequence.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_SUPERFRAME_SEQUENCE_H
#define SATELLITE_SUPERFRAME_SEQUENCE_H
 
#include "satellite-control-message.h"
#include "satellite-frame-conf.h"
#include "satellite-wave-form-conf.h"
 
#include "ns3/object.h"
#include "ns3/ptr.h"
 
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{

class SatSuperframeSeq : public Object
{
  public:
    typedef std::vector<Ptr<SatSuperframeConf>> SatSuperframeConfList;

    static TypeId GetTypeId(void);

    SatSuperframeSeq();

    ~SatSuperframeSeq();

    void AddWaveformConf(Ptr<SatWaveformConf> wfConf);

    Ptr<SatWaveformConf> GetWaveformConf() const;

    void AddSuperframe(Ptr<SatSuperframeConf> conf);

    Ptr<SatSuperframeConf> GetSuperframeConf(uint8_t seqId) const;

    uint32_t GetCarrierId(uint8_t superframeId, uint8_t frameId, uint16_t frameCarrierId) const;

    uint32_t GetCarrierCount() const;

    uint32_t GetCarrierCount(uint8_t seqId) const;

    Time GetDuration(uint8_t seqId) const;

    double GetCarrierFrequencyHz(uint32_t carrierId) const;

    double GetCarrierBandwidthHz(uint32_t carrierId,
                                 SatEnums::CarrierBandwidthType_t bandwidthType) const;

    inline Time GetTargetDuration() const
    {
        return m_targetDuration;
    }
 
  private:
    typedef std::map<uint32_t, Ptr<SatControlMsgContainer>> TbtpMap_t;

    SatSuperframeConfList m_superframe;

    Ptr<SatWaveformConf> m_wfConf;

    Time m_targetDuration;
};
 
} // namespace ns3
 
#endif // SATELLITE_SUPERFRAME_SEQUENCE_H