/usr/include/ns3/point-to-point-grid.h is in libns3-dev 3.13+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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* 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: Josh Pelkey <jpelkey@gatech.edu>
*/
#ifndef POINT_TO_POINT_GRID_HELPER_H
#define POINT_TO_POINT_GRID_HELPER_H
#include <vector>
#include "internet-stack-helper.h"
#include "point-to-point-helper.h"
#include "ipv4-address-helper.h"
#include "ipv4-interface-container.h"
#include "net-device-container.h"
namespace ns3 {
/**
* \ingroup pointtopointlayout
*
* \brief A helper to make it easier to create a grid topology
* with p2p links
*/
class PointToPointGridHelper
{
public:
/**
* Create a PointToPointGridHelper in order to easily create
* grid topologies using p2p links
*
* \param nRows total number of rows in the grid
*
* \param nCols total number of colums in the grid
*
* \param pointToPoint the PointToPointHelper which is used
* to connect all of the nodes together
* in the grid
*/
PointToPointGridHelper (uint32_t nRows,
uint32_t nCols,
PointToPointHelper pointToPoint);
~PointToPointGridHelper ();
/**
* \param row the row address of the node desired
*
* \param col the column address of the node desired
*
* \returns a pointer to the node specified by the
* (row, col) address
*/
Ptr<Node> GetNode (uint32_t row, uint32_t col);
/**
* This returns an Ipv4 address at the node specified by
* the (row, col) address. Technically, a node will have
* multiple interfaces in the grid; therefore, it also has
* multiple Ipv4 addresses. This method only returns one of
* the addresses. If you picture the grid, the address returned
* is the left row device of all the nodes, except the left-most
* grid nodes, which returns the right row device.
*
* \param row the row address of the node desired
*
* \param col the column address of the node desired
*
* \returns Ipv4Address of one of the interfaces of the node
* specified by the (row, col) address
*/
Ipv4Address GetIpv4Address (uint32_t row, uint32_t col);
/**
* \param stack an InternetStackHelper which is used to install
* on every node in the grid
*/
void InstallStack (InternetStackHelper stack);
/**
* Assigns Ipv4 addresses to all the row and column interfaces
*
* \param rowIp the Ipv4AddressHelper used to assign Ipv4 addresses
* to all of the row interfaces in the grid
*
* \param colIp the Ipv4AddressHelper used to assign Ipv4 addresses
* to all of the row interfaces in the grid
*/
void AssignIpv4Addresses (Ipv4AddressHelper rowIp, Ipv4AddressHelper colIp);
/**
* Sets up the node canvas locations for every node in the grid.
* This is needed for use with the animation interface
*
* \param ulx upper left x value
* \param uly upper left y value
* \param lrx lower right x value
* \param lry lower right y value
*/
void BoundingBox (double ulx, double uly, double lrx, double lry);
private:
uint32_t m_xSize;
uint32_t m_ySize;
std::vector<NetDeviceContainer> m_rowDevices;
std::vector<NetDeviceContainer> m_colDevices;
std::vector<Ipv4InterfaceContainer> m_rowInterfaces;
std::vector<Ipv4InterfaceContainer> m_colInterfaces;
std::vector<NodeContainer> m_nodes;
};
} // namespace ns3
#endif /* POINT_TO_POINT_GRID_HELPER_H */
|