A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
wireless-animation.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License version 2 as
5  * published by the Free Software Foundation;
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * Author: Vikas Pushkar (Adapted from third.cc)
17  */
18 
19 
20 #include "ns3/core-module.h"
21 #include "ns3/point-to-point-module.h"
22 #include "ns3/csma-module.h"
23 #include "ns3/network-module.h"
24 #include "ns3/applications-module.h"
25 #include "ns3/wifi-module.h"
26 #include "ns3/mobility-module.h"
27 #include "ns3/internet-module.h"
28 #include "ns3/netanim-module.h"
29 #include "ns3/basic-energy-source.h"
30 #include "ns3/simple-device-energy-model.h"
31 
32 
33 
34 using namespace ns3;
35 
36 NS_LOG_COMPONENT_DEFINE ("WirelessAnimationExample");
37 
38 int
39 main (int argc, char *argv[])
40 {
41  uint32_t nWifi = 20;
42  CommandLine cmd;
43  cmd.AddValue ("nWifi", "Number of wifi STA devices", nWifi);
44 
45 
46  cmd.Parse (argc,argv);
47  NodeContainer allNodes;
48  NodeContainer wifiStaNodes;
49  wifiStaNodes.Create (nWifi);
50  allNodes.Add (wifiStaNodes);
51  NodeContainer wifiApNode ;
52  wifiApNode.Create (1);
53  allNodes.Add (wifiApNode);
54 
57  phy.SetChannel (channel.Create ());
58 
60  wifi.SetRemoteStationManager ("ns3::AarfWifiManager");
61 
63 
64  Ssid ssid = Ssid ("ns-3-ssid");
65  mac.SetType ("ns3::StaWifiMac",
66  "Ssid", SsidValue (ssid),
67  "ActiveProbing", BooleanValue (false));
68 
69  NetDeviceContainer staDevices;
70  staDevices = wifi.Install (phy, mac, wifiStaNodes);
71  mac.SetType ("ns3::ApWifiMac",
72  "Ssid", SsidValue (ssid));
73 
74  NetDeviceContainer apDevices;
75  apDevices = wifi.Install (phy, mac, wifiApNode);
76 
77 
78  NodeContainer p2pNodes;
79  p2pNodes.Add (wifiApNode);
80  p2pNodes.Create (1);
81  allNodes.Add (p2pNodes.Get (1));
82 
84  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
85  pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
86 
87  NetDeviceContainer p2pDevices;
88  p2pDevices = pointToPoint.Install (p2pNodes);
89 
90  NodeContainer csmaNodes;
91  csmaNodes.Add (p2pNodes.Get (1));
92  csmaNodes.Create (1);
93  allNodes.Add (csmaNodes.Get (1));
94 
95  CsmaHelper csma;
96  csma.SetChannelAttribute ("DataRate", StringValue ("100Mbps"));
97  csma.SetChannelAttribute ("Delay", TimeValue (NanoSeconds (6560)));
98 
99  NetDeviceContainer csmaDevices;
100  csmaDevices = csma.Install (csmaNodes);
101 
102  // Mobility
103 
104  MobilityHelper mobility;
105  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
106  "MinX", DoubleValue (10.0),
107  "MinY", DoubleValue (10.0),
108  "DeltaX", DoubleValue (5.0),
109  "DeltaY", DoubleValue (2.0),
110  "GridWidth", UintegerValue (5),
111  "LayoutType", StringValue ("RowFirst"));
112  mobility.SetMobilityModel ("ns3::RandomWalk2dMobilityModel",
113  "Bounds", RectangleValue (Rectangle (-50, 50, -25, 50)));
114  mobility.Install (wifiStaNodes);
115  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
116  mobility.Install (wifiApNode);
117  AnimationInterface::SetConstantPosition (p2pNodes.Get (1), 10, 30);
118  AnimationInterface::SetConstantPosition (csmaNodes.Get (1), 10, 33);
119 
120  Ptr<BasicEnergySource> energySource = CreateObject<BasicEnergySource>();
121  Ptr<SimpleDeviceEnergyModel> energyModel = CreateObject<SimpleDeviceEnergyModel>();
122 
123  energySource->SetInitialEnergy (300);
124  energyModel->SetEnergySource (energySource);
125  energySource->AppendDeviceEnergyModel (energyModel);
126  energyModel->SetCurrentA (20);
127 
128  // aggregate energy source to node
129  wifiApNode.Get (0)->AggregateObject (energySource);
130 
131  // Install internet stack
132 
134  stack.Install (allNodes);
135 
136  // Install Ipv4 addresses
137 
139  address.SetBase ("10.1.1.0", "255.255.255.0");
140  Ipv4InterfaceContainer p2pInterfaces;
141  p2pInterfaces = address.Assign (p2pDevices);
142  address.SetBase ("10.1.2.0", "255.255.255.0");
143  Ipv4InterfaceContainer csmaInterfaces;
144  csmaInterfaces = address.Assign (csmaDevices);
145  address.SetBase ("10.1.3.0", "255.255.255.0");
146  Ipv4InterfaceContainer staInterfaces;
147  staInterfaces = address.Assign (staDevices);
148  Ipv4InterfaceContainer apInterface;
149  apInterface = address.Assign (apDevices);
150 
151  // Install applications
152 
154  ApplicationContainer serverApps = echoServer.Install (csmaNodes.Get (1));
155  serverApps.Start (Seconds (1.0));
156  serverApps.Stop (Seconds (15.0));
157  UdpEchoClientHelper echoClient (csmaInterfaces.GetAddress (1), 9);
158  echoClient.SetAttribute ("MaxPackets", UintegerValue (10));
159  echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.)));
160  echoClient.SetAttribute ("PacketSize", UintegerValue (1024));
161  ApplicationContainer clientApps = echoClient.Install (wifiStaNodes);
162  clientApps.Start (Seconds (2.0));
163  clientApps.Stop (Seconds (15.0));
164 
166  Simulator::Stop (Seconds (15.0));
167  AnimationInterface::SetNodeDescription (wifiApNode, "AP"); // Optional
168  AnimationInterface::SetNodeDescription (wifiStaNodes, "STA"); //b Optional
169  AnimationInterface::SetNodeDescription (csmaNodes, "CSMA"); // Optional
170  AnimationInterface::SetNodeColor (wifiApNode, 0, 255, 0); // Optional
171  AnimationInterface::SetNodeColor (wifiStaNodes, 255, 0, 0); // Optional
172  AnimationInterface::SetNodeColor (csmaNodes, 0, 0, 255); // Optional
173 
174  AnimationInterface anim ("wireless-animation.xml"); // Mandatory
175 
176  anim.EnablePacketMetadata (); // Optional
177  anim.EnableIpv4RouteTracking ("routingtable-wireless.xml", Seconds (0), Seconds (5), Seconds (0.25)); //Optional
178  Simulator::Run ();
180  return 0;
181 }
holds a vector of ns3::Application pointers.
tuple pointToPoint
Definition: first.py:28
void SetChannelAttribute(std::string n1, const AttributeValue &v1)
Definition: csma-helper.cc:69
Hold a bool native type.
Definition: boolean.h:38
holds a vector of std::pair of Ptr and interface index.
Ptr< YansWifiChannel > Create(void) const
void SetRemoteStationManager(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:73
static void PopulateRoutingTables(void)
Build a routing database and initialize the routing tables of the nodes in the simulation.
hold variables of type string
Definition: string.h:18
Make it easy to create and manage PHY objects for the yans model.
static YansWifiChannelHelper Default(void)
Create a channel helper in a default working state.
NetDeviceContainer Install(NodeContainer c)
virtual void SetType(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
tuple echoServer
Definition: first.py:42
static void SetNodeColor(Ptr< Node > n, uint8_t r, uint8_t g, uint8_t b)
Helper function to set the node color.
Create an application which sends a UDP packet and waits for an echo of this packet.
static void Run(void)
Run the simulation until one of:
Definition: simulator.cc:157
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:170
aggregate IP/TCP/UDP functionality to existing Nodes.
NetDeviceContainer Install(Ptr< Node > node) const
This method creates an ns3::CsmaChannel with the attributes configured by CsmaHelper::SetChannelAttri...
Definition: csma-helper.cc:215
Build a set of PointToPointNetDevice objects.
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
void SetDeviceAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each NetDevice created by the helper.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:88
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:102
tuple clientApps
Definition: first.py:53
ApplicationContainer Install(Ptr< Node > node) const
Create a UdpEchoServerApplication on the specified Node.
virtual void SetEnergySource(Ptr< EnergySource > source)
Sets pointer to EnergySouce installed on node.
static void SetConstantPosition(Ptr< Node > n, double x, double y, double z=0)
Helper function to set Constant Position for a given node.
hold objects of type ns3::Rectangle
void SetChannel(Ptr< YansWifiChannel > channel)
Create a server application which waits for input UDP packets and sends them back to the original sen...
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
hold objects of type ns3::Time
Definition: nstime.h:1008
Hold an unsigned integer type.
Definition: uinteger.h:46
holds a vector of ns3::NetDevice pointers
static void SetNodeDescription(Ptr< Node > n, std::string descr)
Helper function to set a brief description for a given node.
static NqosWifiMacHelper Default(void)
Create a mac helper in a default working state.
AnimationInterface & EnableIpv4RouteTracking(std::string fileName, Time startTime, Time stopTime, Time pollInterval=Seconds(5))
Enable tracking of the Ipv4 routing table for all Nodes.
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
void AggregateObject(Ptr< Object > other)
Definition: object.cc:242
create non QoS-enabled MAC layers for a ns3::WifiNetDevice.
Parse command-line arguments.
Definition: command-line.h:177
static void Destroy(void)
Every event scheduled by the Simulator::insertAtDestroy method is invoked.
Definition: simulator.cc:121
tuple echoClient
Definition: first.py:48
tuple serverApps
Definition: first.py:44
keep track of a set of node pointers.
void SetMobilityModel(std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue())
void Install(std::string nodeName) const
Aggregate implementations of the ns3::Ipv4, ns3::Ipv6, ns3::Udp, and ns3::Tcp classes onto the provid...
manage and create wifi channel objects for the yans model.
void EnablePacketMetadata(bool enable=true)
Enable Packet metadata.
tuple stack
Definition: first.py:34
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:35
build a set of CsmaNetDevice objects
Definition: csma-helper.h:46
int main(int argc, char *argv[])
void SetChannelAttribute(std::string name, const AttributeValue &value)
Set an attribute value to be propagated to each Channel created by the helper.
Helper class used to assign positions and mobility models to nodes.
void Stop(Time stop)
Arrange for all of the Applications in this container to Stop() at the Time given as a parameter...
Ipv4InterfaceContainer Assign(const NetDeviceContainer &c)
Assign IP addresses to the net devices specified in the container based on the current network prefix...
void Add(NodeContainer other)
Append the contents of another NodeContainer to the end of this container.
void AddValue(const std::string &name, const std::string &help, T &value)
Add a program argument, assigning to POD.
Definition: command-line.h:435
static void Stop(void)
If an event invokes this method, it will be the last event scheduled by the Simulator::run method bef...
Definition: simulator.cc:165
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
hold objects of type ns3::Ssid
Interface to network animator.
void Parse(int argc, char *argv[])
Parse the program arguments.
A helper class to make life easier while doing simple IPv4 address assignment in scripts.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
tuple address
Definition: first.py:37
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
Hold a floating point type.
Definition: double.h:41
a 2d rectangle
Definition: rectangle.h:33
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
static WifiHelper Default(void)
Definition: wifi-helper.cc:65