A Discrete-Event Network Simulator
API
uan-raw-example.cc
Go to the documentation of this file.
1 /*
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: Hossam Khader <hossamkhader@gmail.com>
17  */
18 
19 #include "ns3/acoustic-modem-energy-model-helper.h"
20 #include "ns3/basic-energy-source-helper.h"
21 #include "ns3/core-module.h"
22 #include "ns3/energy-source-container.h"
23 #include "ns3/internet-module.h"
24 #include "ns3/mobility-helper.h"
25 #include "ns3/mobility-model.h"
26 #include "ns3/node-container.h"
27 #include "ns3/packet-socket-address.h"
28 #include "ns3/packet-socket-helper.h"
29 #include "ns3/uan-channel.h"
30 #include "ns3/uan-helper.h"
31 
32 using namespace ns3;
33 
43 NS_LOG_COMPONENT_DEFINE("UanRawExample");
44 
45 class UanExperiment
46 {
47  public:
49 
54 
58  void SetupEnergy();
59 
64 
69 
73  void SendPackets();
74 
81  void SendSinglePacket(Ptr<Node> node, Ptr<Packet> pkt, Mac8Address dst);
82 
88 
92  void Prepare();
93 
97  void Teardown();
98 
99  private:
100  NodeContainer m_nodes;
101  std::map<Ptr<Node>, Ptr<Socket>> m_sockets;
102 };
103 
105 {
106 }
107 
108 void
110 {
111  MobilityHelper mobilityHelper;
112  mobilityHelper.SetMobilityModel("ns3::ConstantPositionMobilityModel");
113  mobilityHelper.Install(m_nodes);
114  m_nodes.Get(0)->GetObject<MobilityModel>()->SetPosition(Vector(0, 0, 0));
115  m_nodes.Get(1)->GetObject<MobilityModel>()->SetPosition(Vector(100, 0, 0));
116  m_nodes.Get(2)->GetObject<MobilityModel>()->SetPosition(Vector(-100, 0, 0));
117 }
118 
119 void
121 {
122  BasicEnergySourceHelper energySourceHelper;
123  energySourceHelper.Set("BasicEnergySourceInitialEnergyJ", DoubleValue(900000));
124  energySourceHelper.Install(m_nodes);
125 }
126 
127 void
129 {
130  Ptr<UanChannel> channel = CreateObject<UanChannel>();
131  UanHelper uanHelper;
132  NetDeviceContainer netDeviceContainer = uanHelper.Install(m_nodes, channel);
133  EnergySourceContainer energySourceContainer;
134  auto node = m_nodes.Begin();
135  while (node != m_nodes.End())
136  {
137  energySourceContainer.Add((*node)->GetObject<EnergySourceContainer>()->Get(0));
138  node++;
139  }
140  AcousticModemEnergyModelHelper acousticModemEnergyModelHelper;
141  acousticModemEnergyModelHelper.Install(netDeviceContainer, energySourceContainer);
142 }
143 
144 void
146 {
147  Address srcAddress;
148  while (socket->GetRxAvailable() > 0)
149  {
150  Ptr<Packet> packet = socket->RecvFrom(srcAddress);
151  PacketSocketAddress packetSocketAddress = PacketSocketAddress::ConvertFrom(srcAddress);
152  srcAddress = packetSocketAddress.GetPhysicalAddress();
153  uint8_t energyReading;
154  packet->CopyData(&energyReading, 1);
155 
156  if (Mac8Address::IsMatchingType(srcAddress))
157  {
158  NS_LOG_UNCOND("Time: " << Simulator::Now().GetHours() << "h"
159  << " | Node: " << Mac8Address::ConvertFrom(srcAddress)
160  << " | Energy: " << +energyReading << "%");
161  }
162  }
163 }
164 
165 void
167 {
168  auto node = m_nodes.Begin();
169  PacketSocketHelper packetSocketHelper;
170  while (node != m_nodes.End())
171  {
172  packetSocketHelper.Install(*node);
173  PacketSocketAddress socketAddress;
174  socketAddress.SetSingleDevice((*node)->GetDevice(0)->GetIfIndex());
175  socketAddress.SetProtocol(0);
176  m_sockets[*node] =
177  Socket::CreateSocket(*node, TypeId::LookupByName("ns3::PacketSocketFactory"));
178  m_sockets[*node]->Bind();
179  m_sockets[*node]->Connect(socketAddress);
180  m_sockets[*node]->SetRecvCallback(MakeCallback(&UanExperiment::PrintReceivedPacket, this));
181  node++;
182  }
183 }
184 
185 void
187 {
188  Ptr<UniformRandomVariable> uniformRandomVariable = CreateObject<UniformRandomVariable>();
189 
190  auto node = m_nodes.Begin();
191  Mac8Address dst = Mac8Address::ConvertFrom((*node)->GetDevice(0)->GetAddress());
192  node++;
193  while (node != m_nodes.End())
194  {
195  uint8_t energy =
196  ((*node)->GetObject<EnergySourceContainer>()->Get(0)->GetEnergyFraction()) * 100;
197 
198  Ptr<Packet> pkt = Create<Packet>(&energy, 1);
199 
200  double time = uniformRandomVariable->GetValue(0, 60);
201  Simulator::Schedule(Seconds(time), &UanExperiment::SendSinglePacket, this, *node, pkt, dst);
202  node++;
203  }
205 }
206 
207 void
209 {
210  NS_LOG_UNCOND(Simulator::Now().GetHours() << "h"
211  << " 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  for (auto socket = m_sockets.begin(); socket != m_sockets.end(); socket++)
234  {
235  socket->second->Close();
236  }
237 }
238 
239 int
240 main(int argc, char* argv[])
241 {
242  CommandLine cmd(__FILE__);
243  cmd.Parse(argc, argv);
244 
246  experiment.Prepare();
247 
248  Simulator::Stop(Days(50));
249  Simulator::Run();
251 
252  experiment.Teardown();
253 
254  return 0;
255 }
This example shows the usage of UDP over 6LoWPAN to transfer data.
void Teardown()
Teardown the experiment.
void PrintReceivedPacket(Ptr< Socket > socket)
Print the received packet.
void Prepare()
Prepare the experiment.
void SendSinglePacket(Ptr< Node > node, Ptr< Packet > pkt, Ipv6Address dst)
Send a packet from one of the nodes.
void SendPackets()
Send a packet from all the nodes.
void SetupCommunications()
Set the UAN nodes communication channels.
void SetupPositions()
Set the UAN nodes position.
void SetupApplications()
Set the UAN nodes communication channels.
void SetupEnergy()
Set the UAN nodes energy.
Assign AcousticModemEnergyModel to uan devices.
a polymophic address class
Definition: address.h:101
Creates a BasicEnergySource object.
void Set(std::string name, const AttributeValue &v) override
Parse command-line arguments.
Definition: command-line.h:232
DeviceEnergyModelContainer Install(Ptr< NetDevice > device, Ptr< EnergySource > source) const
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
Holds a vector of ns3::EnergySource pointers.
Ptr< EnergySource > Get(uint32_t i) const
Get the i-th Ptr<EnergySource> stored in this container.
Iterator Begin() const
Get an iterator which refers to the first EnergySource pointer in the container.
void Add(EnergySourceContainer container)
EnergySourceContainer Install(Ptr< Node > node) const
A class used for addressing MAC8 MAC's.
Definition: mac8-address.h:44
static Mac8Address ConvertFrom(const Address &address)
Convert a generic address to a Mac8Address.
Definition: mac8-address.cc:56
static bool IsMatchingType(const Address &address)
Check that a generic Address is compatible with Mac8Address.
Definition: mac8-address.cc:65
Helper class used to assign positions and mobility models to nodes.
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
void SetMobilityModel(std::string type, Ts &&... args)
Keep track of the current position and velocity of an object.
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Ptr< NetDevice > GetDevice(uint32_t index) const
Retrieve the index-th NetDevice associated to this node.
Definition: node.cc:152
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
uint32_t CopyData(uint8_t *buffer, uint32_t size) const
Copy the packet contents to a byte buffer.
Definition: packet.cc:400
an address for a packet socket
Address GetPhysicalAddress() const
Get the destination address.
void SetProtocol(uint16_t protocol)
Set the protocol.
void SetPhysicalAddress(const Address address)
Set the destination address.
static PacketSocketAddress ConvertFrom(const Address &address)
void SetSingleDevice(uint32_t device)
Set the address to match only a specified NetDevice.
Give ns3::PacketSocket powers to ns3::Node.
void Install(Ptr< Node > node) const
Aggregate an instance of a ns3::PacketSocketFactory onto the provided node.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:571
static void Destroy()
Execute the events scheduled with ScheduleDestroy().
Definition: simulator.cc:142
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:208
static void Run()
Run the simulation.
Definition: simulator.cc:178
static void Stop()
Tell the Simulator the calling event should be the last one executed.
Definition: simulator.cc:186
virtual uint32_t GetRxAvailable() const =0
Return number of bytes which can be returned from one or multiple calls to Recv.
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:72
virtual int Close()=0
Close a socket.
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.
static TypeId LookupByName(std::string name)
Get a TypeId by name.
Definition: type-id.cc:835
UAN configuration helper.
Definition: uan-helper.h:42
NetDeviceContainer Install(NodeContainer c) const
This method creates a simple ns3::UanChannel (with a default ns3::UanNoiseModelDefault and ns3::UanPr...
Definition: uan-helper.cc:145
double GetValue(double min, double max)
Get the next random value drawn from the distribution.
void experiment(std::string queue_disc_type)
#define NS_LOG_UNCOND(msg)
Output the requested message unconditionally.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1326
Time Days(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1290
Time Hours(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1302
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:704
cmd
Definition: second.py:40
channel
Definition: third.py:88