tree.hpp

Go to the documentation of this file.

// Copyright  (C)  2007  Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
 
// Version: 1.0
// Author: Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
// Maintainer: Ruben Smits <ruben dot smits at mech dot kuleuven dot be>
// URL: http://www.orocos.org/kdl
 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
#ifndef KDL_TREE_HPP
#define KDL_TREE_HPP
 
#include "segment.hpp"
#include "chain.hpp"
 
#include <string>
#include <map>
#include <Eigen/Core>
 
namespace KDL
{
    //Forward declaration
    class TreeElement;
    // Eigen allocator is needed for alignment of Eigen data types
    typedef std::map<std::string,TreeElement, std::less<std::string>, Eigen::aligned_allocator<std::pair<const std::string, TreeElement> > > SegmentMap;
 
    class TreeElement
    {
    public:
        TreeElement():q_nr(0),parent(0)
        {};
    public:
        Segment segment;
        unsigned int q_nr;
        SegmentMap::value_type const *parent;
        std::vector<SegmentMap::const_iterator > children;
        TreeElement(const Segment& segment_in,const SegmentMap::value_type& parent_in,unsigned int q_nr_in)
        {
            q_nr=q_nr_in;
            segment=segment_in;
            parent=&parent_in;
        };
        static TreeElement Root()
        {
            return TreeElement();
        };
    };
 
    class Tree
    {
    private:
        SegmentMap segments;
        unsigned int nrOfJoints;
        unsigned int nrOfSegments;
 
        bool addTreeRecursive(SegmentMap::const_iterator root, const std::string& tree_name, const std::string& hook_name);
 
    public:
        Tree();
        Tree(const Tree& in);
        Tree& operator= (const Tree& arg);
 
        bool addSegment(const Segment& segment, const std::string& segment_name, const std::string& hook_name);
 
        bool addChain(const Chain& chain, const std::string& chain_name, const std::string& hook_name);
 
        bool addTree(const Tree& tree, const std::string& tree_name,const std::string& hook_name);
 
        unsigned int getNrOfJoints()const
        {
            return nrOfJoints;
        };
 
        unsigned int getNrOfSegments()const {return nrOfSegments;};
 
        SegmentMap::const_iterator getSegment(const std::string& segment_name)const
        {
            return segments.find(segment_name);
        };
 
        SegmentMap::value_type const* getSegmentPtr(const std::string& segment_name)const
        {
            SegmentMap::const_iterator it = segments.find(segment_name);
            
            if (it == segments.end())
                return 0;
 
            return &*it;
        };
 
        const SegmentMap& getSegments()const
        {
            return segments;
        }
 
        virtual ~Tree(){};
    };
}
#endif