doxygen: intern/itasc tagged
[blender.git] / intern / itasc / kdl / tree.hpp
1 // Copyright  (C)  2007  Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
2
3 // Version: 1.0
4 // Author: Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
5 // Maintainer: Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
6 // URL: http://www.orocos.org/kdl
7
8 // This library is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU Lesser General Public
10 // License as published by the Free Software Foundation; either
11 // version 2.1 of the License, or (at your option) any later version.
12
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 // Lesser General Public License for more details.
17
18 // You should have received a copy of the GNU Lesser General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21
22 #ifndef KDL_TREE_HPP
23 #define KDL_TREE_HPP
24
25 #include "segment.hpp"
26 #include "chain.hpp"
27
28 #include <string>
29 #include <map>
30
31 namespace KDL
32 {
33     //Forward declaration
34     class TreeElement;
35     typedef std::map<std::string,TreeElement> SegmentMap;
36
37     class TreeElement
38     {
39     private:
40         TreeElement():q_nr(0)
41         {};
42     public:
43         Segment segment;
44         unsigned int q_nr;
45         SegmentMap::const_iterator  parent;
46         std::vector<SegmentMap::const_iterator > children;
47         TreeElement(const Segment& segment_in,const SegmentMap::const_iterator& parent_in,unsigned int q_nr_in)
48         {
49                         q_nr=q_nr_in;
50             segment=segment_in;
51             parent=parent_in;
52         };
53         static TreeElement Root()
54         {
55             return TreeElement();
56         };
57     };
58
59     /**
60      * \brief  This class encapsulates a <strong>tree</strong>
61      * kinematic interconnection structure. It is build out of segments.
62      *
63      * @ingroup KinematicFamily
64      */
65     class Tree
66     {
67     private:
68         SegmentMap segments;
69         unsigned int nrOfJoints;
70         unsigned int nrOfSegments;
71
72         bool addTreeRecursive(SegmentMap::const_iterator root, const std::string& tree_name, const std::string& hook_name);
73
74     public:
75         /**
76          * The constructor of a tree, a new tree is always empty
77          */
78         Tree();
79         Tree(const Tree& in);
80         Tree& operator= (const Tree& arg);
81
82         /**
83          * Adds a new segment to the end of the segment with
84          * hook_name as segment_name
85          *
86          * @param segment new segment to add
87          * @param segment_name name of the new segment
88          * @param hook_name name of the segment to connect this
89          * segment with.
90          *
91          * @return false if hook_name could not be found.
92          */
93         bool addSegment(const Segment& segment, const std::string& segment_name, const std::string& hook_name);
94
95         /**
96          * Adds a complete chain to the end of the segment with
97          * hook_name as segment_name. Segment i of
98          * the chain will get chain_name+".Segment"+i as segment_name.
99          *
100          * @param chain Chain to add
101          * @param chain_name name of the chain
102          * @param hook_name name of the segment to connect the chain with.
103          *
104          * @return false if hook_name could not be found.
105          */
106         bool addChain(const Chain& chain, const std::string& chain_name, const std::string& hook_name);
107
108         /**
109          * Adds a complete tree to the end of the segment with
110          * hookname as segment_name. The segments of the tree will get
111          * tree_name+segment_name as segment_name.
112          *
113          * @param tree Tree to add
114          * @param tree_name name of the tree
115          * @param hook_name name of the segment to connect the tree with
116          *
117          * @return false if hook_name could not be found
118          */
119         bool addTree(const Tree& tree, const std::string& tree_name,const std::string& hook_name);
120
121         /**
122          * Request the total number of joints in the tree.\n
123          * <strong> Important:</strong> It is not the same as the
124          * total number of segments since a segment does not need to have
125          * a joint.
126          *
127          * @return total nr of joints
128          */
129         unsigned int getNrOfJoints()const
130         {
131             return nrOfJoints;
132         };
133
134         /**
135          * Request the total number of segments in the tree.
136          * @return total number of segments
137          */
138         unsigned int getNrOfSegments()const {return nrOfSegments;};
139
140         /**
141          * Request the segment of the tree with name segment_name.
142          *
143          * @param segment_name the name of the requested segment
144          *
145          * @return constant iterator pointing to the requested segment
146          */
147         SegmentMap::const_iterator getSegment(const std::string& segment_name)const
148         {
149             return segments.find(segment_name);
150         };
151
152
153
154         const SegmentMap& getSegments()const
155         {
156             return segments;
157         }
158
159         virtual ~Tree(){};
160     };
161 }
162 #endif
163
164
165
166
167