RoboCLuedo #2

README

  • the project main README

Packages Documentation

  • PKG DOCS – robocluedo armor
    • aRMOR commands
    • DOCS – how to run robocluedo armor
    • DOCS – HOW TO use RoboCLuedo aRMOR interface
    • UML – aRMOR Interface design elements
    • CLASS armor_cluedo.cpp
    • CLASS armor_tools.cpp
    • NODE cluedo_armor_interface.cpp
    • ARMOR CLUEDO EXAMPLES – 1 – Working on Individuals
    • ARMOR CLUEDO EXAMPLES – 2 – Working with properties
    • ARMOR TOOLS EXAMPLES – 3 – Reasoning Workflow
    • ARMOR TOOLS EXAMPLES – 1 – Essential usage of ArmorTools
    • ARMOR TOOLS EXAMPLES – 2 – The quickest way to use ArmorTools
  • PKG DOCS – robocluedo_armor_msgs
  • PKG DOCS – robocluedo_rosplan
  • PKG DOCS – robocluedo_rosplan_msgs
  • PKG DOCS – robocluedo_movement_controller
  • PKG DOCS – robocluedo_movement_msgs
  • PKG DOCS – robocluedo_mission_manager
  • PKG DOCS – RoboCLuedo Module Testing

Dependencies Documentation

  • Oracle2 – User Documentation
  • the RoboCLuedo URDF model – User Manual
  • WORLDS – a collection of Gazebo World Files

Other Documents

  • RCL#2 SETUP
  • RCL#2 RUN
  • Development LOG
  • How to setup Sphinx
  • ReStructured Directives – practical documentation
  • Sphinx for Py – modules mocking

Extensions and other references

  • PlantUML quick reference
RoboCLuedo #2
  • »
  • PKG DOCS – robocluedo armor
  • View page source

PKG DOCS – robocluedo armor

this package contains nodes and libraries to communicate with the aRMOR ontology in a more convenient way.

Note

see the official project on GitHub : aRMOR on GitHub

User Documentation

  • aRMOR commands
    • Main directives
    • “QUERY CLASS IND” buggy
  • DOCS – how to run robocluedo armor
    • Ontology paths configuration
    • launch file
      • expected output
  • DOCS – HOW TO use RoboCLuedo aRMOR interface
    • services schematics
    • ADD – register a new hint into the Ontology
    • FIND – ask for a consistent hint
    • DEL – discard a hypothesis

UML diagrams

  • UML – aRMOR Interface design elements
    • aRMOR interface services
      • ADD
      • FIND
      • DEL
      • BACKUP
    • aRMOR services
    • aRMOR interfaces structure
      • package aRMOR
      • aRMOR interface component
    • THE COMPLETE SCHEMATIC

code reference

  • CLASS armor_cluedo.cpp
    • class aRMOR CLuedo – header
    • class aRMOR CLuedo – cpp implementation
  • CLASS armor_tools.cpp
    • class aRMOR Tools – header
    • class aRMOR Tools – cpp implementation
  • NODE cluedo_armor_interface.cpp

Code Examples

  • ARMOR CLUEDO EXAMPLES – 1 – Working on Individuals
    • Working on Individuals
  • ARMOR CLUEDO EXAMPLES – 2 – Working with properties
    • Working with properties
  • ARMOR TOOLS EXAMPLES – 3 – Reasoning Workflow
    • Reasoning Workflow
  • ARMOR TOOLS EXAMPLES – 1 – Essential usage of ArmorTools
    • Essential usage of ArmorTools
    • a more advanced example
  • ARMOR TOOLS EXAMPLES – 2 – The quickest way to use ArmorTools
    • The quickest way to use ArmorTools
Previous Next

© Copyright 2022, Francesco Ganci.

Built with Sphinx using a theme provided by Read the Docs.