Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / intern / itasc / kdl / chain.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_CHAIN_HPP
23 #define KDL_CHAIN_HPP
24
25 #include "segment.hpp"
26 #include <string>
27
28 namespace KDL {
29     /**
30           * \brief This class encapsulates a <strong>serial</strong> kinematic
31           * interconnection structure. It is build out of segments.
32      *
33      * @ingroup KinematicFamily
34      */
35     class Chain {
36     private:
37         std::vector<Segment> segments;
38         unsigned int nrOfJoints;
39         unsigned int nrOfSegments;
40     public:
41         /**
42          * The constructor of a chain, a new chain is always empty.
43          *
44          */
45         Chain();
46         Chain(const Chain& in);
47         Chain& operator = (const Chain& arg);
48
49         /**
50          * Adds a new segment to the <strong>end</strong> of the chain.
51          *
52          * @param segment The segment to add
53          */
54         void addSegment(const Segment& segment);
55         /**
56          * Adds a complete chain to the <strong>end</strong> of the chain
57          * The added chain is copied.
58          *
59          * @param chain The chain to add
60          */
61         void addChain(const Chain& chain);
62
63         /**
64          * Request the total number of joints in the chain.\n
65          * <strong> Important:</strong> It is not the
66          * same as the total number of segments since a segment does not
67          * need to have a joint. This function is important when
68          * creating a KDL::JntArray to use with this chain.
69          * @return total nr of joints
70          */
71         unsigned int getNrOfJoints()const {return nrOfJoints;};
72         /**
73          * Request the total number of segments in the chain.
74          * @return total number of segments
75          */
76         unsigned int getNrOfSegments()const {return nrOfSegments;};
77
78         /**
79          * Request the nr'd segment of the chain. There is no boundary
80          * checking.
81          *
82          * @param nr the nr of the segment starting from 0
83          *
84          * @return a constant reference to the nr'd segment
85          */
86         const Segment& getSegment(unsigned int nr)const;
87
88         virtual ~Chain();
89     };
90
91
92
93 }//end of namespace KDL
94
95 #endif