.. _`Preface`:


#######
Preface
#######


About The Modeling Guide
************************

The *Modeling Guide* is included with the Vortex OpenSplice Modeler 
documentation set.

The *Modeling Guide* is intended to be used with the Vortex OpenSplice 
Modeler product suite.


Intended Audience
*****************

The *Modeling Guide* is intended to be used by Vortex OpenSplice Modeler users.


Organisation
************

The *Guide* is organised as follows:

The :ref:`Introduction <Introduction>` explains what the Vortex OpenSplice 
Modeler is, what its advantages and benefits are, and provides general 
information about the Modeler product.

The :ref:`Installation <Installation>` section provides the instructions for 
installing Vortex OpenSplice Modeler.

The :ref:`features and tools <Modeler Described>` of Vortex 
OpenSplice Modeler are then described in detail, and
an outline of their use for modeling and code generation
is given.

The :ref:`Modeling <Modeling>` section describes in 
detail how to use the tools in Vortex OpenSplice Modeler 
for modeling and assembling resources.

The next section, on :ref:`Code Generation <Code Generation>`,
describes how to use the Vortex OpenSplice 
Modeler for generating DDS-compliant source code. 

:ref:`Launch Configurations <Creating Launch Configurations>`,
convenient ways to run and control the Modeler, are
described next.

The following section gives details of how to 
:ref:`compile and run applications <Compiling and Running>`
using Vortex OpenSplice Modeler and Eclipse Workbench. 

There is also a :ref:`Tutorial <Tutorial>`, which uses a DDS-based example 
to demonstrate how to use the basic features of the Vortex OpenSplice 
Modeler modeling tool.

Finaly, two Appendices contain source code in :ref:`Java <Appendix A>` 
and :ref:`C++ <Appendix B>` for the Chatroom example project described 
in the :ref:`Tutorial <Tutorial>`.


Conventions
***********

The icons shown below are used in the Vortex product documentation 
to help readers to quickly identify information relevant to their 
specific use of Vortex OpenSplice.


 ========= ================================================================== 
 *Icon*    *Meaning*  
 ========= ================================================================== 
 |caution| Item of special significance or where caution needs to be taken.  
 |info|    Item contains helpful hint or special information.                
 |windows| Information applies to Windows (*e.g.* XP, 2003, Windows 7) only. 
 |unix|    Information applies to Unix-based systems (*e.g.* Solaris) only.  
 |linux|   Information applies to Linux-based systems (*e.g.* Ubuntu) only.  
 |c|       C language specific.                                              
 |cpp|     C++ language specific.                                            
 |csharp|  C# language specific.                                             
 |java|    Java language specific.                                           
 ========= ================================================================== 




.. |caution| image:: ./images/icon-caution.*
            :height: 6mm
.. |info|   image:: ./images/icon-info.*
            :height: 6mm
.. |windows| image:: ./images/icon-windows.*
            :height: 6mm
.. |unix| image:: ./images/icon-unix.*
            :height: 6mm
.. |linux| image:: ./images/icon-linux.*
            :height: 6mm
.. |c| image:: ./images/icon-c.*
            :height: 6mm
.. |cpp| image:: ./images/icon-cpp.*
            :height: 6mm
.. |csharp| image:: ./images/icon-csharp.*
            :height: 6mm
.. |java| image:: ./images/icon-java.*
            :height: 6mm


