MIRA Documentation for Developers

Fundamentals Installation Concepts Build System API Logging Exception Handling Class Factory Time Math Geometry Image more ... Concepts Serialization Authorities Channels Publishing / Subscribing Services and Remote Procedure Calls Transformation Framework Tapes Threading Error monitoring and Diagnostics Units more ... Tutorials List of tutorials Tools mirapackage miracenter mira, miragui miracd, mirals, miramk miratape Reference XML Config All Classes Annotated Class List Class Hierarchy All Files External APIs Eigen 3.0 (Math and Matrix Library) Boost 1.44.0 STL Reference

Overview As a developer you typically like to develop new software modules. Before writing new software you should be familiar with: Basic C++ programming skills The basic concepts of MIRA How to document your code Additionally, MIRA uses several external libraries where the user should at least be able to find and read the corresponding API reference, when necessary: Standard Template Library (STL), which contains commonly used data types and containers (lists, queues, maps) and algorithms (for sorting, etc.) boost, a collection of libraries with even more algorithms, containers, and different concepts Eigen, a library for linear algebra, matrices, vectors, numerical solvers, and related algorithms If you are new to MIRA check out the tutorials. Developing Components MIRA uses shared libraries to achieve a plugin mechanism, where each plugin is a shared library, that can be loaded dynamically at runtime. The plugin concept enables high extensibility and software modularity. To enlarge the functionality of MIRA, plugins for the following extension points can be developed: Units are the main components of the robot applications Visualizations are used to display and render data Views and Editors extend the Rich Client Platform (RCP) which acts as the Graphical User Interface used by miracenter Graphical User Interface The Graphical User Interface (GUI) package contains components and classes for creating visualizations, widgets and tools that allow the user to visualize and manipulate data within the framework, units and other components of the robotic applications. An overview of the components is given here. Rich Client Platform: RCP - Rich client platform ViewParts EditorParts Visualizations: VisualizationView editors Widgets: . Toolboxes Toolboxes contain sets of classes and algorithms. They can be used by units from the domains or by stand-alone applications to perform certain tasks. Dependencies between toolboxes should be avoided if possible. However, it is not prohibited, since there will always be some low-level toolboxes (e.g. image conversion) that are used by high-level toolboxes (e.g. AAM toolbox). The documentations of the following standard toolboxes are available: Furthermore, documentations of the following non-standard toolboxes are available: Domains Domains contain high-level components and units that belong to the same topic or application domain. Those components and units may be used by other components like the application layer to build a complex application. In contrast to toolboxes, the classes and algorithms of domains are NOT accessed directly. Instead, interaction exclusively is done through the communication mechanisms of the MIRA framework (channels and RPC calls). Units of different domains may interact with each other (using the communication mechanisms) but must NOT use each other directly to avoid unwanted code dependencies between domains. The documentations of the following domains are available: