Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(446)

Unified Diff: src/bundle-protocol/helper/bundle-protocol-helper.h

Issue 38130049: SOCIS2013 bundle protocol (first code review)
Patch Set: Created 10 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: src/bundle-protocol/helper/bundle-protocol-helper.h
===================================================================
new file mode 100644
--- /dev/null
+++ b/src/bundle-protocol/helper/bundle-protocol-helper.h
@@ -0,0 +1,110 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2013 University of New Brunswick
+ *
+ * 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: Dizhi Zhou <dizhi.zhou@gmail.com>
+ */
+
+#ifndef BUNDLE_PROTOCOL_HELPER_H
+#define BUNDLE_PROTOCOL_HELPER_H
+
+#include <stdint.h>
+#include <string>
+#include "ns3/object-factory.h"
+#include "ns3/attribute.h"
+#include "ns3/net-device.h"
+#include "ns3/node-container.h"
+#include "ns3/bundle-protocol-container.h"
+#include "ns3/bundle-protocol.h"
+#include "ns3/bp-routing-protocol.h"
+#include "ns3/bp-endpoint-id.h"
+
+namespace ns3 {
+
+/**
+ * \brief A helper to make it easier to instantiate an ns3::BundleProtocol
+ * on a set of nodes.
+ */
+class BundleProtocolHelper
+{
+public:
+ /**
+ * Create an BundleProtocolHelper to make it easier to work with BundleProtocol
+ */
+ BundleProtocolHelper ();
+
+ /**
+ * Install an ns3::BundleProtocol on each node of the input container
+ * configured with all the attributes set with SetAttribute.
+ *
+ * \param c NodeContainer of the set of nodes on which an BundleProtocol
+ * will be installed.
+ *
+ * \returns Container of Ptr to the BundleProtocols installed.
+ */
+ BundleProtocolContainer Install (NodeContainer c);
+
+ /**
+ * Install an ns3::BundleProtocol on the node configured with all the
+ * attributes set with SetAttribute.
+ *
+ * \param node The node on which an BundleProtocol will be installed.
+ * \returns Container of Ptr to the BundleProtocols installed.
+ */
+ BundleProtocolContainer Install (Ptr<Node> node);
+
+ /**
+ * Install an ns3::BundleProtocol on the node configured with all the
+ * attributes set with SetAttribute.
+ *
+ * \param nodeName The node on which an BundleProtocol will be installed.
+ * \returns Container of Ptr to the BundleProtocols installed.
+ */
+ BundleProtocolContainer Install (std::string nodeName);
+
+ /**
+ * Set endpoint id
+ *
+ * \param eid endpoint id
+ */
+ void SetBpEndpointId (BpEndpointId eid);
+
+ /**
+ * Set bundle routing protocol
+ *
+ * \param rt bundle routing protocol
+ */
+ void SetRoutingProtocol (Ptr<BpRoutingProtocol> rt);
+
+private:
+ /**
+ * \internal
+ * Install an ns3::BundleProtocol on the node
+ *
+ * \param node The node on which an BundleProtocol will be installed.
+ * \returns Ptr to the BundleProtocol installed.
+ */
+ Ptr<BundleProtocol> InstallPriv (Ptr<Node> node);
+
+private:
+ BpEndpointId m_eid; /// endpoint id
+ Ptr<BpRoutingProtocol> m_routingProtocol; /// bundle routing protocol
+};
+
+} // namespace ns3
+
+#endif /* ON_OFF_HELPER_H */
+
« no previous file with comments | « src/bundle-protocol/helper/bundle-protocol-container.cc ('k') | src/bundle-protocol/helper/bundle-protocol-helper.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b