/usr/include/ns3.17/ns3/propagation-delay-model.h is in libns3-dev 3.17+dfsg-1build1.
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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2005,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 PROPAGATION_DELAY_MODEL_H
#define PROPAGATION_DELAY_MODEL_H
#include "ns3/ptr.h"
#include "ns3/object.h"
#include "ns3/nstime.h"
#include "ns3/random-variable-stream.h"
namespace ns3 {
class MobilityModel;
/**
* \ingroup propagation
*
* \brief calculate a propagation delay.
*/
class PropagationDelayModel : public Object
{
public:
static TypeId GetTypeId (void);
virtual ~PropagationDelayModel ();
/**
* \param a the source
* \param b the destination
* \returns the calculated propagation delay
*
* Calculate the propagation delay between the specified
* source and destination.
*/
virtual Time GetDelay (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const = 0;
/**
* If this delay model uses objects of type RandomVariableStream,
* set the stream numbers to the integers starting with the offset
* 'stream'. Return the number of streams (possibly zero) that
* have been assigned.
*
* \param stream
* \return the number of stream indices assigned by this model
*/
int64_t AssignStreams (int64_t stream);
private:
/**
* Subclasses must implement this; those not using random variables
* can return zero
*/
virtual int64_t DoAssignStreams (int64_t stream) = 0;
};
/**
* \ingroup propagation
*
* \brief the propagation delay is random
*/
class RandomPropagationDelayModel : public PropagationDelayModel
{
public:
static TypeId GetTypeId (void);
/**
* Use the default parameters from PropagationDelayRandomDistribution.
*/
RandomPropagationDelayModel ();
virtual ~RandomPropagationDelayModel ();
virtual Time GetDelay (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
private:
virtual int64_t DoAssignStreams (int64_t stream);
Ptr<RandomVariableStream> m_variable;
};
/**
* \ingroup propagation
*
* \brief the propagation speed is constant
*/
class ConstantSpeedPropagationDelayModel : public PropagationDelayModel
{
public:
static TypeId GetTypeId (void);
/**
* Use the default parameters from PropagationDelayConstantSpeed.
*/
ConstantSpeedPropagationDelayModel ();
virtual Time GetDelay (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
/**
* \param speed the new speed (m/s)
*/
void SetSpeed (double speed);
/**
* \returns the current propagation speed (m/s).
*/
double GetSpeed (void) const;
private:
virtual int64_t DoAssignStreams (int64_t stream);
double m_speed;
};
} // namespace ns3
#endif /* PROPAGATION_DELAY_MODEL_H */
|