### Navigation

- index
- next |
- previous |
- Modeling Guide »

# 1. Preface

## 1.1. 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.

## 1.2. Intended Audience

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

## 1.3. Organisation

The Guide is organised as follows:

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

The Installation section provides the instructions for installing Vortex OpenSplice Modeler.

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

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

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

Launch Configurations, convenient ways to run and control the Modeler, are described next.

The following section gives details of how to compile and run applications using Vortex OpenSplice Modeler and Eclipse Workbench.

There is also a 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 Java and C++ for the Chatroom example project described in the Tutorial.

## 1.4. 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
> --- | ---
> | Item of special significance or where caution needs to be taken.
> | Item contains helpful hint or special information.
> | Information applies to Windows (e.g. XP, 2003, Windows 7) only.
> | Information applies to Unix-based systems (e.g. Solaris) only.
> | Information applies to Linux-based systems (e.g. Ubuntu) only.
> | C language specific.
> | C++ language specific.
> | C# language specific.
> | Java language specific.

### Navigation

- index
- next |
- previous |
- Modeling Guide »