148 lines
4.2 KiB
C++
148 lines
4.2 KiB
C++
/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
|
|
/*
|
|
* Copyright (c) 2006,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_WALK_2D_MOBILITY_MODEL_H
|
|
#define RANDOM_WALK_2D_MOBILITY_MODEL_H
|
|
|
|
#include "ns3/object.h"
|
|
#include "ns3/nstime.h"
|
|
#include "ns3/component-manager.h"
|
|
#include "ns3/event-id.h"
|
|
#include "ns3/rectangle.h"
|
|
#include "mobility-model.h"
|
|
#include "static-speed-helper.h"
|
|
|
|
namespace ns3 {
|
|
|
|
class RandomVariable;
|
|
|
|
/**
|
|
* \brief parameters to control a random walk 2d model
|
|
*
|
|
* A single parameter object can be shared by multiple random
|
|
* walk models.
|
|
*/
|
|
class RandomWalk2dMobilityModelParameters : public Object
|
|
{
|
|
public:
|
|
/**
|
|
* Instantiate a set of RandomWalk parameters initialized
|
|
* with the Bind default values.
|
|
*/
|
|
RandomWalk2dMobilityModelParameters ();
|
|
virtual ~RandomWalk2dMobilityModelParameters ();
|
|
/**
|
|
* \param speed the random variable used to pick a new
|
|
* speed when the direction is changed.
|
|
*
|
|
*/
|
|
void SetSpeed (const RandomVariable &speed);
|
|
/**
|
|
* \param direction the random variable used to pick a new
|
|
* direction.
|
|
*/
|
|
void SetDirection (const RandomVariable &direction);
|
|
/**
|
|
* \param distance the distance before a direction change
|
|
*
|
|
* Unit is meters.
|
|
* "time" mode is incompatible with "distance" mode.
|
|
*/
|
|
void SetModeDistance (double distance);
|
|
/**
|
|
* \param time the delay before a direction change.
|
|
*
|
|
* "time" mode is incompatible with "distance" mode.
|
|
*/
|
|
void SetModeTime (Time time);
|
|
|
|
/**
|
|
* \param bounds the bounds of the random walk
|
|
*/
|
|
void SetBounds (const Rectangle &bounds);
|
|
|
|
|
|
// needed public for internal default value code.
|
|
enum Mode {
|
|
MODE_DISTANCE,
|
|
MODE_TIME
|
|
};
|
|
private:
|
|
friend class RandomWalk2dMobilityModel;
|
|
static Ptr<RandomWalk2dMobilityModelParameters> GetCurrent (void);
|
|
|
|
enum Mode m_mode;
|
|
double m_modeDistance;
|
|
Time m_modeTime;
|
|
RandomVariable *m_speed;
|
|
RandomVariable *m_direction;
|
|
Rectangle m_bounds;
|
|
};
|
|
|
|
/**
|
|
* \brief a 2D random walk position model
|
|
*
|
|
* Each instance moves with a speed and direction choosen at random
|
|
* with the user-provided random variables until
|
|
* either a fixed distance has been walked or until a fixed amount
|
|
* of time.
|
|
*
|
|
* The parameters of the model can be specified either with the ns3::Bind
|
|
* function and the variables "RandomWalk2dSpeed", "RandomWalk2dMode",
|
|
* "RandomWalk2dDistance", "RandomWalk2dTime", and, "RandomWalk2dBounds" or
|
|
* with an instance of the RandomWalk2dMobilityModelParameters class which
|
|
* must be fed to the RandomWalk2dMobilityModel constructors.
|
|
*/
|
|
class RandomWalk2dMobilityModel : public MobilityModel
|
|
{
|
|
public:
|
|
static const ClassId cid;
|
|
/**
|
|
* Create a new position object located at position (0,0,0)
|
|
*/
|
|
RandomWalk2dMobilityModel ();
|
|
/**
|
|
* \param parameters the parameters to use to control
|
|
* the movement of this mobile object.
|
|
*
|
|
* Create a new position object located at position (0,0,0) with
|
|
* the specified parameters.
|
|
*/
|
|
RandomWalk2dMobilityModel (Ptr<RandomWalk2dMobilityModelParameters> parameters);
|
|
|
|
private:
|
|
void Start (void);
|
|
void Rebound (Time timeLeft);
|
|
void DoWalk (Time timeLeft);
|
|
virtual void DoDispose (void);
|
|
virtual Position DoGet (void) const;
|
|
virtual void DoSet (const Position &position);
|
|
virtual Speed DoGetSpeed (void) const;
|
|
|
|
StaticSpeedHelper m_helper;
|
|
EventId m_event;
|
|
Ptr<RandomWalk2dMobilityModelParameters> m_parameters;
|
|
};
|
|
|
|
|
|
} // namespace ns3
|
|
|
|
#endif /* RANDOM_WALK_2D_MOBILITY_MODEL_H */
|