waypoint-mobility-model.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009 Phillip Sitbon
 *
 * 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: Phillip Sitbon <phillip@sitbon.net>
 */
#ifndef WAYPOINT_MOBILITY_MODEL_H
#define WAYPOINT_MOBILITY_MODEL_H
 
#include "mobility-model.h"
#include "waypoint.h"
 
#include "ns3/vector.h"
 
#include <deque>
#include <stdint.h>
 
class WaypointMobilityModelNotifyTest;
 
namespace ns3
{
 
class WaypointMobilityModel : public MobilityModel
{
  public:
    static TypeId GetTypeId();
 
    WaypointMobilityModel();
    ~WaypointMobilityModel() override;
 
    void AddWaypoint(const Waypoint& waypoint);
 
    Waypoint GetNextWaypoint() const;
 
    uint32_t WaypointsLeft() const;
 
    void EndMobility();
 
  private:
    friend class ::WaypointMobilityModelNotifyTest; // To allow Update() calls and access to
                                                    // m_current
 
    virtual void Update() const;
    void DoDispose() override;
    Vector DoGetPosition() const override;
    void DoSetPosition(const Vector& position) override;
    Vector DoGetVelocity() const override;
 
  protected:
    bool m_first;
    bool m_lazyNotify;
    bool m_initialPositionIsWaypoint;
    mutable std::deque<Waypoint> m_waypoints;
    mutable Waypoint m_current;
    mutable Waypoint m_next;
    mutable Vector m_velocity;
};
 
} // namespace ns3
 
#endif /* WAYPOINT_MOBILITY_MODEL_H */