Here is the basic project setup

sdavtaker · web-flow · commit 9af73fe2fc60 · 2016-09-18T00:06:37.000-04:00
* License and simple introductory README file
* basic project structure and build files
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,13 @@
 *.exe
 *.out
 *.app
+
+# QtCreator project files
+cadmium.config
+cadmium.creator
+cadmium.creator.user
+cadmium.files
+cadmium.includes
+
+# Build files
+build
diff --git a/BSD-LICENSE.txt b/BSD-LICENSE.txt
@@ -0,0 +1,23 @@
+Copyright (c) 2013-2015, Damian Vicino
+Carleton University, Universite de Nice-Sophia Antipolis
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
diff --git a/Jamroot.jam b/Jamroot.jam
@@ -0,0 +1,18 @@
+import os ;
+
+# Note: we require tha BOOST_ROOT be defined with a valid path
+BOOST_ROOT = [ os.environ BOOST_ROOT ] ;
+ECHO Boost include path is: $(BOOST_ROOT) ;
+
+project simulation
+    : usage-requirements <include>include
+    : requirements
+        <include>$(BOOST_ROOT)
+	<cxxflags>-pedantic
+        <cxxflags>-std=c++14
+    : build-dir ./build
+;
+
+# Examples are not being built yet
+#build-project example ;
+build-project test ;
diff --git a/README.md b/README.md
@@ -1 +1,28 @@
-# cadmium
+# cadmium
+
+## Introduction
+This library provides model classes for multiple Discrete-Event Simulation formalisms and the tools to simulate those models.
+This project goal is replace CD++ with a more flexible and better performant implementation. Initial research in the  architecture of Cadmium can be found in [Sequential PDEVS architecture](http://cell-devs.sce.carleton.ca/publications/2015/VNWD15/) paper. Our primary building tool is clang, but we also test builds using gcc and visual studio when having the resources to do so.
+
+## Top features
+* Model validation at compile time.
+* PDEVS models simulated in a single thread.
+* Typed messages going through typed ports.
+* Time representation is independent of model implementation.
+
+## Quick start
+###Requirements
+* A C++14 compliant compiler. 
+
+### Install
+* The library is headers only. Then, it is enough to put the include directory in the path the compiler looks up for them.
+
+### Building tests and examples
+* Boost.Test, if running the testsfor running the tests.
+* Boost.Build, if using the building files provided for convenience.
+
+## References
+* [CD++ website](http://cell-devs.sce.carleton.ca/mediawiki/index.php/Main_Page) is official CD++ website.
+* [CD++ paper](http://www.sce.carleton.ca/faculty/wainer/papers/spe482.pdf) describes the CD++ simulator.
+* [CDBoost website](http://blincubator.com/bi_library/simulation/?gform_post_id=1390) shows a preliminary implementation of Cadmium.
+* [Sequential PDEVS architecture](http://cell-devs.sce.carleton.ca/publications/2015/VNWD15/) describes the architecture originally proposed. Several changes had been implemented since then. The documentation will explain them when ready.
diff --git a/example/Jamfile.jam b/example/Jamfile.jam
@@ -0,0 +1,8 @@
+project exaremple
+    : requirements
+        <include>../include
+	<include>../../safefloat/include
+;
+
+
+exe clock : main-clock.cpp ;
diff --git a/example/main-clock.cpp b/example/main-clock.cpp
@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2013-2015, Damian Vicino
+ * Carleton University, Universite de Nice-Sophia Antipolis
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+//This file will include the clock example
+
+#include <iostream>
+#include <chrono>
+#include <algorithm>
+
+using namespace std;
+
+using hclock=chrono::high_resolution_clock;
+
+//This example is the simulation of a clock with 3 needles (H,M,S)
+
+int main(){
+    auto start = hclock::now(); //to measure simulation execution time
+
+    
+    auto elapsed = std::chrono::duration_cast<std::chrono::duration<double, std::ratio<1>>>
+                                                                                          (hclock::now() - start).count();
+    cout << "Simulation took:" << elapsed << "sec" << endl;
+    return 0;
+}
+
diff --git a/test/Jamfile.jam b/test/Jamfile.jam
@@ -0,0 +1,4 @@
+using testing ;
+lib boost_unit_test_framework ;
+unit-test test : main-test.cpp [ glob *_test.cpp ] boost_unit_test_framework ;
+
diff --git a/test/main-test.cpp b/test/main-test.cpp
@@ -0,0 +1,3 @@
+#define BOOST_TEST_DYN_LINK
+#define BOOST_TEST_MODULE Main
+#include <boost/test/unit_test.hpp>
diff --git a/test/pdevs_basic_models_test.cpp b/test/pdevs_basic_models_test.cpp
@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2013-2015, Damian Vicino
+ * Carleton University, Universite de Nice-Sophia Antipolis
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+#define BOOST_TEST_DYN_LINK
+#include <boost/test/unit_test.hpp>
+
+BOOST_AUTO_TEST_SUITE( pdevs_basic_models_suite )
+
+BOOST_AUTO_TEST_SUITE( pdevs_accumulator_suite )
+BOOST_AUTO_TEST_CASE( it_is_constructable_test )
+{
+    BOOST_ASSERT_MSG(true, "Trivial test passed");
+}
+BOOST_AUTO_TEST_SUITE_END()
+
+BOOST_AUTO_TEST_SUITE_END()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#define BOOST_TEST_DYN_LINK`
	`2`	`+#define BOOST_TEST_MODULE Main`
	`3`	`+#include <boost/test/unit_test.hpp>`