A Discrete-Event Network Simulator
API
uan-raw-example.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Hossam Khader <hossamkhader@gmail.com>
18  */
19 
20 #include "ns3/core-module.h"
21 #include "ns3/internet-module.h"
22 #include "ns3/node-container.h"
23 #include "ns3/mobility-helper.h"
24 #include "ns3/mobility-model.h"
25 #include "ns3/basic-energy-source-helper.h"
26 #include "ns3/energy-source-container.h"
27 #include "ns3/uan-helper.h"
28 #include "ns3/uan-channel.h"
29 #include "ns3/acoustic-modem-energy-model-helper.h"
30 #include "ns3/packet-socket-helper.h"
31 #include "ns3/packet-socket-address.h"
32 
33 using namespace ns3;
34 
44 NS_LOG_COMPONENT_DEFINE ("UanRawExample");
45 
46 
47 class UanExperiment
48 {
49 public:
50  UanExperiment ();
51 
55  void SetupPositions ();
56 
60  void SetupEnergy ();
61 
65  void SetupCommunications ();
66 
70  void SetupApplications ();
71 
75  void SendPackets ();
76 
83  void SendSinglePacket (Ptr<Node> node, Ptr<Packet> pkt, Mac8Address dst);
84 
89  void PrintReceivedPacket (Ptr<Socket> socket);
90 
94  void Prepare ();
95 
99  void Teardown ();
100 
101 private:
102  NodeContainer m_nodes;
103  std::map<Ptr<Node>, Ptr<Socket> > m_sockets;
104 };
105 
106 
108 {
109 }
110 
111 void
113 {
114  MobilityHelper mobilityHelper;
115  mobilityHelper.SetMobilityModel ("ns3::ConstantPositionMobilityModel");
116  mobilityHelper.Install (m_nodes);
117  m_nodes.Get (0)->GetObject<MobilityModel> ()->SetPosition (Vector (0, 0, 0));
118  m_nodes.Get (1)->GetObject<MobilityModel> ()->SetPosition (Vector (100, 0, 0));
119  m_nodes.Get (2)->GetObject<MobilityModel> ()->SetPosition (Vector (-100, 0, 0));
120 }
121 
122 void
124 {
125  BasicEnergySourceHelper energySourceHelper;
126  energySourceHelper.Set ("BasicEnergySourceInitialEnergyJ", DoubleValue (900000));
127  energySourceHelper.Install (m_nodes);
128 }
129 
130 void
132 {
133  Ptr<UanChannel> channel = CreateObject<UanChannel> ();
134  UanHelper uanHelper;
135  NetDeviceContainer netDeviceContainer = uanHelper.Install (m_nodes, channel);
136  EnergySourceContainer energySourceContainer;
137  NodeContainer::Iterator node = m_nodes.Begin ();
138  while (node != m_nodes.End ())
139  {
140  energySourceContainer.Add ((*node)->GetObject<EnergySourceContainer> ()->Get (0));
141  node++;
142  }
143  AcousticModemEnergyModelHelper acousticModemEnergyModelHelper;
144  acousticModemEnergyModelHelper.Install (netDeviceContainer, energySourceContainer);
145 }
146 
147 void
149 {
150  Address srcAddress;
151  while (socket->GetRxAvailable () > 0)
152  {
153  Ptr<Packet> packet = socket->RecvFrom (srcAddress);
154  PacketSocketAddress packetSocketAddress = PacketSocketAddress::ConvertFrom (srcAddress);
155  srcAddress = packetSocketAddress.GetPhysicalAddress ();
156  uint8_t energyReading;
157  packet->CopyData (&energyReading, 1);
158 
159  if(Mac8Address::IsMatchingType (srcAddress))
160  {
161  NS_LOG_UNCOND ( "Time: " << Simulator::Now ().GetHours () << "h" << " | Node: " <<
162  Mac8Address::ConvertFrom (srcAddress) << " | Energy: " <<
163  +energyReading << "%");
164  }
165  }
166 }
167 
168 void
170 {
171  NodeContainer::Iterator node = m_nodes.Begin ();
172  PacketSocketHelper packetSocketHelper;
173  while (node != m_nodes.End ())
174  {
175  packetSocketHelper.Install (*node);
176  PacketSocketAddress socketAddress;
177  socketAddress.SetSingleDevice ((*node)->GetDevice (0)->GetIfIndex ());
178  socketAddress.SetProtocol (0);
179  m_sockets[*node] = Socket::CreateSocket (*node, TypeId::LookupByName ("ns3::PacketSocketFactory"));
180  m_sockets[*node]->Bind ();
181  m_sockets[*node]->Connect (socketAddress);
182  m_sockets[*node]->SetRecvCallback (MakeCallback (&UanExperiment::PrintReceivedPacket, this));
183  node++;
184  }
185 }
186 
187 void
189 {
190  Ptr<UniformRandomVariable> uniformRandomVariable = CreateObject<UniformRandomVariable> ();
191 
192  NodeContainer::Iterator node = m_nodes.Begin ();
193  Mac8Address dst = Mac8Address::ConvertFrom ((*node)->GetDevice (0)->GetAddress ());
194  node++;
195  while (node != m_nodes.End ())
196  {
197  uint8_t energy = ((*node)->GetObject<EnergySourceContainer> ()->Get (0)->GetEnergyFraction ()) * 100;
198 
199  Ptr<Packet> pkt = Create<Packet> (&energy, 1);
200 
201  double time = uniformRandomVariable->GetValue (0, 60);
202  Simulator::Schedule (Seconds (time), &UanExperiment::SendSinglePacket, this, *node, pkt, dst);
203  node++;
204  }
206 }
207 
208 void
210 {
211  NS_LOG_UNCOND ( Simulator::Now ().GetHours () << "h" << " packet sent to " << dst );
212  PacketSocketAddress socketAddress;
213  socketAddress.SetSingleDevice (node->GetDevice (0)->GetIfIndex ());
214  socketAddress.SetPhysicalAddress (dst);
215  socketAddress.SetProtocol (0);
216  m_sockets[node]->SendTo (pkt, 0, socketAddress);
217 }
218 
219 void
221 {
222  m_nodes.Create (3);
223  SetupPositions ();
224  SetupEnergy ();
225  SetupCommunications ();
226  SetupApplications ();
227  SendPackets ();
228 }
229 
230 void
232 {
233  std::map<Ptr<Node>, Ptr<Socket> >::iterator socket;
234 
235  for (socket = m_sockets.begin (); socket != m_sockets.end (); socket++)
236  {
237  socket->second->Close ();
238  }
239 }
240 
241 int
242 main (int argc, char *argv[])
243 {
245  cmd.Parse (argc, argv);
246 
248  experiment.Prepare ();
249 
250  Simulator::Stop (Days (50));
251  Simulator::Run ();
253 
254  experiment.Teardown ();
255 
256  return 0;
257 }
UAN configuration helper.
Definition: uan-helper.h:40
static std::string PrintReceivedPacket(Address &from)
Holds a vector of ns3::EnergySource pointers.
void Add(EnergySourceContainer container)
void SendSinglePacket(Ptr< Node > node, Ptr< Packet > pkt, Ipv6Address dst)
Send a packet from one of the nodes.
std::vector< Ptr< Node > >::const_iterator Iterator
Node container iterator.
Ptr< NetDevice > GetDevice(uint32_t index) const
Retrieve the index-th NetDevice associated to this node.
Definition: node.cc:142
an address for a packet socket
static void Run(void)
Run the simulation.
Definition: simulator.cc:170
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:204
Assign AcousticModemEnergyModel to uan devices.
cmd
Definition: second.py:35
static bool IsMatchingType(const Address &address)
Check that a generic Address is compatible with Mac8Address.
Definition: mac8-address.cc:63
Give ns3::PacketSocket powers to ns3::Node.
void SetSingleDevice(uint32_t device)
Set the address to match only a specified NetDevice.
static void SetPosition(Ptr< Node > node, Vector position)
Definition: wifi-ap.cc:89
a polymophic address class
Definition: address.h:90
channel
Definition: third.py:92
Keep track of the current position and velocity of an object.
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1389
void Prepare()
Prepare the experiment.
Creates a BasicEnergySource object.
holds a vector of ns3::NetDevice pointers
void SetupEnergy()
Set the UAN nodes energy.
A class used for addressing MAC8 MAC&#39;s.
Definition: mac8-address.h:42
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
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 void Destroy(void)
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:134
Iterator Begin(void) const
Get an iterator which refers to the first EnergySource pointer in the container.
void Teardown()
Teardown the experiment.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetPhysicalAddress(const Address address)
Set the destination address.
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())
double GetValue(double min, double max)
Get the next random value, as a double in the specified range .
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
Time Hours(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1046
void PrintReceivedPacket(Ptr< Socket > socket)
Print the received packet.
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:193
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
Helper class used to assign positions and mobility models to nodes.
void experiment(std::string queue_disc_type)
EnergySourceContainer Install(Ptr< Node > node) const
static void Stop(void)
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:178
uint32_t CopyData(uint8_t *buffer, uint32_t size) const
Copy the packet contents to a byte buffer.
Definition: packet.cc:378
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1062
void Set(std::string name, const AttributeValue &v)
void SetProtocol(uint16_t protocol)
Set the protocol.
static PacketSocketAddress ConvertFrom(const Address &address)
Address GetPhysicalAddress(void) const
Get the destination address.
void SetupApplications()
Set the UAN nodes communication channels.
void Install(Ptr< Node > node) const
Aggregate an instance of a ns3::PacketSocketFactory onto the provided node.
This example shows the usage of UDP over 6LoWPAN to transfer data.
void SendPackets()
Send a packet from all the nodes.
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
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.
Time Days(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1038
void SetupPositions()
Set the UAN nodes position.
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
void SetupCommunications()
Set the UAN nodes communication channels.
static Mac8Address ConvertFrom(const Address &address)
Convert a generic address to a Mac8Address.
Definition: mac8-address.cc:54
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:824
virtual uint32_t GetRxAvailable(void) const =0
Return number of bytes which can be returned from one or multiple calls to Recv.
DeviceEnergyModelContainer Install(Ptr< NetDevice > device, Ptr< EnergySource > source) const