Skip to content
Snippets Groups Projects
Commit 3eb73e6a authored by Christian Mandery's avatar Christian Mandery
Browse files

Naming conventions

parent af572c5a
Loading
/**
<!-- \addtogroup RobotAPI-HowTos -->
\page RobotAPI-HowTos-RemoteRobot Robot State and Remote Robot
\ingroup RobotAPI-HowTos
\section RobotAPI-HowTos-RemoteRobot-Start Starting a RobotStateComponent
<!-- \ingroup RobotAPI-HowTos-RemoteRobot -->
The RobotState component serves as a central component for storing all robot related data. For now this data covers the current joint angles of the robot.<br>
The RobotStateComponent implements a KinematicUnitListener, hence it reacts on all joint updates that are reported by a KinematicUnit component. An exemplary startup script could look like this
......@@ -36,7 +33,6 @@ ArmarX.RobotStateComponent.ObjectName = RobotStateComponent
\section RobotAPI-HowTos-RemoteRobot-Access Accessing the RobotStateComponent
<!-- \ingroup RobotAPI-HowTos-RemoteRobot -->
The RobotStateComponent provides several methods for accessing the current configuration of the robot and for getting a snapshot of the current state which is compatible with
models of the Simox/VirtualRobot framework. With these models the whole functionality of Simox (http://simox.sf.net) can be used, e.g. IK solving, collision detection or motion and grasp planning.
......
/**
\defgroup MotionControl ArmarX MotionControl
\ingroup robotapi-states
\defgroup RobotAPI-MotionControl RobotAPI MotionControl
\ingroup RobotAPI
\section Overview Overview of the implemented functionality in MotionControl
All functionality is implemented with State to provide a convenient interface
......
/**
\defgroup SensorActorUnits Sensor-Actor Units
\ingroup api-robotapi
\defgroup RobotAPI-SensorActorUnits RobotAPI Sensor-Actor Units
\ingroup RobotAPI
Sensor-Actor units
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment