enclosure_deleter.h
Go to the documentation of this file.
00001 /*********************************************************************
00002 *
00003 * Software License Agreement (BSD License)
00004 *
00005 *  Copyright (c) 2008, Willow Garage, Inc.
00006 *  All rights reserved.
00007 *
00008 *  Redistribution and use in source and binary forms, with or without
00009 *  modification, are permitted provided that the following conditions
00010 *  are met:
00011 *
00012 *   * Redistributions of source code must retain the above copyright
00013 *     notice, this list of conditions and the following disclaimer.
00014 *   * Redistributions in binary form must reproduce the above
00015 *     copyright notice, this list of conditions and the following
00016 *     disclaimer in the documentation and/or other materials provided
00017 *     with the distribution.
00018 *   * Neither the name of Willow Garage, Inc. nor the names of its
00019 *     contributors may be used to endorse or promote products derived
00020 *     from this software without specific prior written permission.
00021 *
00022 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00025 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00026 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00027 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00028 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00029 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00032 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00033 *  POSSIBILITY OF SUCH DAMAGE.
00034 *
00035 * Author: Eitan Marder-Eppstein
00036 *********************************************************************/
00037 
00038 #include <boost/shared_ptr.hpp>
00039 
00040 #ifndef ACTIONLIB__ENCLOSURE_DELETER_H_
00041 #define ACTIONLIB__ENCLOSURE_DELETER_H_
00042 
00043 namespace actionlib
00044 {
00045 
00046 /*
00047  * This allows the creation of a shared pointer to a section
00048  * of an already reference counted structure. For example,
00049  * if in the following picture Enclosure is reference counted with
00050  * a boost::shared_ptr and you want to return a boost::shared_ptr
00051  * to the Member that is referenced counted along with Enclosure objects
00052  *
00053  * Enclosure ---------------  <--- Already reference counted
00054  * -----Member <------- A member of enclosure objects, eg. Enclosure.Member
00055  */
00056 template<class Enclosure>
00057 class EnclosureDeleter
00058 {
00059 public:
00060   EnclosureDeleter(const boost::shared_ptr<Enclosure> & enc_ptr)
00061   : enc_ptr_(enc_ptr) {}
00062 
00063   template<class Member>
00064   void operator()(Member *)
00065   {
00066     enc_ptr_.reset();
00067   }
00068 
00069 private:
00070   boost::shared_ptr<Enclosure> enc_ptr_;
00071 };
00072 
00073 template<class Enclosure, class Member>
00074 boost::shared_ptr<Member> share_member(boost::shared_ptr<Enclosure> enclosure, Member & member)
00075 {
00076   EnclosureDeleter<Enclosure> d(enclosure);
00077   boost::shared_ptr<Member> p(&member, d);
00078   return p;
00079 }
00080 
00081 }  // namespace actionlib
00082 
00083 #endif  // ACTIONLIB__ENCLOSURE_DELETER_H_


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep
autogenerated on Thu Sep 28 2017 02:51:16