Package rst.robot

Not documented

Messages

digraph message_graph {
fontname="Arial";
fontsize=11;
stylesheet="../_static/corlab.css";
  node [fontsize=11]
  node [fontname="Arial"]
  edge [fontsize=11]
  edge [fontname="Arial"]
  "1" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision" TITLE="Structure rst.robot.RobotCollision" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">RobotCollision</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind" TITLE="Enum rst.robot.RobotCollision.CollisionKind" TARGET="_parent">CollisionKind</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.kind" TITLE="Field rst.robot.RobotCollision.kind" TARGET="_parent" PORT="kind">kind</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.ObjectCollision" TITLE="Structure rst.kinematics.ObjectCollision" TARGET="_parent">ObjectCollision</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.collision_detail" TITLE="Field rst.robot.RobotCollision.collision_detail" TARGET="_parent" PORT="collision_detail">collision_detail</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
  "3" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.ObjectCollision" TITLE="Structure rst.kinematics.ObjectCollision" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">ObjectCollision</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.CollisionGeometry" TITLE="Structure rst.kinematics.CollisionGeometry" TARGET="_parent">CollisionGeometry</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.ObjectCollision.geometry" TITLE="Field rst.kinematics.ObjectCollision.geometry" TARGET="_parent" PORT="geometry">geometry</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.ObjectCollision.object_1" TITLE="Field rst.kinematics.ObjectCollision.object_1" TARGET="_parent" PORT="object_1">object_1</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.ObjectCollision.object_2" TITLE="Field rst.kinematics.ObjectCollision.object_2" TARGET="_parent" PORT="object_2">object_2</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
  "4" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.CollisionGeometry" TITLE="Structure rst.kinematics.CollisionGeometry" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">CollisionGeometry</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation" TITLE="Structure rst.geometry.Translation" TARGET="_parent">Translation</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-kinematics.html#rst.kinematics.CollisionGeometry.contact_points" TITLE="Field rst.kinematics.CollisionGeometry.contact_points" TARGET="_parent" PORT="contact_points">contact_points</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
  "5" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation" TITLE="Structure rst.geometry.Translation" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/message.svg" /></TD><TD ALIGN="LEFT">Translation</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.x" TITLE="Field rst.geometry.Translation.x" TARGET="_parent" PORT="x">x</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.y" TITLE="Field rst.geometry.Translation.y" TARGET="_parent" PORT="y">y</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-FLOAT64.html#FLOAT64" TITLE="Fundamental FLOAT64" TARGET="_parent">FLOAT64</TD><TD ALIGN="left" HREF="../generated/stable/package-rst-geometry.html#rst.geometry.Translation.z" TITLE="Field rst.geometry.Translation.z" TARGET="_parent" PORT="z">z</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
  "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind" TITLE="Enum rst.robot.RobotCollision.CollisionKind" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="RIGHT"><IMG SRC="../_static/enum.svg" /></TD><TD ALIGN="LEFT">CollisionKind</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind.SELF" TITLE="Singleton rst.robot.RobotCollision.CollisionKind.SELF" TARGET="_parent">SELF</TD><TD ALIGN="right" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind.SELF" TITLE="Singleton rst.robot.RobotCollision.CollisionKind.SELF" TARGET="_parent">1</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind.EXTERNAL" TITLE="Singleton rst.robot.RobotCollision.CollisionKind.EXTERNAL" TARGET="_parent">EXTERNAL</TD><TD ALIGN="right" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind.EXTERNAL" TITLE="Singleton rst.robot.RobotCollision.CollisionKind.EXTERNAL" TARGET="_parent">2</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind.UNKNOWN" TITLE="Singleton rst.robot.RobotCollision.CollisionKind.UNKNOWN" TARGET="_parent">UNKNOWN</TD><TD ALIGN="right" HREF="../generated/stable/package-rst-robot.html#rst.robot.RobotCollision.CollisionKind.UNKNOWN" TITLE="Singleton rst.robot.RobotCollision.CollisionKind.UNKNOWN" TARGET="_parent">3</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"];
  "1" -> "2" [dir=both,arrowtail=odiamond];
  "1":collision_detail -> "3" [];
  "1":kind -> "2" [];
  "3":geometry -> "4" [];
  "4":contact_points -> "5" [];
}

clearer: should be made invisible via css

Message RobotCollision

class rst.robot.RobotCollision

Holds information about a collision between a robot and an object.

Code author: Daniel Seidel <dseidel@techfak.uni-bielefeld.DE>

kind
Type :rst.robot.RobotCollision.CollisionKind

Kind of collision.

Determines interpretation of collision_detail.

collision_detail
Type :rst.kinematics.ObjectCollision

Object and geometry information for the collision.

For self collisions (SELF), <Could not resolve reference to .collision_detail.object_1> and <Could not resolve reference to .collision_detail.object_2> designate the colliding parts of the robot.

For collisions with environment objects (EXTERNAL), <Could not resolve reference to .collision_detail.object_1> and <Could not resolve reference to .collision_detail.object_2> designate the colliding robot part and the environment object respectively.

Download this file

message RobotCollision {

    /**
     * Possible kinds of collisions.
     */
    enum CollisionKind {

        /**
         * Two parts of the robot collide with each other.
         */
        SELF = 1;

        /**
         * The robot collides with an environment object which is not
         * part of the robot.
         */
        EXTERNAL = 2;

        /**
         * The kind of the collision is not known.
         */
        UNKNOWN  = 3;

    }

    /**
     * Kind of collision.
     *
     * Determines interpretation of @ref .collision_detail.
     */
    required CollisionKind kind = 1;

    /**
     * Object and geometry information for the collision.
     *
     * For self collisions (@ref .CollisionKind.SELF), @ref
     * .collision_detail.object_1 and @ref .collision_detail.object_2
     * designate the colliding parts of the robot.
     *
     * For collisions with environment objects (@ref
     * .CollisionKind.EXTERNAL), @ref .collision_detail.object_1 and
     * @ref .collision_detail.object_2 designate the colliding robot
     * part and the environment object respectively.
     */
    required kinematics.ObjectCollision collision_detail = 2;

}

Message CollisionKind

class rst.robot.RobotCollision.CollisionKind

Possible kinds of collisions.

SELF
= 1

Two parts of the robot collide with each other.

EXTERNAL
= 2

The robot collides with an environment object which is not part of the robot.

UNKNOWN
= 3

The kind of the collision is not known.

Download this file

    enum CollisionKind {

        /**
         * Two parts of the robot collide with each other.
         */
        SELF = 1;

        /**
         * The robot collides with an environment object which is not
         * part of the robot.
         */
        EXTERNAL = 2;

        /**
         * The kind of the collision is not known.
         */
        UNKNOWN  = 3;

    }

Table Of Contents

Related Documentation

This Page