RoFI — Technical Documentation

This document provides the technical documentation for the RoFI Platform. Start by selecting the topic:

Getting Started	Release engineering	RoFI HAL
RoFI Library	RoFICoM	Universal Module

Note that you can preview the development version of the documentation on https://paradise-fi.github.io/RoFI/branch/<git_branch_name>.

Contents:

• Introduction, compiling and structure
  • RoFI Compilation
    • Build environment
    • Compilation suites
      • Desktop Suite
        • Dependencies
        • Build options
      • Documentation Suite
        • Dependencies
        • Build options
    • Compilation targets
    • Flashing robots and hardware modules
    • Advanced configuration of the build process
    • Quick start example
    • Quick start Simulator example
      • GazeboSim
      • SimpleSim
      • Module code
  • Project Structure
  • Writing and running tests
    • Running the test
    • Writing tests
    • Writing test for C++
• Release engineering notes
  • Continuous integration
  • Documentation
• Tutorials
  • Simulator Tutorial
    • Task 0: Setup
      • Compile and run SimpleSim
      • Create a folder for your solution
    • Task 1: Create a Configuration
      • Walkthrough
    • Task 2: Create Hello World for Universal Module
      • Walkthrough
    • Task 3: Move Universal Module
      • Walkthrough
    • Task 4: Multiple Modules with Same Code
      • Walkthrough
    • Task 5: Module Communication
      • Walkthrough
    • Task 6: Packet Filter
      • Walkthrough
• RoFI HAL
  • Types and Constants
  • Classes
  • Networking
• RoFILib
  • Configurations
    • Configuration Usage
      • Flags for Configurations in Tools
      • Parsing Configurations in C++
        • Helper Functions
        • Helper RofiWorld Functions
        • Conversion Functions
        • Multi-Format Conversions
    • Different Configurations
      • RoFI Configuration
        • Usage
        • Example
        • Types and Constants
        • Classes
        • Module Classes
        • Functions
      • Voxel Configuration
        • Explicit Connections
        • Voxel Configuration in Cpp
          • Types, Constants and Support Classes
          • Classes
    • Serializations
      • Json Serialization
        • Format Description
        • Functions
        • Attributes callback
      • Voxel Serialization
        • Json Grammar
  • Atoms
    • Patterns
      • Visitor Pattern
      • Cloneable Object Hiearchy & ValuePtr
    • Containers
      • Classes reference
    • Result
      • Usage
      • Classes reference
      • Functions reference
    • Embedded Resources Management
      • Usage
      • Classes reference
      • Macro reference
• RoFICoM
• Universal Module