satellite-mobility-observer.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_OBSERVER_H
#define SATELLITE_MOBILITY_OBSERVER_H
 
#include "geo-coordinate.h"
#include "satellite-mobility-model.h"
#include "satellite-propagation-delay-model.h"
 
#include "ns3/object.h"
 
#include <string>
 
namespace ns3
{

class SatMobilityObserver : public Object
{
  public:
    static TypeId GetTypeId(void);

    SatMobilityObserver();

    SatMobilityObserver(Ptr<SatMobilityModel> ownMobility,
                        Ptr<SatMobilityModel> geoSatMobility,
                        bool isRegenerative = false);

    virtual ~SatMobilityObserver();

    virtual void DoDispose(void);

    void ObserveTimingAdvance(Ptr<PropagationDelayModel> ownDelayModel,
                              Ptr<PropagationDelayModel> anotherDelayModel,
                              Ptr<SatMobilityModel> anotherMobility);

    double GetElevationAngle(void);

    double GetVelocity(void);

    Time GetTimingAdvance(void);

    typedef void (*PropertyChangedCallback)(Ptr<const SatMobilityObserver> mobilityObserver);
 
  private:
    void NotifyPropertyChange(void) const;

    void UpdateElevationAngle();

    void UpdateTimingAdvance();

    void SatelliteStatusChanged();

    void PositionChanged(std::string context, Ptr<const SatMobilityModel> position);

    TracedCallback<Ptr<const SatMobilityObserver>> m_propertyChangeTrace;
 
    Ptr<SatMobilityModel> m_ownMobility;
    Ptr<SatMobilityModel> m_anotherMobility;
    Ptr<SatMobilityModel> m_geoSatMobility;
    Ptr<PropagationDelayModel> m_ownProgDelayModel;
    Ptr<PropagationDelayModel> m_anotherProgDelayModel;
 
    bool m_initialized;          // flag for GetElevationAngle
    bool m_updateElevationAngle; // flag for GetElevationAngle
    bool m_updateTimingAdvance;  // flag for GetTimingAdvance
    double m_minAltitude;
    double m_maxAltitude;
    double m_elevationAngle;
    double m_earthRadius;
    double m_radiusRatio;
    double m_maxDistanceToSatellite;
    Time m_timingAdvance_s;
    double m_velocity;
    bool m_isRegenerative;
};
 
} // namespace ns3
 
#endif /* SATELLITE_MOBILITY_OBSERVER_H */