Update README and add contrib dir

2025-12-01 15:56:02 +01:00
parent 1b80de2153
commit cd9ba93d58
150 changed files with 25563 additions and 0 deletions
--- a/contrib/trace/examples/tsn-point2point-netanim.cc
+++ b/contrib/trace/examples/tsn-point2point-netanim.cc
@@ -0,0 +1,102 @@
+#include "ns3/core-module.h"
+#include "ns3/applications-module.h"
+#include "ns3/command-line.h"
+#include "ns3/simulator.h"
+#include "ns3/node.h"
+#include "ns3/drop-tail-queue.h"
+
+#include "ns3/tsn-net-device.h"
+#include "ns3/ethernet-channel.h"
+#include "ns3/ethernet-generator.h"
+#include "ns3/ethernet-header2.h"
+
+#include "ns3/animation-trace.h"
+
+/**
+ * \file
+ *
+ * Example of the use of tsn-node.cc tsn-net-device.cc ethernet-channel.cc
+ * on a network composed of two end-stations connected by a 100Mb/s
+ * full duplex link. This example generate a NetAnim trace for graphical purpose.
+ *  ES1 ====== ES2
+ */
+
+using namespace ns3;
+
+NS_LOG_COMPONENT_DEFINE("Example");
+
+//A callback to log the pkt reception
+static void
+MacRxCallback(std::string context, Ptr<const Packet> p)
+{
+  NS_LOG_INFO((Simulator::Now()).As(Time::S) << " \t" << context << " : Pkt #" << p->GetUid() << " received !");
+}
+
+int
+main(int argc, char* argv[])
+{
+    //Enable logging
+    LogComponentEnable("Example", LOG_LEVEL_INFO);
+    LogComponentEnable("EthernetGenerator", LOG_LEVEL_INFO);
+    LogComponentEnable("AnimationTrace", LOG_LEVEL_ALL);
+
+    CommandLine cmd(__FILE__);
+    cmd.Parse(argc, argv);
+
+    //Create two nodes
+    Ptr<TsnNode> n0 = CreateObject<TsnNode>();
+    Names::Add("ES1", n0);
+    Ptr<TsnNode> n1 = CreateObject<TsnNode>();
+    Names::Add("ES2", n1);
+
+    //Create and add a netDevice to each node
+    Ptr<TsnNetDevice> net0 = CreateObject<TsnNetDevice>();
+    net0->SetAttribute("DataRate", DataRateValue(DataRate("100Mb/s")));
+    n0->AddDevice(net0);
+    Names::Add("ES1#01", net0);
+    Ptr<TsnNetDevice> net1 = CreateObject<TsnNetDevice>();
+    net1->SetAttribute("DataRate", DataRateValue(DataRate("100Mb/s")));
+    n1->AddDevice(net1);
+    Names::Add("ES2#01", net1);
+
+    //Create a Ethernet Channel and attach it two the two netDevices
+    Ptr<EthernetChannel> channel = CreateObject<EthernetChannel>();
+    net0->Attach(channel);
+    net1->Attach(channel);
+
+    //Allocate a Mac address and create a FIFO (for the output port)
+    //for each netDevice.
+    net0->SetAddress(Mac48Address::Allocate());
+    net0->SetQueue(CreateObject<DropTailQueue<Packet>>());
+
+    net1->SetAddress(Mac48Address::Allocate());
+    net1->SetQueue(CreateObject<DropTailQueue<Packet>>());
+
+    //Application description
+    Ptr<EthernetGenerator> app0 = CreateObject<EthernetGenerator>();
+    app0->Setup(net0);
+    app0->SetAttribute("BurstSize", UintegerValue(2));
+    app0->SetAttribute("PayloadSize", UintegerValue(1400));
+    app0->SetAttribute("Period", TimeValue(Seconds(5)));
+
+    n0->AddApplication(app0);
+    app0->SetStartTime(Seconds(0));
+    app0->SetStopTime(Seconds(10));
+
+    //Callback to display the packet received log
+    std::string context = Names::FindName(n1) + ":" + Names::FindName(net1);
+    net1->TraceConnectWithoutContext("MacRx", MakeBoundCallback(&MacRxCallback, context));
+
+    //NetAnim
+    // Create the animation trace object and configure for specified output
+    AnimationTrace anim = AnimationTrace("example-animation.xml");
+    anim.SetNodePosition(n1, 10, 0);
+    anim.StartAnimation();
+    Packet::EnablePrinting(); //Need to enable packet printing for metadata display on NetAnim
+
+    //Execute the simulation
+    Simulator::Stop(Seconds(10));
+    Simulator::Run();
+    Simulator::Destroy();
+    return 0;
+}