INTRODUCTION
Overview
Download and Install
Quick Start
Documentation
Publications

NONFRAMEWORK CODE
Driver Interfaces
Drivers
Libraries
Utilities

FRAMEWORK CODE
Interfaces
Components
Libraries
Utilities

Full Software Listings

DEVELOPER
Tutorials
Examples
Dev Guide
Dashboard

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

libOrcaDef
[Libraries]

Parses component definition files. More...

Parses component definition files.

Development status
Well tested.

Overview

This namespace is part of a library which parses component definition files. One use of this library is to build the .cfg files.

An example .def file, which shows the .def format, is shown below:

#
# Component Configuration
# -----------------------
#
# Format:
#   DefaultComponentTag=DefTestInput                            (REQUIRED)
#   DefaultComponentEndpoints=DefTestInput                      (optional)
#   Component.Comment.1=Line 1 of comments about this component (optional)
#   Component.Comment.2=Line 2 of comments about this component (optional)
# Note: Any number of comment lines can be used, just keep incrementing the number.

DefaultComponentTag=DefTestInput
DefaultComponentEndpoints=
Component.Comment.1=Line 1 of comments about this component
Component.Comment.2=Line 2 of comments about this component

# Provided Interfaces
# -------------------
#
# Format: 
#   Provides.<InterfaceTag>.Type=<type>                     (REQUIRED)
#   Provides.<InterfaceTag>.DefaultName=<name>              (optional)

Provides.Laser.Type=LaserScanner2d
Provides.Laser.DefaultName=laser

Provides.Platform2d.Type=Odometry2d

# Required Interfaces
# -------------------
#
# Format 1 : Direct Proxy
#   Requires.<InterfaceTag>.Type=<type>                     (REQUIRED)
#   Requires.<InterfaceTag>.DefaultProxy=<name>:<endpoint>  (optional)

Requires.Interface1.Type=Odometry2d
Requires.Interface1.DefaultProxy=odometry2d:tcp -h localhost -p 15000

#
# Format 2 : Indirect Proxy
#   Requires.<InterfaceTag>.Type=<type>                        (REQUIRED)
#   Requires.<InterfaceTag>.DefaultProxy=<name>@<platf>/<comp> (optional)

Requires.Interface2.Type=Odometry2d
Requires.Interface2.DefaultProxy=odometry2d@local/odometry2d

#
# Config Parameters
# -----------------
#
# Format:
#   Config.<ParamTag>.Default=xxx                (REQUIRED)
#   Config.<ParamTag>.Comment=xxx                (optional)
#   Config.<ParamTag>.Type=xxx                   (optional)
#   Config.<ParamTag>.External=xxx               (optional)

Config.Max.Default=default value
Config.Max.Comment=The max blah
Config.Max.Type=string
#
# This syntax is OBSOLETE, use ExternalConfig tag
#
Config.Max.External=0

Config.Min.Default=another default value

#
# This syntax is OBSOLETE, use ExternalConfig tag
#
Config.External.One.Two.Default=another default value
Config.External.One.Two.External=1

# This is the new syntax for external config parameters
ExternalConfig.External.Avg.Default=99

For a full list of functions and classes see orcadef.

Header file:

#include <orcadef/orcadef.h>
Responsible Developer
Alex Brooks
 

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)


Generated for Orca Robotics by  doxygen 1.4.5