mobility-model.h

Go to the documentation of this file.

/*
 * Copyright (c) 2006,2007 INRIA
 *
 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef MOBILITY_MODEL_H
#define MOBILITY_MODEL_H
 
#include "ns3/object.h"
#include "ns3/traced-callback.h"
#include "ns3/vector.h"
 
namespace ns3
{
 
class MobilityModel : public Object
{
  public:
    static TypeId GetTypeId();
    MobilityModel();
    ~MobilityModel() override = 0;
 
    Vector GetPosition() const;
    Vector GetPositionWithReference(const Vector& referencePosition) const;
    void SetPosition(const Vector& position);
    Vector GetVelocity() const;
    double GetDistanceFrom(Ptr<const MobilityModel> position) const;
    double GetRelativeSpeed(Ptr<const MobilityModel> other) const;
    int64_t AssignStreams(int64_t stream);
 
    typedef void (*TracedCallback)(Ptr<const MobilityModel> model);
 
  protected:
    void NotifyCourseChange() const;
 
  private:
    virtual Vector DoGetPosition() const = 0;
    virtual Vector DoGetPositionWithReference(const Vector& referencePosition) const;
    virtual void DoSetPosition(const Vector& position) = 0;
    virtual Vector DoGetVelocity() const = 0;
    virtual int64_t DoAssignStreams(int64_t start);
 
    ns3::TracedCallback<Ptr<const MobilityModel>> m_courseChangeTrace;
};
 
} // namespace ns3
 
#endif /* MOBILITY_MODEL_H */