satellite-rtn-link-time.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_RTN_LINK_TIME_H_
#define SATELLITE_RTN_LINK_TIME_H_
 
#include "satellite-superframe-sequence.h"
 
#include <stdint.h>
 
namespace ns3
{

 
class SatRtnLinkTime : public SimpleRefCount<SatRtnLinkTime>
{
  public:
    SatRtnLinkTime();

    virtual ~SatRtnLinkTime();

    void Initialize(Ptr<SatSuperframeSeq> seq);

    Time GetSuperFrameDuration(uint8_t superFrameSeqId) const;

    uint32_t GetCurrentSuperFrameCount(uint8_t superFrameSeqId) const;

    Time GetCurrentSuperFrameStartTime(uint8_t superFrameSeqId) const;

    uint32_t GetNextSuperFrameCount(uint8_t superFrameSeqId) const;

    Time GetNextSuperFrameStartTime(uint8_t superFrameSeqId) const;

    Time GetSuperFrameTxTime(uint8_t superFrameSeqId,
                             uint32_t superFrameCount,
                             Time timingAdvance) const;

    uint32_t GetCurrentSuperFrameCount(uint8_t superFrameSeqId, Time timingAdvance) const;

    uint32_t GetNextSuperFrameCount(uint8_t superFrameSeqId, Time timingAdvance) const;

    Time GetCurrentSuperFrameTxTime(uint8_t superFrameSeqId, Time timingAdvance) const;

    Time GetNextSuperFrameTxTime(uint8_t superFrameSeqId, Time timingAdvance) const;
 
  private:
    Ptr<SatSuperframeSeq> m_superframeSeq;
};
 
} // namespace ns3
 
#endif /* SATELLITE_RTN_LINK_TIME_H_ */