satellite-traced-mobility-model.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2018 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: Mathias Ettinger <mettinger@toulouse.viveris.com>
 */
 
#ifndef SATELLITE_TRACED_MOBILITY_MODEL_H
#define SATELLITE_TRACED_MOBILITY_MODEL_H
 
#include "satellite-antenna-gain-pattern-container.h"
#include "satellite-mobility-model.h"
 
#include "ns3/nstime.h"
 
#include <stdint.h>
#include <string>
 
namespace ns3
{

class SatTracedMobilityModel : public SatMobilityModel
{
  public:
    static TypeId GetTypeId(void);

    virtual void DoDispose();

    SatTracedMobilityModel();

    SatTracedMobilityModel(uint32_t satId,
                           const std::string& filename,
                           Ptr<SatAntennaGainPatternContainer> agp);

    virtual ~SatTracedMobilityModel();
 
    // Inherited from MobilityModel
    Ptr<MobilityModel> Copy() const override
    {
        return CreateObject<SatTracedMobilityModel>(*this);
    }

    void SetSatId(uint32_t satId);

    uint32_t GetSatId(void) const;

    uint32_t GetBestBeamId(bool ignoreNan = false) const;
 
  private:
    virtual Vector DoGetVelocity(void) const;

    virtual GeoCoordinate DoGetGeoPosition(void) const;

    virtual void DoSetGeoPosition(const GeoCoordinate& position);

    virtual Vector DoGetPosition(void) const;

    virtual void DoSetPosition(const Vector& position);
 
    void UpdateGeoPositionFromFile(void);
 
    uint32_t m_satId;
    std::string m_traceFilename;
    Time m_updateInterval;
    GeoCoordinate::ReferenceEllipsoid_t m_refEllipsoid;
    GeoCoordinate m_geoPosition;
    Vector m_velocity;
    Ptr<SatAntennaGainPatternContainer> m_antennaGainPatterns;
};
 
} // namespace ns3
 
#endif /* SATELLITE_TRACED_MOBILITY_MODEL_H */