Created helper class based on ns3::BridgeHelper to create MOOSE Bridges.
authorRichard Whitehouse <github@richardwhiuk.com>
Tue, 25 Jan 2011 04:12:25 +0000 (04:12 +0000)
committerRichard Whitehouse <github@richardwhiuk.com>
Tue, 25 Jan 2011 04:12:25 +0000 (04:12 +0000)
code/src/devices/bridge/helper/moose-bridge-helper.cc [new file with mode: 0644]
code/src/devices/bridge/helper/moose-bridge-helper.h [new file with mode: 0644]

diff --git a/code/src/devices/bridge/helper/moose-bridge-helper.cc b/code/src/devices/bridge/helper/moose-bridge-helper.cc
new file mode 100644 (file)
index 0000000..c2abb44
--- /dev/null
@@ -0,0 +1,72 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation;
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * Author: Richard Whitehouse <ns3@richardwhiuk.com
+ */
+
+#include "moose-bridge-helper.h"
+#include "ns3/log.h"
+#include "ns3/moose-bridge-net-device.h"
+#include "ns3/node.h"
+#include "ns3/names.h"
+
+NS_LOG_COMPONENT_DEFINE ("MooseBridgeHelper");
+
+namespace ns3 {
+
+MooseBridgeHelper::MooseBridgeHelper ()
+{
+  NS_LOG_FUNCTION_NOARGS ();
+  m_deviceFactory.SetTypeId ("ns3::MooseBridgeNetDevice");
+}
+
+void 
+MooseBridgeHelper::SetDeviceAttribute (std::string n1, const AttributeValue &v1)
+{
+  NS_LOG_FUNCTION_NOARGS ();
+  m_deviceFactory.Set (n1, v1);
+}
+
+NetDeviceContainer
+MooseBridgeHelper::Install (Ptr<Node> node, NetDeviceContainer c)
+{
+  NS_LOG_FUNCTION_NOARGS ();
+  NS_LOG_LOGIC ("**** Install MOOSE bridge device on node " << node->GetId ());
+
+  NetDeviceContainer devs;
+  Ptr<BridgeNetDevice> dev = m_deviceFactory.Create<BridgeNetDevice> ();
+  devs.Add (dev);
+  node->AddDevice (dev);
+
+  for (NetDeviceContainer::Iterator i = c.Begin (); i != c.End (); ++i)
+    {
+      NS_LOG_LOGIC ("**** Add MooseBridgePort "<< *i);
+      dev->AddBridgePort (*i);
+    }
+  return devs;
+}
+
+NetDeviceContainer
+MooseBridgeHelper::Install (std::string nodeName, NetDeviceContainer c)
+{
+  NS_LOG_FUNCTION_NOARGS ();
+  Ptr<Node> node = Names::Find<Node> (nodeName);
+  return Install (node, c);
+}
+
+} // namespace ns3
+
diff --git a/code/src/devices/bridge/helper/moose-bridge-helper.h b/code/src/devices/bridge/helper/moose-bridge-helper.h
new file mode 100644 (file)
index 0000000..731f5e8
--- /dev/null
@@ -0,0 +1,84 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2008 INRIA
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation;
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * Author: Richard Whitehouse <ns3@richardwhiuk.com
+ *
+ * Based on work by:
+ *
+ * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
+ * Author: Gustavo Carneiro <gjc@inescporto.pt>
+ */
+#ifndef MOOSE_BRIDGE_HELPER_H
+#define MOOSE_BRIDGE_HELPER_H
+
+#include "ns3/net-device-container.h"
+#include "ns3/object-factory.h"
+#include <string>
+
+namespace ns3 {
+
+class Node;
+class AttributeValue;
+
+/**
+ * \brief Add capability to bridge multiple LAN segments (IEEE 802.1D bridging) using MOOSE semantics.
+ */
+class MooseBridgeHelper
+{
+public:
+  /*
+   * Construct a BridgeHelper
+   */
+  MooseBridgeHelper ();
+  /**
+   * Set an attribute on each ns3::MooseBridgeNetDevice created by
+   * MooseBridgeHelper::Install
+   *
+   * \param n1 the name of the attribute to set
+   * \param v1 the value of the attribute to set
+   */
+  void SetDeviceAttribute (std::string n1, const AttributeValue &v1);
+  /**
+   * This method creates an ns3::MooseBridgeNetDevice with the attributes
+   * configured by MooseBridgeHelper::SetDeviceAttribute, adds the device
+   * to the node, and attaches the given NetDevices as ports of the
+   * bridge.
+   *
+   * \param node The node to install the device in
+   * \param c Container of NetDevices to add as bridge ports
+   * \returns A container holding the added net device.
+   */
+  NetDeviceContainer Install (Ptr<Node> node, NetDeviceContainer c);
+  /**
+   * This method creates an ns3::MooseBridgeNetDevice with the attributes
+   * configured by MooseBridgeHelper::SetDeviceAttribute, adds the device
+   * to the node, and attaches the given NetDevices as ports of the
+   * bridge.
+   *
+   * \param nodeName The name of the node to install the device in
+   * \param c Container of NetDevices to add as bridge ports
+   * \returns A container holding the added net device.
+   */
+  NetDeviceContainer Install (std::string nodeName, NetDeviceContainer c);
+private:
+  ObjectFactory m_deviceFactory;
+};
+
+} // namespace ns3
+
+
+#endif /* MOOSE_BRIDGE_HELPER_H */