2. Usage
This section explains the usage of Fast DDS-Gen tool and briefly describes the generated files.
2.1. Running the Fast DDS-Gen Java application
First, the steps outlined in Linux installation of Fast DDS-Gen or
Window installation of Fast DDS-Gen must be accomplished for the installation of Fast DDS-Gen.
According to this section, an executable file for Linux and Windows that runs the Java Fast DDS-Gen application is
available in the scripts
folder.
If the scripts
folder path is added to the PATH
environment variable, Fast DDS-Gen can be executed running
the following commands:
Linux:
$ fastddsgen
Windows:
> fastddsgen.bat
Note
In case the PATH has not been modified, these scripts can be found in the <fastddsgen_directory>/scripts
directory.
2.2. Supported options
The expected argument list of the application is:
fastddsgen [<options>] <IDL file> [<IDL file> ...]
Where the options are:
Option |
Description |
---|---|
-cs |
Enables case sensitivity in variable names. |
-d <directory> |
Sets the output directory for the generated files. |
-default-container-prealloc-size |
Sets the default preallocated size for unbounded collections (sequences and maps) |
-default_extensibility <extensibility> |
Sets the default extensibility for types without the @extensibility annotation. |
-example <platform> |
Generates an example and a solution to compile the generated source code for a specific |
-extrastg <template> <output> |
Specifies a custom template used for generating source code. |
-flat-output-dir |
Ignores input files relative paths and place all generated files in the specified output directory. |
-help |
Shows the help information |
-I <directory> |
Adds directory to preprocessor include paths. |
-no-typesupport |
Avoids generating the type support files. |
-no-typeobjectsupport |
Avoids generating the TypeObject support specific files. |
-no-dependencies |
Avoids processing the dependent IDL files. |
-ppDisable |
Disables the preprocessor. |
-ppPath |
Specifies the preprocessor path. |
-python |
Generates source code and a CMake solution to compile a library containing the data types |
-replace |
Replaces the generated source code files even if they exist. |
-t <directory> |
Sets a specific directory as a temporary directory. |
-typeros2 |
Generates type naming compatible with ROS 2. |
-version |
Shows the current version of eProsima Fast DDS-Gen. |
Please refer to XTypes for more information on TypeObject representation.