/usr/include/ns3.26/ns3/constant-velocity-helper.h is in libns3-dev 3.26+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* 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 CONSTANT_VELOCITY_HELPER_H
#define CONSTANT_VELOCITY_HELPER_H
#include "ns3/nstime.h"
#include "ns3/vector.h"
#include "ns3/box.h"
namespace ns3 {
class Rectangle;
/**
* \ingroup mobility
*
* \brief Utility class used to move node with constant velocity.
*/
class ConstantVelocityHelper
{
public:
ConstantVelocityHelper ();
/**
* Create object and set position
* \param position the position vector
*/
ConstantVelocityHelper (const Vector &position);
/**
* Create object and set position and velocity
* \param position the position vector
* \param vel the velocity vector
*/
ConstantVelocityHelper (const Vector &position,
const Vector &vel);
/**
* Set position vector
* \param position Position vector
*/
void SetPosition (const Vector &position);
/**
* Get current position vector
* \return Position vector
*/
Vector GetCurrentPosition (void) const;
/**
* Get velocity; if paused, will return a zero vector
* \return Velocity vector
*/
Vector GetVelocity (void) const;
/**
* Set new velocity vector
* \param vel Velocity vector
*/
void SetVelocity (const Vector &vel);
/**
* Pause mobility at current position
*/
void Pause (void);
/**
* Resume mobility from current position at current velocity
*/
void Unpause (void);
/**
* Update position, if not paused, from last position and time of last update
* \param rectangle 2D bounding rectangle for resulting position; object will not move outside the rectangle
*/
void UpdateWithBounds (const Rectangle &rectangle) const;
/**
* Update position, if not paused, from last position and time of last update
* \param bounds 3D bounding box for resulting position; object will not move outside the box
*/
void UpdateWithBounds (const Box &bounds) const;
/**
* Update position, if not paused, from last position and time of last update
*/
void Update (void) const;
private:
mutable Time m_lastUpdate; //!< time of last update
mutable Vector m_position; //!< state variable for current position
Vector m_velocity; //!< state variable for velocity
bool m_paused; //!< state variable for paused
};
} // namespace ns3
#endif /* CONSTANT_VELOCITY_HELPER_H */
|