From 5f8e1ffc267401ca96e996a5a2aa8fda0804d159 Mon Sep 17 00:00:00 2001
From: Leonard <Leonard.Westkamp@gmail.com>
Date: Thu, 23 Jun 2016 12:02:32 +0200
Subject: [PATCH] [doc] Information and link for help on getting proxies.
---
etc/doxygen/pages/armarpose.dox | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/etc/doxygen/pages/armarpose.dox b/etc/doxygen/pages/armarpose.dox
index 46c1aee89..1b2b13736 100644
--- a/etc/doxygen/pages/armarpose.dox
+++ b/etc/doxygen/pages/armarpose.dox
@@ -32,7 +32,7 @@ The agent name can be retrieved via the \ref armarx::RobotStateComponent like th
So an example code for creating a new FramedPosition looks like this:
\code
- RobotStateComponentInterfacePrx robotStateInterfacePrx = ....; // you need to have this proxy, see \ref ArmarXCore-HowTos-GetProxy "get a proxy"
+ RobotStateComponentInterfacePrx robotStateInterfacePrx = ....; // you need to have this proxy
SharedRobotInterfacePrx robot = robotStateInterfacePrx->getSynchronizedRobot();
std::strning agentName = robotStateInterfacePrx->getRobotName();
std::string frame = robot->getRoot()->getName();
@@ -41,6 +41,8 @@ So an example code for creating a new FramedPosition looks like this:
armarx::FramedPositionPtr position = new armarx::FramedPosition(pos, frame, agentName);
\endcode
+Refer to the Howto at \ref ArmarXCore-HowTos-GetProxy "get a proxy" to learn how to obtain a proxy.
+
\section FramedPose-ChangeFrame Change the frame of a FramedPosition
In ArmarX the most common coordinate type is the FramedX, e.g. FramedPosition.
To change the frame in this coordinate type, you can call \ref armarx::FramedPosition::changeFrame "changeFrame()" on the FramedPosition.
--
GitLab