This folder contains the templates to implement DEVS models in CDBoost

/**************************/
/****FILES ORGANIZATION****/
/**************************/

README.txt

atomics [This folder contains the template to implement an atomic model in CDBoost]
	atomicCDBoost.hpp

data_structures [This folder contains the template to define the message structure of the atomic model in CDBoost]
	message.hpp
	message.cpp

test [This folder contains an example of a unit test]
	atomicCDBoost [This folder contains the templates to define and compile a unit/integrated test]
		main.cpp
		makefile
		example_atomic_input_test.txt

vendor [This folder contains a time class to use in your model and a model to generate the inputs to the DEVS models]
	input_event_stream.hpp
	britime.hpp

top_model [This folder contains the templates to define and compile the DEVS top model]	
	main.cpp
	makefile
	example_TOP_input_test.txt

/*************/
/****STEPS****/
/*************/

1 - Open atomics folder. Read the comments in atomicCDBoost.hpp to implement an atomic model

2 - Open data_structures folder. Read the comments in message.hpp and message.cpp to adapt the message structure to your model

3 - Open atomicCDBoost folder
	3.1. Read the comments in main.cpp to implement your test
	3.2. Read the comments in makefile to implement the script that compiles your test
	3.3. example_atomic_input_test.txt is an example of an input file. The structure of this file will depend on your model's message structure

4 - Vendor folder contains
	4.1. A time class (britime.hpp) you can use in your DEVS models
	4.2. A generator DEVS model (input_event_stream.hpp) you can use to parse your input file and generate the messages your top model receives

5 - Open top_model folder
	3.1. Read the comments in main.cpp to implement your top_model
	3.2. Read the comments in makefile to implement the script that compiles your model
	3.3. example_TOP_input_test.txt is an example of an input file. The structure of this file will depend on your model's message structure

6 - Once you have your model implemented, compile the tests and your top model as explained in the README.txt file located in the alternatebitprotocol folder

NOTE: Most probably, the first time you compile, you will get some errors. Revise your model, fix the errors and try step 6 until everything works
