1. Preface — IDL PreProcessor Guide

### Navigation

- index
- next |
- previous |
- IDL PreProcessor Guide »

# 1. Preface

## 1.1. About the IDL PreProcessor Guide

The IDL Pre-processor Guide describes what the Vortex OpenSplice IDL Pre-processor is, and how to use it.

The Vortex OpenSplice IDL Pre-processor is included with the Vortex OpenSplice product.

## 1.2. Intended Audience

The IDL Pre-processor Guide is intended to be used by developers creating applications which use Vortex OpenSplice.

## 1.3. Organisation

The Overview gives a general description of and brief introduction to the IDL Pre-processor.

Prerequisites describes the prerequisites needed to run the pre-processor.

IDL Pre-processor Command Line Options gives detailed descriptions of the options that are available for running the pre-processor.

OpenSplice Modes and Languages provides a summary of OpenSplice’s supported modes and languages, as well as an overview of the applicable Vortex OpenSplice libraries.

IDL Pre-processor Grammar shows the IDL grammar that is supported by the Vortex OpenSplice IDL Pre-processor.

Keys describes the mechanism for the use of keys with particular data types.

Modes, Languages and Processing steps describes the steps required for creating programs for each of the modes and languages supported by the Pre-processor.

Extensible and Dynamic Topic Types for DDS annotation support describes how the IDL Pre-processor handles the annotation language extension.

Built-in DDS data types describes the built-in DDS data types and provides language-specific guidelines on how to use them.

Finally, there is a bibliography which lists all of the publications referred to in this Guide.

## 1.4. Conventions

The icons shown below are used in ADLINK 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 |
- IDL PreProcessor Guide »