A Discrete-Event Network Simulator
API
energy-model-example.cc
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 Network Security Lab, University of Washington, Seattle.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
19  */
20 
21 #include <iostream>
22 #include <fstream>
23 #include <vector>
24 #include <string>
25 #include "ns3/core-module.h"
26 #include "ns3/network-module.h"
27 #include "ns3/mobility-module.h"
28 #include "ns3/config-store-module.h"
29 #include "ns3/energy-module.h"
30 #include "ns3/internet-module.h"
31 #include "ns3/yans-wifi-helper.h"
32 #include "ns3/wifi-radio-energy-model-helper.h"
33 
34 using namespace ns3;
35 
36 NS_LOG_COMPONENT_DEFINE ("EnergyExample");
37 
38 static inline std::string
40 {
42 
43  std::ostringstream oss;
44  oss << "--\nReceived one packet! Socket: " << iaddr.GetIpv4 ()
45  << " port: " << iaddr.GetPort ()
46  << " at time = " << Simulator::Now ().GetSeconds ()
47  << "\n--";
48 
49  return oss.str ();
50 }
51 
57 void
59 {
60  Ptr<Packet> packet;
61  Address from;
62  while ((packet = socket->RecvFrom (from)))
63  {
64  if (packet->GetSize () > 0)
65  {
67  }
68  }
69 }
70 
80 static void
81 GenerateTraffic (Ptr<Socket> socket, uint32_t pktSize, Ptr<Node> n,
82  uint32_t pktCount, Time pktInterval)
83 {
84  if (pktCount > 0)
85  {
86  socket->Send (Create<Packet> (pktSize));
87  Simulator::Schedule (pktInterval, &GenerateTraffic, socket, pktSize, n,
88  pktCount - 1, pktInterval);
89  }
90  else
91  {
92  socket->Close ();
93  }
94 }
95 
97 void
98 RemainingEnergy (double oldValue, double remainingEnergy)
99 {
100  NS_LOG_UNCOND (Simulator::Now ().GetSeconds ()
101  << "s Current remaining energy = " << remainingEnergy << "J");
102 }
103 
105 void
106 TotalEnergy (double oldValue, double totalEnergy)
107 {
108  NS_LOG_UNCOND (Simulator::Now ().GetSeconds ()
109  << "s Total energy consumed by radio = " << totalEnergy << "J");
110 }
111 
112 int
113 main (int argc, char *argv[])
114 {
115  /*
116  LogComponentEnable ("EnergySource", LOG_LEVEL_DEBUG);
117  LogComponentEnable ("BasicEnergySource", LOG_LEVEL_DEBUG);
118  LogComponentEnable ("DeviceEnergyModel", LOG_LEVEL_DEBUG);
119  LogComponentEnable ("WifiRadioEnergyModel", LOG_LEVEL_DEBUG);
120  */
121 
123 
124  std::string phyMode ("DsssRate1Mbps");
125  double Prss = -80; // dBm
126  uint32_t PpacketSize = 200; // bytes
127  bool verbose = false;
128 
129  // simulation parameters
130  uint32_t numPackets = 10000; // number of packets to send
131  double interval = 1; // seconds
132  double startTime = 0.0; // seconds
133  double distanceToRx = 100.0; // meters
134  /*
135  * This is a magic number used to set the transmit power, based on other
136  * configuration.
137  */
138  double offset = 81;
139 
141  cmd.AddValue ("phyMode", "Wifi Phy mode", phyMode);
142  cmd.AddValue ("Prss", "Intended primary RSS (dBm)", Prss);
143  cmd.AddValue ("PpacketSize", "size of application packet sent", PpacketSize);
144  cmd.AddValue ("numPackets", "Total number of packets to send", numPackets);
145  cmd.AddValue ("startTime", "Simulation start time", startTime);
146  cmd.AddValue ("distanceToRx", "X-Axis distance between nodes", distanceToRx);
147  cmd.AddValue ("verbose", "Turn on all device log components", verbose);
148  cmd.Parse (argc, argv);
149 
150  // Convert to time object
151  Time interPacketInterval = Seconds (interval);
152 
153  // disable fragmentation for frames below 2200 bytes
154  Config::SetDefault ("ns3::WifiRemoteStationManager::FragmentationThreshold",
155  StringValue ("2200"));
156  // turn off RTS/CTS for frames below 2200 bytes
157  Config::SetDefault ("ns3::WifiRemoteStationManager::RtsCtsThreshold",
158  StringValue ("2200"));
159  // Fix non-unicast data rate to be the same as that of unicast
160  Config::SetDefault ("ns3::WifiRemoteStationManager::NonUnicastMode",
161  StringValue (phyMode));
162 
163  NodeContainer c;
164  c.Create (2); // create 2 nodes
165  NodeContainer networkNodes;
166  networkNodes.Add (c.Get (0));
167  networkNodes.Add (c.Get (1));
168 
169  // The below set of helpers will help us to put together the wifi NICs we want
171  if (verbose)
172  {
173  wifi.EnableLogComponents ();
174  }
176 
178  /***************************************************************************/
180  wifiPhy.Set ("RxGain", DoubleValue (-10));
181  wifiPhy.Set ("TxGain", DoubleValue (offset + Prss));
182  wifiPhy.Set ("CcaMode1Threshold", DoubleValue (0.0));
183  /***************************************************************************/
184 
186  YansWifiChannelHelper wifiChannel;
187  wifiChannel.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
188  wifiChannel.AddPropagationLoss ("ns3::FriisPropagationLossModel");
189  // create wifi channel
190  Ptr<YansWifiChannel> wifiChannelPtr = wifiChannel.Create ();
191  wifiPhy.SetChannel (wifiChannelPtr);
192 
194  // Add a MAC and disable rate control
195  WifiMacHelper wifiMac;
196  wifi.SetRemoteStationManager ("ns3::ConstantRateWifiManager", "DataMode",
197  StringValue (phyMode), "ControlMode",
198  StringValue (phyMode));
199  // Set it to ad-hoc mode
200  wifiMac.SetType ("ns3::AdhocWifiMac");
201 
203  NetDeviceContainer devices = wifi.Install (wifiPhy, wifiMac, networkNodes);
204 
207  Ptr<ListPositionAllocator> positionAlloc = CreateObject<ListPositionAllocator> ();
208  positionAlloc->Add (Vector (0.0, 0.0, 0.0));
209  positionAlloc->Add (Vector (2 * distanceToRx, 0.0, 0.0));
210  mobility.SetPositionAllocator (positionAlloc);
211  mobility.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
212  mobility.Install (c);
213 
215  /***************************************************************************/
216  /* energy source */
217  BasicEnergySourceHelper basicSourceHelper;
218  // configure energy source
219  basicSourceHelper.Set ("BasicEnergySourceInitialEnergyJ", DoubleValue (0.1));
220  // install source
221  EnergySourceContainer sources = basicSourceHelper.Install (c);
222  /* device energy model */
223  WifiRadioEnergyModelHelper radioEnergyHelper;
224  // configure radio energy model
225  radioEnergyHelper.Set ("TxCurrentA", DoubleValue (0.0174));
226  // install device model
227  DeviceEnergyModelContainer deviceModels = radioEnergyHelper.Install (devices, sources);
228  /***************************************************************************/
229 
231  InternetStackHelper internet;
232  internet.Install (networkNodes);
233 
234  Ipv4AddressHelper ipv4;
235  NS_LOG_INFO ("Assign IP Addresses.");
236  ipv4.SetBase ("10.1.1.0", "255.255.255.0");
237  Ipv4InterfaceContainer i = ipv4.Assign (devices);
238 
239  TypeId tid = TypeId::LookupByName ("ns3::UdpSocketFactory");
240  Ptr<Socket> recvSink = Socket::CreateSocket (networkNodes.Get (1), tid); // node 1, receiver
242  recvSink->Bind (local);
244 
245  Ptr<Socket> source = Socket::CreateSocket (networkNodes.Get (0), tid); // node 0, sender
247  source->SetAllowBroadcast (true);
248  source->Connect (remote);
249 
251  /***************************************************************************/
252  // all sources are connected to node 1
253  // energy source
254  Ptr<BasicEnergySource> basicSourcePtr = DynamicCast<BasicEnergySource> (sources.Get (1));
255  basicSourcePtr->TraceConnectWithoutContext ("RemainingEnergy", MakeCallback (&RemainingEnergy));
256  // device energy model
257  Ptr<DeviceEnergyModel> basicRadioModelPtr =
258  basicSourcePtr->FindDeviceEnergyModels ("ns3::WifiRadioEnergyModel").Get (0);
259  NS_ASSERT (basicRadioModelPtr != NULL);
260  basicRadioModelPtr->TraceConnectWithoutContext ("TotalEnergyConsumption", MakeCallback (&TotalEnergy));
261  /***************************************************************************/
262 
263 
265  // start traffic
266  Simulator::Schedule (Seconds (startTime), &GenerateTraffic, source, PpacketSize,
267  networkNodes.Get (0), numPackets, interPacketInterval);
268 
269  Simulator::Stop (Seconds (10.0));
270  Simulator::Run ();
271 
272  for (DeviceEnergyModelContainer::Iterator iter = deviceModels.Begin (); iter != deviceModels.End (); iter ++)
273  {
274  double energyConsumed = (*iter)->GetTotalEnergyConsumption ();
275  NS_LOG_UNCOND ("End of simulation (" << Simulator::Now ().GetSeconds ()
276  << "s) Total energy consumed by radio = " << energyConsumed << "J");
277  NS_ASSERT (energyConsumed <= 0.1);
278  }
279 
281 
282  return 0;
283 }
void AddPropagationLoss(std::string name, 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())
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:134
DeviceEnergyModelContainer Install(Ptr< NetDevice > device, Ptr< EnergySource > source) const
std::vector< Ptr< DeviceEnergyModel > >::const_iterator Iterator
static std::string PrintReceivedPacket(Address &from)
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Prefix all trace prints with simulation node.
Definition: log.h:117
Assign WifiRadioEnergyModel to wifi devices.
an Inet address class
Ipv4Address GetIpv4(void) const
static Ipv4Address GetAny(void)
Holds a vector of ns3::EnergySource pointers.
holds a vector of std::pair of Ptr<Ipv4> 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:701
Hold variables of type string.
Definition: string.h:41
virtual bool SetAllowBroadcast(bool allowBroadcast)=0
Configure whether broadcast datagram transmissions are allowed.
Make it easy to create and manage PHY objects for the yans model.
static void GenerateTraffic(Ptr< Socket > socket, uint32_t pktSize, Ptr< Node > n, uint32_t pktCount, Time pktInterval)
void ReceivePacket(Ptr< Socket > socket)
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
static void Run(void)
Run the simulation.
Definition: simulator.cc:226
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
aggregate IP/TCP/UDP functionality to existing Nodes.
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:831
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:278
cmd
Definition: second.py:35
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
helps to create WifiNetDevice objects
Definition: wifi-helper.h:212
Holds a vector of ns3::DeviceEnergyModel pointers.
a polymophic address class
Definition: address.h:90
mobility
Definition: third.py:101
virtual void SetStandard(WifiPhyStandard standard)
Definition: wifi-helper.cc:724
void SetChannel(Ptr< YansWifiChannel > channel)
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:355
void TotalEnergy(double oldValue, double totalEnergy)
Trace function for total energy consumption at node.
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void LogComponentEnable(char const *name, enum LogLevel level)
Enable the logging output associated with that log component.
Definition: log.cc:369
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1381
double startTime
LOG_INFO and above.
Definition: log.h:104
Creates a BasicEnergySource object.
holds a vector of ns3::NetDevice pointers
void RemainingEnergy(double oldValue, double remainingEnergy)
Trace function for remaining energy at node.
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const
Definition: wifi-helper.cc:730
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
Definition: socket.cc:71
Parse command-line arguments.
Definition: command-line.h:213
static Ipv4Address GetBroadcast(void)
static void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:190
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
Ptr< DeviceEnergyModel > Get(uint32_t i) const
Get the i-th Ptr<DeviceEnergyModel> stored in this container.
Iterator Begin(void) const
Get an iterator which refers to the first DeviceEnergyModel pointer in the container.
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:293
Prefix all trace prints with simulation time.
Definition: log.h:116
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
keep track of a set of node pointers.
DSSS PHY (Clause 15) and HR/DSSS PHY (Clause 18)
void Set(std::string name, const AttributeValue &v)
EnergySourceContainer Install(Ptr< Node > node) const
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...
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
manage and create wifi channel objects for the yans model.
create MAC layers for a ns3::WifiNetDevice.
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:249
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())
LogLevel
Logging severity classes and levels.
Definition: log.h:91
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
wifi
Definition: third.py:89
Helper class used to assign positions and mobility models to nodes.
static void EnableLogComponents(void)
Helper to enable all WifiNetDevice log components with one statement.
Definition: wifi-helper.cc:779
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:578
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:234
Ptr< Node > Get(uint32_t i) const
Get the Ptr<Node> stored in this container at a given index.
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1007
void SetDefault(std::string name, const AttributeValue &value)
Definition: config.cc:782
Iterator End(void) const
Get an iterator which refers to the last DeviceEnergyModel pointer in the container.
void Set(std::string name, const AttributeValue &v)
void Add(Vector v)
Add a position to the list of positions.
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.
DeviceEnergyModelContainer FindDeviceEnergyModels(TypeId tid)
uint16_t GetPort(void) const
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
virtual Ptr< Packet > RecvFrom(uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
Read a single packet from the socket and retrieve the sender address.
void SetPropagationDelay(std::string name, 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())
devices
Definition: first.py:32
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...
virtual int Close(void)=0
Close a socket.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
a unique identifier for an interface.
Definition: type-id.h:58
void SetBase(Ipv4Address network, Ipv4Mask mask, Ipv4Address base="0.0.0.1")
Set the base network number, network mask and base address.
bool verbose
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:824