A Discrete-Event Network Simulator
API
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;
43  cmd.AddValue ("nWifi", "Number of wifi STA devices", nWifi);
44 
45 
46  cmd.Parse (argc,argv);
47  NodeContainer allNodes;
49  wifiStaNodes.Create (nWifi);
50  allNodes.Add (wifiStaNodes);
52  wifiApNode.Create (1);
53  allNodes.Add (wifiApNode);
54 
57  phy.SetChannel (channel.Create ());
58 
60  wifi.SetRemoteStationManager ("ns3::AarfWifiManager");
61 
63  Ssid ssid = Ssid ("ns-3-ssid");
64  mac.SetType ("ns3::StaWifiMac",
65  "Ssid", SsidValue (ssid),
66  "ActiveProbing", BooleanValue (false));
67 
69  staDevices = wifi.Install (phy, mac, wifiStaNodes);
70  mac.SetType ("ns3::ApWifiMac",
71  "Ssid", SsidValue (ssid));
72 
74  apDevices = wifi.Install (phy, mac, wifiApNode);
75 
76 
78  p2pNodes.Add (wifiApNode);
79  p2pNodes.Create (1);
80  allNodes.Add (p2pNodes.Get (1));
81 
83  pointToPoint.SetDeviceAttribute ("DataRate", StringValue ("5Mbps"));
84  pointToPoint.SetChannelAttribute ("Delay", StringValue ("2ms"));
85 
87  p2pDevices = pointToPoint.Install (p2pNodes);
88 
90  csmaNodes.Add (p2pNodes.Get (1));
91  csmaNodes.Create (1);
92  allNodes.Add (csmaNodes.Get (1));
93 
95  csma.SetChannelAttribute ("DataRate", StringValue ("100Mbps"));
96  csma.SetChannelAttribute ("Delay", TimeValue (NanoSeconds (6560)));
97 
99  csmaDevices = csma.Install (csmaNodes);
100 
101  // Mobility
102 
104  mobility.SetPositionAllocator ("ns3::GridPositionAllocator",
105  "MinX", DoubleValue (10.0),
106  "MinY", DoubleValue (10.0),
107  "DeltaX", DoubleValue (5.0),
108  "DeltaY", DoubleValue (2.0),
109  "GridWidth", UintegerValue (5),
110  "LayoutType", StringValue ("RowFirst"));
111  mobility.SetMobilityModel ("ns3::RandomWalk2dMobilityModel",
112  "Bounds", RectangleValue (Rectangle (-50, 50, -25, 50)));
113  mobility.Install (wifiStaNodes);
114  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
115  mobility.Install (wifiApNode);
116  AnimationInterface::SetConstantPosition (p2pNodes.Get (1), 10, 30);
117  AnimationInterface::SetConstantPosition (csmaNodes.Get (1), 10, 33);
118 
119  Ptr<BasicEnergySource> energySource = CreateObject<BasicEnergySource>();
120  Ptr<SimpleDeviceEnergyModel> energyModel = CreateObject<SimpleDeviceEnergyModel>();
121 
122  energySource->SetInitialEnergy (300);
123  energyModel->SetEnergySource (energySource);
124  energySource->AppendDeviceEnergyModel (energyModel);
125  energyModel->SetCurrentA (20);
126 
127  // aggregate energy source to node
128  wifiApNode.Get (0)->AggregateObject (energySource);
129 
130  // Install internet stack
131 
133  stack.Install (allNodes);
134 
135  // Install Ipv4 addresses
136 
138  address.SetBase ("10.1.1.0", "255.255.255.0");
140  p2pInterfaces = address.Assign (p2pDevices);
141  address.SetBase ("10.1.2.0", "255.255.255.0");
143  csmaInterfaces = address.Assign (csmaDevices);
144  address.SetBase ("10.1.3.0", "255.255.255.0");
145  Ipv4InterfaceContainer staInterfaces;
146  staInterfaces = address.Assign (staDevices);
147  Ipv4InterfaceContainer apInterface;
148  apInterface = address.Assign (apDevices);
149 
150  // Install applications
151 
153  ApplicationContainer serverApps = echoServer.Install (csmaNodes.Get (1));
154  serverApps.Start (Seconds (1.0));
155  serverApps.Stop (Seconds (15.0));
156  UdpEchoClientHelper echoClient (csmaInterfaces.GetAddress (1), 9);
157  echoClient.SetAttribute ("MaxPackets", UintegerValue (10));
158  echoClient.SetAttribute ("Interval", TimeValue (Seconds (1.)));
159  echoClient.SetAttribute ("PacketSize", UintegerValue (1024));
160  ApplicationContainer clientApps = echoClient.Install (wifiStaNodes);
161  clientApps.Start (Seconds (2.0));
162  clientApps.Stop (Seconds (15.0));
163 
165  Simulator::Stop (Seconds (15.0));
166 
167  AnimationInterface anim ("wireless-animation.xml"); // Mandatory
168  for (uint32_t i = 0; i < wifiStaNodes.GetN (); ++i)
169  {
170  anim.UpdateNodeDescription (wifiStaNodes.Get (i), "STA"); // Optional
171  anim.UpdateNodeColor (wifiStaNodes.Get (i), 255, 0, 0); // Optional
172  }
173  for (uint32_t i = 0; i < wifiApNode.GetN (); ++i)
174  {
175  anim.UpdateNodeDescription (wifiApNode.Get (i), "AP"); // Optional
176  anim.UpdateNodeColor (wifiApNode.Get (i), 0, 255, 0); // Optional
177  }
178  for (uint32_t i = 0; i < csmaNodes.GetN (); ++i)
179  {
180  anim.UpdateNodeDescription (csmaNodes.Get (i), "CSMA"); // Optional
181  anim.UpdateNodeColor (csmaNodes.Get (i), 0, 0, 255); // Optional
182  }
183 
184  anim.EnablePacketMetadata (); // Optional
185  anim.EnableIpv4RouteTracking ("routingtable-wireless.xml", Seconds (0), Seconds (5), Seconds (0.25)); //Optional
186  anim.EnableWifiMacCounters (Seconds (0), Seconds (10)); //Optional
187  anim.EnableWifiPhyCounters (Seconds (0), Seconds (10)); //Optional
188  Simulator::Run ();
190  return 0;
191 }
tuple channel
Definition: third.py:85
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
AttributeValue implementation for Boolean.
Definition: boolean.h:34
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:683
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:41
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)
void AggregateObject(Ptr< Object > other)
Aggregate two Objects together.
Definition: object.cc:252
tuple echoServer
Definition: first.py:43
Create an application which sends a UDP packet and waits for an echo of this packet.
static void Run(void)
Run the simulation.
Definition: simulator.cc:201
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
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
tuple nWifi
Definition: third.py:52
tuple csmaNodes
Definition: second.py:53
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:231
tuple cmd
Definition: second.py:35
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:712
tuple clientApps
Definition: first.py:54
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.
uint32_t GetN(void) const
Get the number of Ptr stored in this container.
AttributeValue implementation for Rectangle.
Definition: rectangle.h:97
tuple csmaDevices
Definition: second.py:67
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.
tuple mobility
Definition: third.py:101
tuple phy
Definition: third.py:86
tuple csmaInterfaces
Definition: second.py:78
AttributeValue implementation for Time.
Definition: nstime.h:957
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:919
Hold an unsigned integer type.
Definition: uinteger.h:44
tuple p2pInterfaces
Definition: second.py:75
holds a vector of ns3::NetDevice pointers
tuple staDevices
Definition: third.py:96
tuple mac
Definition: third.py:92
void Start(Time start)
Arrange for all of the Applications in this container to Start() at the Time given as a parameter...
tuple p2pNodes
Definition: second.py:50
Parse command-line arguments.
Definition: command-line.h:205
tuple p2pDevices
Definition: second.py:61
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:165
tuple echoClient
Definition: first.py:49
tuple serverApps
Definition: first.py:45
tuple wifiApNode
Definition: third.py:83
Every class exported by the ns3 library is enclosed in the ns3 namespace.
tuple apDevices
Definition: third.py:99
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...
tuple ssid
Definition: third.py:93
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
tuple stack
Definition: first.py:34
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:38
build a set of CsmaNetDevice objects
Definition: csma-helper.h:46
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(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue())
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:495
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:209
Ptr< Node > Get(uint32_t i) const
Get the Ptr stored in this container at a given index.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:895
AttributeValue implementation for Ssid.
Definition: ssid.h:95
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.
tuple wifi
Definition: third.py:89
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...
This class can be used to hold variables of floating point type such as 'double' or 'float'...
Definition: double.h:41
a 2d rectangle
Definition: rectangle.h:34
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
tuple csma
Definition: second.py:63
Ipv4Address GetAddress(uint32_t i, uint32_t j=0) const
tuple wifiStaNodes
Definition: third.py:81