/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2007 INRIA

 * All rights reserved.

 *

 * 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 RANDOM_WAYPOINT_MOBILITY_MODEL_H

#define RANDOM_WAYPOINT_MOBILITY_MODEL_H

#include "static-speed-helper.h"

#include "mobility-model.h"

#include "random-position.h"

#include "ns3/ptr.h"

namespace ns3 {

class RandomVariable;

/**

 * \brief the parameters which control the behavior of a random waypoint

 *        mobility model.

 */

class RandomWaypointMobilityModelParameters : public Object

{

public:

  /**

   * Default parameters from \valueref{RandomWaypointPause},

   * and, \valueref{RandomWaypointPosition}.

   */

  RandomWaypointMobilityModelParameters ();

  /**

   * \param randomPosition a random position model to choose the position of waypoints.

   * \param speed a random variable to choose the speed

   * \param pause a random variable to choose the pause delay

   */

  RandomWaypointMobilityModelParameters (Ptr<RandomPosition> randomPosition,

                                         const RandomVariable &speed,

                                         const RandomVariable &pause);

  /**

   * \param randomPosition a random position model to choose the position of waypoints.

   */

  void SetWaypointPositionModel (Ptr<RandomPosition> randomPosition);

  /**

   * \param speed a random variable to choose the speed

   */

  void SetSpeed (const RandomVariable &speed);

  /**

   * \param pause a random variable to choose the pause delay

   */

  void SetPause (const RandomVariable &pause);

private:

  friend class RandomWaypointMobilityModel;

  static Ptr<RandomWaypointMobilityModelParameters> GetCurrent (void);

  virtual void DoDispose (void);

  RandomVariable *m_speed;

  RandomVariable *m_pause;

  Ptr<RandomPosition> m_position;

};

/**

 * \brief a random waypoint mobility model

 *

 * Each object chooses a random destination "waypoint", a random speed,

 * and a random pause time: it then pauses for the specified pause time,

 * and starts moving towards the specified destination with the specified

 * speed. Once the destination is reached the process starts again.

 *

 * The implementation of this model is not 2d-specific. i.e. if you provide

 * a 3d random waypoint position model to this mobility model, the model 

 * will still work.

 */

class RandomWaypointMobilityModel : public MobilityModel

{

public:

  /**

   * Default parameters from \valueref{RandomWaypointPause},

   * and, \valueref{RandomWaypointPosition}.

   */

  RandomWaypointMobilityModel ();

  /**

   * \param parameters the parameters which control the behavior of this model.

   */

  RandomWaypointMobilityModel (Ptr<RandomWaypointMobilityModelParameters> parameters);

private:

  void Start (void);

  void BeginWalk (void);

  virtual Vector DoGetPosition (void) const;

  virtual void DoSetPosition (const Vector &position);

  virtual Vector DoGetVelocity (void) const;

  StaticSpeedHelper m_helper;

  Ptr<RandomWaypointMobilityModelParameters> m_parameters;

  EventId m_event;

};

} // namespace ns3

#endif /* RANDOM_WAYPOINT_MOBILITY_MODEL_H */