1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
.TH FASTDDSGEN 1 "" "@VERSION@" "eProsima FastDDS"
.SH NAME
fastddsgen \- IDL source code generator
.SH SYNOPSIS
.SY fastddsgen
.RI [ options ]
.I FILE.idl
.RI [ FILE.idl
.IR .\|.\|. ]
.YS
.SH DESCRIPTION
.B fastddsgen
is a command line tool that generates eProsima Fast DDS source code using the
data types defined in an IDL (Interface Definition Language) file. This
generated source code can be used in any Fast DDS application in order to
define the data type of a topic, which will later be used to publish or
subscribe.
.PP
To declare the structured data, the IDL format must be used. IDL is a specification language, made by OMG (Object Management Group), which describes an interface in a language independent manner, allowing communication between software components that do not share the same language. The eProsima Fast DDS-Gen tool reads the IDL files and parses a subset of the OMG IDL specification to generate source code for data serialization. This subset includes the data type descriptions included in Defining a data type via IDL. The rest of the file content is ignored.
.SH OPTIONS
.B \-help
shows the help information
.TP
.B \-version
shows the current version of
.BR fastddsgen .
.TP
.BR \-d " " \fIDIR\fR
write generated files to
.IR DIR .
.TP
.BR \-I " " \fIDIR\fR
add
.I DIR
to the preprocessor include path.
.TP
.BR \-t " " \fIDIR\fR
use
.I DIR
as temporary directory
.TP
.BR \-example " " \fIPLATFORM\fR
generate an example to compile the generated files for a specific platform.
.TP
.B \-test
add a serialization test to the generated example code
.TP
.BR \-language " "\fILANG\fR
select programming language (default: C++)
.TP
.B \-replace
overwrite existing output files.
.TP
.B \-ppDisable
disable the preprocessor.
.TP
.BR \-ppPath " " \fICPP\fR
use
.I CPP
as preprocessor executable.
.TP
.B \-typeros2
name generated types compliant to ROS 2 conventions.
.TP
.B \-typeobject
generate TypeObject files for the IDL and modify the generated constructor to
register the TypeObject representation into the type factory.
.TP
.B \-cs
apply case-sensitive matching to IDL grammar.
.SH SEE ALSO
.UR https://fast-dds.docs.eprosima.com/en/latest/fastddsgen
.UE
.SH AUTHOR
FastDDS is developed by Proyectos y Sistemas de Mantenimiento SL (eProsima).
This manual page was written for Debian by Timo R\[u00F6]hling.
|
