Program Listing for File PlannerData.h

↰ Return to documentation for file (src/ompl/control/PlannerData.h)

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2011, Rice University
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the Rice University nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/

/* Author: Mark Moll */

#ifndef OMPL_CONTROL_PLANNER_DATA_
#define OMPL_CONTROL_PLANNER_DATA_

#include "ompl/base/PlannerData.h"
#include "ompl/control/SpaceInformation.h"
#include "ompl/control/Control.h"
#include <boost/serialization/base_object.hpp>

namespace ompl
{
    namespace control
    {
        class PlannerDataEdgeControl : public base::PlannerDataEdge
        {
        public:
            PlannerDataEdgeControl(const Control *c, double duration) : c_(c), duration_(duration)
            {
            }
            PlannerDataEdgeControl(const PlannerDataEdgeControl &rhs) : c_(rhs.c_), duration_(rhs.duration_)
            {
            }

            ~PlannerDataEdgeControl() override = default;

            base::PlannerDataEdge *clone() const override
            {
                return static_cast<base::PlannerDataEdge *>(new PlannerDataEdgeControl(*this));
            }

            const Control *getControl() const
            {
                return c_;
            }
            double getDuration() const
            {
                return duration_;
            }

            bool operator==(const PlannerDataEdge &rhs) const override
            {
                const auto *rhsc = static_cast<const PlannerDataEdgeControl *>(&rhs);
                if (c_ == rhsc->c_)
                    return static_cast<const PlannerDataEdge>(*this) == rhs;
                return false;
            }

        protected:
            friend class boost::serialization::access;
            friend class PlannerDataStorage;
            friend class PlannerData;

            PlannerDataEdgeControl() = default;

            template <class Archive>
            void serialize(Archive &ar, const unsigned int /*version*/)
            {
                ar &boost::serialization::base_object<base::PlannerDataEdge>(*this);
                ar & duration_;
                // Serializing the control is handled by control::PlannerDataStorage
            }

            const Control *c_{nullptr};
            double duration_;
        };

        class PlannerData : public base::PlannerData
        {
        public:
            PlannerData(const SpaceInformationPtr &siC);
            ~PlannerData() override;

            bool removeVertex(const base::PlannerDataVertex &st) override;
            bool removeVertex(unsigned int vIndex) override;

            bool removeEdge(unsigned int v1, unsigned int v2) override;
            bool removeEdge(const base::PlannerDataVertex &v1, const base::PlannerDataVertex &v2) override;

            void clear() override;

            void decoupleFromPlanner() override;

            const SpaceInformationPtr &getSpaceInformation() const;

            bool hasControls() const override;

        protected:
            SpaceInformationPtr siC_;
            std::set<Control *> decoupledControls_;

        private:
            void freeMemory();
        };
    }  // namespace control
}  // namespace ompl

#endif