FASTDDSGEN(1)

📦
version 4.3.0.0 · 5 versions
, in ubuntu stonking

✨ fastddsgen — the manual, but make it cute ✨

okay bestie, this is the eProsima FastDDS page for fastddsgen, and I'm gonna walk you through every single bit of it, no cap. 💖

🎀 NAME 🎀

fastddsgen — the IDL source code generator. it makes code for you. iconic behavior honestly.

🌸 SYNOPSIS 🌸

fastddsgen [options] FILE.idl [FILE.idl ...]

yeah that's it. options, then one or more .idl files. slay.

🦋 DESCRIPTION 🦋

so fastddsgen is a command line tool that generates eProsima Fast DDS source code, and it does it from the data types you define in an IDL (Interface Definition Language) file. 🫶

like, why do you care? because that generated source code can be dropped into any Fast DDS application to define the data type of a topic — and that topic is what you'll later use to publish or subscribe. main character move, honestly.

to declare your structured data, you gotta use the IDL format. IDL is a specification language made by OMG (Object Management Group) — it describes an interface in a language independent kinda way, which lets software components that do NOT share the same language still talk to each other. friendship bracelets for compilers. 🧚

the eProsima Fast DDS-Gen tool reads your IDL files and parses a subset of the OMG IDL specification to generate source code for data serialization. this subset covers the data type descriptions included in Defining a data type via IDL. and the rest of the file content? ignored. not even a vibe check. 💅

💅 OPTIONS 💅

  • -help — shows the help information. your bestie when you're lost.
  • -version — shows the current version of fastddsgen.
  • -d DIR — write generated files to DIR.
  • -I DIR — add DIR to the preprocessor include path.
  • -t DIR — use DIR as temporary directory.
  • -example PLATFORM — generate an example to compile the generated files for a specific platform.
  • -test — add a serialization test to the generated example code.
  • -language LANG — select programming language (default: C++).
  • -replace — overwrite existing output files. be careful, it really does just steamroll them. 😭
  • -ppDisable — disable the preprocessor.
  • -ppPath CPP — use CPP as preprocessor executable.
  • -typeros2 — name generated types compliant to ROS 2 conventions.
  • -typeobject — generate TypeObject files for the IDL and modify the generated constructor to register the TypeObject representation into the type factory.
  • -cs — apply case-sensitive matching to IDL grammar.

🌈 SEE ALSO 🌈

go read the docs, iykyk. 👑

👑 AUTHOR 👑

FastDDS is developed by Proyectos y Sistemas de Mantenimiento SL (eProsima). this manual page was written for Debian by Timo Röhling. absolute legends, both of them. 🥹

and that's the whole page bestie, we ate. this was eProsima FastDDS, version 4.3.0.0+dfsg, and if you ever need me again you know exactly where to find me — same manual, same FASTDDSGEN(1). periodt. 💖✨🦋🎀

📦 where this page comes from