HELICS module skeleton and waf script to specify helics location

src/helics/doc/helics.rst

@@ -0,0 +1,98 @@
+Example Module Documentation
+----------------------------
+
+.. include:: replace.txt
+.. highlight:: cpp
+
+.. heading hierarchy:
+   ------------- Chapter
+   ************* Section (#.#)
+   ============= Subsection (#.#.#)
+   ############# Paragraph (no number)
+
+This is a suggested outline for adding new module documentation to |ns3|.
+See ``src/click/doc/click.rst`` for an example.
+
+The introductory paragraph is for describing what this code is trying to
+model.
+
+For consistency (italicized formatting), please use |ns3| to refer to
+ns-3 in the documentation (and likewise, |ns2| for ns-2).  These macros
+are defined in the file ``replace.txt``.
+
+Model Description
+*****************
+
+The source code for the new module lives in the directory ``src/helics``.
+
+Add here a basic description of what is being modeled.
+
+Design
+======
+
+Briefly describe the software design of the model and how it fits into 
+the existing ns-3 architecture. 
+
+Scope and Limitations
+=====================
+
+What can the model do?  What can it not do?  Please use this section to
+describe the scope and limitations of the model.
+
+References
+==========
+
+Add academic citations here, such as if you published a paper on this
+model, or if readers should read a particular specification or other work.
+
+Usage
+*****
+
+This section is principally concerned with the usage of your model, using
+the public API.  Focus first on most common usage patterns, then go
+into more advanced topics.
+
+Building New Module
+===================
+
+Include this subsection only if there are special build instructions or
+platform limitations.
+
+Helpers
+=======
+
+What helper API will users typically use?  Describe it here.
+
+Attributes
+==========
+
+What classes hold attributes, and what are the key ones worth mentioning?
+
+Output
+======
+
+What kind of data does the model generate?  What are the key trace
+sources?   What kind of logging output can be enabled?
+
+Advanced Usage
+==============
+
+Go into further details (such as using the API outside of the helpers)
+in additional sections, as needed.
+
+Examples
+========
+
+What examples using this new code are available?  Describe them here.
+
+Troubleshooting
+===============
+
+Add any tips for avoiding pitfalls, etc.
+
+Validation
+**********
+
+Describe how the model has been tested/validated.  What tests run in the
+test suite?  How much API and code is covered by the tests?  Again, 
+references to outside published work may help here.

src/helics/examples/helics-example.cc

@@ -0,0 +1,26 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+
+#include "ns3/core-module.h"
+#include "ns3/helics-helper.h"
+
+using namespace ns3;
+
+
+int 
+main (int argc, char *argv[])
+{
+  bool verbose = true;
+
+  CommandLine cmd;
+  cmd.AddValue ("verbose", "Tell application to log if true", verbose);
+
+  cmd.Parse (argc,argv);
+
+  /* ... */
+
+  Simulator::Run ();
+  Simulator::Destroy ();
+  return 0;
+}
+
+

src/helics/examples/wscript

@@ -0,0 +1,6 @@
+# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
+
+def build(bld):
+    obj = bld.create_ns3_program('helics-example', ['helics'])
+    obj.source = 'helics-example.cc'
+

src/helics/helper/helics-helper.cc

@@ -0,0 +1,11 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+
+#include "helics-helper.h"
+
+namespace ns3 {
+
+/* ... */
+
+
+}
+

src/helics/helper/helics-helper.h

@@ -0,0 +1,14 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+#ifndef HELICS_HELPER_H
+#define HELICS_HELPER_H
+
+#include "ns3/helics.h"
+
+namespace ns3 {
+
+/* ... */
+
+}
+
+#endif /* HELICS_HELPER_H */
+

src/helics/model/helics.cc

@@ -0,0 +1,11 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+
+#include "helics.h"
+
+namespace ns3 {
+
+/* ... */
+
+
+}
+

src/helics/model/helics.h

@@ -0,0 +1,14 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+#ifndef HELICS_H
+#define HELICS_H
+
+#include "helics/application_api/Federate.h"
+
+namespace ns3 {
+
+/* ... */
+
+}
+
+#endif /* HELICS_H */
+

src/helics/test/helics-test-suite.cc

@@ -0,0 +1,68 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+
+// Include a header file from your module to test.
+#include "ns3/helics.h"
+
+// An essential include is test.h
+#include "ns3/test.h"
+
+// Do not put your test classes in namespace ns3.  You may find it useful
+// to use the using directive to access the ns3 namespace directly
+using namespace ns3;
+
+// This is an example TestCase.
+class HelicsTestCase1 : public TestCase
+{
+public:
+  HelicsTestCase1 ();
+  virtual ~HelicsTestCase1 ();
+
+private:
+  virtual void DoRun (void);
+};
+
+// Add some help text to this case to describe what it is intended to test
+HelicsTestCase1::HelicsTestCase1 ()
+  : TestCase ("Helics test case (does nothing)")
+{
+}
+
+// This destructor does nothing but we include it as a reminder that
+// the test case should clean up after itself
+HelicsTestCase1::~HelicsTestCase1 ()
+{
+}
+
+//
+// This method is the pure virtual method from class TestCase that every
+// TestCase must implement
+//
+void
+HelicsTestCase1::DoRun (void)
+{
+  // A wide variety of test macros are available in src/core/test.h
+  NS_TEST_ASSERT_MSG_EQ (true, true, "true doesn't equal true for some reason");
+  // Use this one for floating point comparisons
+  NS_TEST_ASSERT_MSG_EQ_TOL (0.01, 0.01, 0.001, "Numbers are not equal within tolerance");
+}
+
+// The TestSuite class names the TestSuite, identifies what type of TestSuite,
+// and enables the TestCases to be run.  Typically, only the constructor for
+// this class must be defined
+//
+class HelicsTestSuite : public TestSuite
+{
+public:
+  HelicsTestSuite ();
+};
+
+HelicsTestSuite::HelicsTestSuite ()
+  : TestSuite ("helics", UNIT)
+{
+  // TestDuration for TestCase can be QUICK, EXTENSIVE or TAKES_FOREVER
+  AddTestCase (new HelicsTestCase1, TestCase::QUICK);
+}
+
+// Do not forget to allocate an instance of this TestSuite
+static HelicsTestSuite helicsTestSuite;
+

src/helics/wscript

@@ -0,0 +1,91 @@
+# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
+
+import os
+
+from waflib import Options
+
+def options(opt):
+    opt.add_option('--with-helics',
+                   help=('Path to HELICS for federated simulator integration'),
+                   default='', dest='with_helics')
+
+def configure(conf):
+    if Options.options.with_helics:
+        if os.path.isdir(Options.options.with_helics):
+            conf.msg("Checking for HELICS location", ("%s (given)" % Options.options.with_helics))
+            conf.env['WITH_HELICS'] = os.path.abspath(Options.options.with_helics)
+    # else:
+        # bake.py uses ../../build, while ns-3-dev uses ../helics
+    if not conf.env['WITH_HELICS']:
+        conf.msg("Checking for HELICS location", False)
+        conf.report_optional_feature("helics", "NS-3 HELICS Integration", False,
+                                     "HELICS not enabled (see option --with-helics)")
+        # Add this module to the list of modules that won't be built
+        # if they are enabled.
+        conf.env['MODULES_NOT_BUILT'].append('helics')
+
+        return
+
+    test_code = '''
+int main()
+{
+    return 0;
+}
+
+'''
+
+    conf.env.append_value('NS3_MODULE_PATH', os.path.abspath(os.path.join(conf.env['WITH_HELICS'], 'build', 'default')))
+    conf.env.append_value('NS3_MODULE_PATH', os.path.abspath(os.path.join(conf.env['WITH_HELICS'], 'lib')))
+
+    conf.env['INCLUDES_HELICS'] = [
+            os.path.abspath(os.path.join(conf.env['WITH_HELICS'], 'include'))
+        ]
+    conf.env['LIBPATH_HELICS'] = [
+            os.path.abspath(os.path.join(conf.env['WITH_HELICS'], 'build', 'default')),
+            os.path.abspath(os.path.join(conf.env['WITH_HELICS'], 'lib'))
+        ]
+
+    conf.env['DEFINES_HELICS'] = ['NS3_HELICS']
+
+    conf.env['HELICS'] = conf.check(fragment=test_code, lib='helics', libpath=conf.env['LIBPATH_HELICS'], use='HELICS')
+
+    conf.env.append_value('LIB_HELICS', 'helics')
+    conf.report_optional_feature("helics", "NS-3 HELICS Integration", conf.env['HELICS'], "HELICS library not found")
+
+    if conf.env['HELICS']:
+        conf.env['ENABLE_HELICS'] = True
+    else:
+        # Add this module to the list of modules that won't be built
+        # if they are enabled.
+        conf.env['MODULES_NOT_BUILT'].append('helics')
+
+def build(bld):
+    if 'helics' in bld.env['MODULES_NOT_BUILT']:
+        return
+
+    module = bld.create_ns3_module('helics', ['core'])
+    module.source = [
+        'model/helics.cc',
+        'helper/helics-helper.cc',
+        ]
+
+    module_test = bld.create_ns3_module_test_library('helics')
+    module_test.source = [
+        'test/helics-test-suite.cc',
+        ]
+
+    if bld.env['HELICS']:
+        module.use.extend(['HELICS'])
+
+    headers = bld(features='ns3header')
+    headers.module = 'helics'
+    headers.source = [
+        'model/helics.h',
+        'helper/helics-helper.h',
+        ]
+
+    if bld.env.ENABLE_EXAMPLES:
+        bld.recurse('examples')
+
+    # bld.ns3_python_bindings()
+