Base class for recursion parameters passed during traversal of a URDF tree. Encapsulates data carried within a recursion. At each recursion, the according fields link and level are set. Any subclass can add their own recursion parameters to pass through all recursions. A subclass of this type may for example be used to build the result of the traversal. More...
#include <RecursionParams.h>
Public Types | |
| typedef baselib_binding::shared_ptr < RecursionParams >::type | Ptr |
Public Member Functions | |
| unsigned int | getLevel () const |
| LinkPtr | getLink () const |
| RecursionParams & | operator= (const RecursionParams &o) |
| RecursionParams () | |
| RecursionParams (const RecursionParams &o) | |
| virtual | ~RecursionParams () |
Protected Member Functions | |
| RecursionParams (LinkPtr &_link, unsigned int _level) | |
| void | setParams (const LinkPtr &_link, int _level) |
Protected Attributes | |
| unsigned int | level |
| LinkPtr | link |
Friends | |
| class | UrdfTraverser |
Detailed Description
Base class for recursion parameters passed during traversal of a URDF tree. Encapsulates data carried within a recursion. At each recursion, the according fields link and level are set. Any subclass can add their own recursion parameters to pass through all recursions. A subclass of this type may for example be used to build the result of the traversal.
Definition at line 51 of file RecursionParams.h.
Member Typedef Documentation
| typedef baselib_binding::shared_ptr<RecursionParams>::type urdf_traverser::RecursionParams::Ptr |
Reimplemented in urdf_traverser::StringVectorRecursionParams, urdf_traverser::FlagRecursionParams, urdf_traverser::FactorRecursionParams, urdf_traverser::LinkRecursionParams, urdf_traverser::ModelRecursionParams, and OrderedJointsRecursionParams.
Definition at line 55 of file RecursionParams.h.
Constructor & Destructor Documentation
| urdf_traverser::RecursionParams::RecursionParams | ( | ) | [inline, explicit] |
Definition at line 57 of file RecursionParams.h.
| urdf_traverser::RecursionParams::RecursionParams | ( | const RecursionParams & | o | ) | [inline, explicit] |
Definition at line 58 of file RecursionParams.h.
| virtual urdf_traverser::RecursionParams::~RecursionParams | ( | ) | [inline, virtual] |
Definition at line 61 of file RecursionParams.h.
| urdf_traverser::RecursionParams::RecursionParams | ( | LinkPtr & | _link, |
| unsigned int | _level | ||
| ) | [inline, explicit, protected] |
Definition at line 84 of file RecursionParams.h.
Member Function Documentation
| unsigned int urdf_traverser::RecursionParams::getLevel | ( | ) | const [inline] |
Returns the current level in the tree (distance to link on which traversal was started)
Definition at line 78 of file RecursionParams.h.
| LinkPtr urdf_traverser::RecursionParams::getLink | ( | ) | const [inline] |
Definition at line 70 of file RecursionParams.h.
| RecursionParams& urdf_traverser::RecursionParams::operator= | ( | const RecursionParams & | o | ) | [inline] |
Definition at line 63 of file RecursionParams.h.
| void urdf_traverser::RecursionParams::setParams | ( | const LinkPtr & | _link, |
| int | _level | ||
| ) | [inline, protected] |
Definition at line 90 of file RecursionParams.h.
Friends And Related Function Documentation
friend class UrdfTraverser [friend] |
Definition at line 53 of file RecursionParams.h.
Member Data Documentation
unsigned int urdf_traverser::RecursionParams::level [protected] |
Definition at line 100 of file RecursionParams.h.
LinkPtr urdf_traverser::RecursionParams::link [protected] |
Definition at line 97 of file RecursionParams.h.
The documentation for this class was generated from the following file: