satellite-mobility-model.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_MOBILITY_MODEL_H
#define SATELLITE_MOBILITY_MODEL_H
 
#include "geo-coordinate.h"
 
#include "ns3/mobility-model.h"
 
namespace ns3
{

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

    SatMobilityModel();

    virtual ~SatMobilityModel() = 0;

    virtual Ptr<MobilityModel> Copy() const = 0;

    GeoCoordinate GetGeoPosition(void) const;
    void SetGeoPosition(const GeoCoordinate& position);

    double GetDistanceFrom(Ptr<const SatMobilityModel> position) const;
 
    void NotifyGeoCourseChange(void) const;

    typedef void (*CourseChangeCallback)(const Ptr<const SatMobilityModel> model);
 
  private:
    virtual GeoCoordinate DoGetGeoPosition(void) const = 0;
    virtual void DoSetGeoPosition(const GeoCoordinate& position) = 0;
    void DoSetCartesianPosition(const Vector& position) const;

    virtual Vector DoGetPosition(void) const;

    virtual void DoSetPosition(const Vector& position);

    ns3::TracedCallback<Ptr<const SatMobilityModel>> m_satCourseChangeTrace;
 
    // These are defined as mutable in order to support 'lazy' update.
 
    // position info in Cartesian format
    mutable Vector m_cartesianPosition;
 
    // flag to indicated if position in Cartesian format is out of date.
    mutable bool m_cartesianPositionOutdated;
 
    // this is the flag for indicating that when calling method DoSetPosition (defined by class
    // Mobility Model) is taking Vector filled by longitude (in x), latitude (in y) and altitude (in
    // z) this enables using ns-3 mobility helper without to convert geo coordinates first to
    // Cartesian but if for some reason used model needs Cartesian coordinates then this flag can be
    // turned off through attribute 'AsGeoCoordinates'.
    bool m_GetAsGeoCoordinates;
};
 
} // namespace ns3
 
#endif /* SATELLITE_MOBILITY_MODEL_H */