Some ATDB docu extensions.
Change-Id: I54cb5fa239f6f1b4ac2ad1b2c3e254831943500f
Signed-off-by: Raphael Weber <raphael.weber@vector.com>
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_amalthea_to_atdb_import.textile b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_amalthea_to_atdb_import.textile
new file mode 100644
index 0000000..83835fa
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_amalthea_to_atdb_import.textile
@@ -0,0 +1,9 @@
+
+
+h3. AMALTHEA Specification Parts to ATDB Import Example
+
+This section describes how to use the information contained in an AMALTHEA model to enrich an existing ATDB with the specification parts (events and event chains).
+
+*Step 1*
+
+TODO
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_atdb_import.textile b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_atdb_import.textile
deleted file mode 100644
index 9398d18..0000000
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_atdb_import.textile
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-h3. AMALTHEA Trace Database (ATDB) Import Example
-
-The following section describes how to use the information contained within an AMALTHEA Trace Database (ATDB) to create a model.
-
-*Step 1*
-
-!../pictures/amalthea_trace_db_example.png!
-
-The figure above shows content of "Amalthea_ArExampleEngine.atdb", an AMALTHEA Trace database provided with the "Democar Example".
-To get this file create a new example project (see "Creating an example"), based on the "Democar Example".
-
-*Step 2*
-
-!../pictures/amalthea_import_options.png!
-
-Right-click on the project folder "org.eclipse.app4mc.amalthea.example.democar" or any other. You will see several possible options. In that option menu press "Import..." then.
-This will open a dialogue where the different import options available are listed. Open the folder called "AMALTHEA" by clicking on cross next to the title. This is shown in the figure above.
-
-*Step 3*
-
-!../pictures/atdb_import_dialogue.png!
-
-Next, choose mark the option "From AMALTHEA Trace DB" by clicking on it and proceed to the next page by either double-clicking the option name or by pressing the "Next" button. There you are prompted to enter the location of the ATDB file you want to import. Click the upper "Browse..." button to navigate your file system and select the wanted file. If you want to change the target project the model will be created in press the lower "Browse..." button and make your choice. The figure above shows an example input.
-
-*Step 4*
-
-!../pictures/atdb_import_result.png!
-
-After you have made all required inputs, click on "Finish". This will start the analysis of the database. Once the model creation is done the dialogue will close and the newly created amxmi file opened on the AMALTHEA Model editor as shown in the figure above.
\ No newline at end of file
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_atdb_to_amalthea_import.textile b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_atdb_to_amalthea_import.textile
new file mode 100644
index 0000000..ae6e28d
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_atdb_to_amalthea_import.textile
@@ -0,0 +1,9 @@
+
+
+h3. ATDB to AMALTHEA Model Transformation
+
+The following section describes how to use the information contained within an AMALTHEA Trace Database (ATDB) to create an AMALTHEA model.
+
+*Step 1*
+
+TODO
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_btf_to_atdb_import.textile b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_btf_to_atdb_import.textile
new file mode 100644
index 0000000..01b4653
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/docu/tutorial_btf_to_atdb_import.textile
@@ -0,0 +1,70 @@
+
+h3. BTF -> AMALTHEA Trace Database (ATDB) Import Example
+
+The following section describes how to import an existing Best Trace Format (BTF) file into an AMALTHEA Trace Database (ATDB).
+
+*Step 1*
+
+Consider the following BTF file (stored on the file system as "test1.btf"):
+
+bc. #version 2.1.5
+#timeScale ns
+0,ECU_1,-1,SIM,SIM,-1,tag,ECU_INIT
+0,Processor_1,-1,SIM,SIM,-1,tag,PROCESSOR_INIT
+0,Core_1,-1,SIM,SIM,-1,tag,CORE_INIT
+0,Core_2,-1,SIM,SIM,-1,tag,CORE_INIT
+0,Core_1,0,C,Core_1,0,set_frequence,10000000
+0,Core_2,0,C,Core_2,0,set_frequence,11000000
+0,Stimulus_Task_1,0,STI,Stimulus_Task_1,0,trigger
+0,Stimulus_Task_1,0,T,Task_1,0,activate
+0,Stimulus_Task_2,0,STI,Stimulus_Task_2,0,trigger
+0,Stimulus_Task_2,0,T,Task_2,0,activate
+100,Core_1,0,T,Task_1,0,start
+100,Task_1,0,R,Runnable_1_1,0,start
+100,Core_2,0,T,Task_2,0,start
+100,Task_2,0,R,Runnable_2_1,0,start
+20800,Task_1,0,R,Runnable_1_1,0,terminate
+20800,Task_1,0,R,Runnable_1_2,0,start
+40900,Task_1,0,R,Runnable_1_2,0,terminate
+40900,Core_1,0,T,Task_1,0,terminate
+45000,Stimulus_Task_3,0,STI,Stimulus_Task_3,0,trigger
+45000,Stimulus_Task_3,0,T,Task_3,0,activate
+45100,Task_2,0,R,Runnable_2_1,0,suspend
+45100,Core_2,0,T,Task_2,0,preempt
+45100,Core_2,0,T,Task_3,0,start
+45100,Task_3,0,R,Runnable_3_1,0,start
+55800,Task_3,0,R,Runnable_3_1,0,terminate
+55800,Core_2,0,T,Task_3,0,terminate
+55900,Core_2,0,T,Task_2,0,resume
+55900,Task_2,0,R,Runnable_2_1,0,resume
+61000,Task_2,0,R,Runnable_2_1,0,terminate
+61000,Core_2,0,T,Task_2,0,terminate
+
+Create a new empty Eclipse project that shall be used as a target container for the ATDB to imported from the btf file.
+
+*Step 2*
+
+!../pictures/project_rightclick_import.png!
+
+Right-click on the project folder (in this example, the name of the project is "Test1"). You will see several possible options. In that menu select and click "Import...".
+This will open a dialogue where different available import options are listed.
+
+*Step 3*
+
+Open the folder called "AMALTHEA Trace DB" by clicking on cross next to the title. This is shown in the following picture:
+
+!../pictures/atdb_import_wizard_open.png!
+
+Select the option "AMALTHEA Trace DB from BTF" and click the "Next" button.
+
+*Step 4*
+
+You are prompted to enter the location of the BTF file you want to import. Click the upper "Browse..." button to navigate your file system and select the "test1.btf" file. If you want to change the target project the ATDB file will be created in, press the lower "Browse..." button and make your choice. If you want the original trace data from the BTF in the data base file, select the option "Persist trace event table". The figure shows the example input:
+
+!../pictures/atdb_to_btf_import_dialog.png!
+
+*Step 5*
+
+After you have made all required inputs, click on "Finish". This will start the import of the database. Once the transformation is done the dialogue will close and the newly created ATDB file is opened in the Metric Viewer. For our example, this is shown in the following figure:
+
+!../pictures/atdb_in_metric_viewer.png!
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/amalthea_import_options.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/amalthea_import_options.png
deleted file mode 100644
index e700b98..0000000
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/amalthea_import_options.png
+++ /dev/null
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/amalthea_trace_db_example.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/amalthea_trace_db_example.png
deleted file mode 100644
index 91625cf..0000000
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/amalthea_trace_db_example.png
+++ /dev/null
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_dialogue.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_dialogue.png
deleted file mode 100644
index 749df38..0000000
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_dialogue.png
+++ /dev/null
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_result.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_result.png
deleted file mode 100644
index 60aa25e..0000000
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_result.png
+++ /dev/null
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_wizard_open.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_wizard_open.png
new file mode 100644
index 0000000..e336fd9
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_import_wizard_open.png
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_in_metric_viewer.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_in_metric_viewer.png
new file mode 100644
index 0000000..6a39b7a
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_in_metric_viewer.png
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_to_btf_import_dialog.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_to_btf_import_dialog.png
new file mode 100644
index 0000000..cc5ee0e
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/atdb_to_btf_import_dialog.png
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/project_rightclick_import.png b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/project_rightclick_import.png
new file mode 100644
index 0000000..bf8a8f8
--- /dev/null
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/pictures/project_rightclick_import.png
Binary files differ
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/plugin.xml b/plugins/org.eclipse.app4mc.amalthea.import.help/plugin.xml
index 91c4844..274e146 100644
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/plugin.xml
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/plugin.xml
@@ -1,16 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
- <extension
- point="org.eclipse.help.toc">
- <toc
- file="root-tutorial_import-toc.xml"
- primary="false">
- </toc>
- <toc
- file="toc/tutorial_atdb_import-toc.xml"
- primary="false">
- </toc>
+ <extension point="org.eclipse.help.toc">
+ <toc file="root-tutorial_import-toc.xml" primary="false" />
+ <toc file="toc/tutorial_btf_to_atdb_import-toc.xml" primary="false" />
+ <toc file="toc/tutorial_amalthea_to_atdb_import-toc.xml" primary="false" />
+ <toc file="toc/tutorial_atdb_to_amalthea_import-toc.xml" primary="false" />
</extension>
-
</plugin>
diff --git a/plugins/org.eclipse.app4mc.amalthea.import.help/root-tutorial_import-toc.xml b/plugins/org.eclipse.app4mc.amalthea.import.help/root-tutorial_import-toc.xml
index 0166d53..ae6386c 100644
--- a/plugins/org.eclipse.app4mc.amalthea.import.help/root-tutorial_import-toc.xml
+++ b/plugins/org.eclipse.app4mc.amalthea.import.help/root-tutorial_import-toc.xml
@@ -2,7 +2,7 @@
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="Import Tutorials Root" link_to="../org.eclipse.app4mc.help/mainToc.xml#app4mc.docu.tutorials">
- <link toc="toc/tutorial_atdb_import-toc.xml"/>
-
-
+ <link toc="toc/tutorial_btf_to_atdb_import-toc.xml"/>
+ <link toc="toc/tutorial_amalthea_to_atdb_import-toc.xml"/>
+ <link toc="toc/tutorial_atdb_to_amalthea_import-toc.xml"/>
</toc>
diff --git a/plugins/org.eclipse.app4mc.help/docu/example_atdb.textile b/plugins/org.eclipse.app4mc.help/docu/example_atdb.textile
index 2842a61..1c74c94 100644
--- a/plugins/org.eclipse.app4mc.help/docu/example_atdb.textile
+++ b/plugins/org.eclipse.app4mc.help/docu/example_atdb.textile
@@ -1,4 +1,4 @@
-h3. New AMALTHEA Trace Database (ATDB) Example
+h3. AMALTHEA Trace Database (ATDB) Example
The ATDB provides tables and view definitions to hold trace data and represent it in comprehensive views. In this section we will show a small example BTF trace, convert it to its ATDB equivalent, and enrich it with event chains. The relevant tables and views will given for better understanding.
@@ -6,7 +6,7 @@
The source BTF trace has two cores, three stimuli, three tasks, and four runnables.
-bc. #version 2.2.0
+bc. #version 2.1.5
#timeScale ns
0,ECU_1,-1,SIM,SIM,-1,tag,ECU_INIT
0,Processor_1,-1,SIM,SIM,-1,tag,PROCESSOR_INIT
