enclosure_deleter.h
Go to the documentation of this file.
1 /*********************************************************************
2 *
3 * Software License Agreement (BSD License)
4 *
5 * Copyright (c) 2008, Willow Garage, Inc.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
18 * * Neither the name of Willow Garage, Inc. nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 *
35 * Author: Eitan Marder-Eppstein
36 *********************************************************************/
37 
38 #include <boost/shared_ptr.hpp>
39 
40 #ifndef ACTIONLIB__ENCLOSURE_DELETER_H_
41 #define ACTIONLIB__ENCLOSURE_DELETER_H_
42 
43 namespace actionlib
44 {
45 
46 /*
47  * This allows the creation of a shared pointer to a section
48  * of an already reference counted structure. For example,
49  * if in the following picture Enclosure is reference counted with
50  * a boost::shared_ptr and you want to return a boost::shared_ptr
51  * to the Member that is referenced counted along with Enclosure objects
52  *
53  * Enclosure --------------- <--- Already reference counted
54  * -----Member <------- A member of enclosure objects, eg. Enclosure.Member
55  */
56 template<class Enclosure>
57 class EnclosureDeleter
58 {
59 public:
61  : enc_ptr_(enc_ptr) {}
62 
63  template<class Member>
64  void operator()(Member *)
65  {
66  enc_ptr_.reset();
67  }
68 
69 private:
71 };
72 
73 template<class Enclosure, class Member>
75 {
76  EnclosureDeleter<Enclosure> d(enclosure);
77  boost::shared_ptr<Member> p(&member, d);
78  return p;
79 }
80 
81 } // namespace actionlib
82 
83 #endif // ACTIONLIB__ENCLOSURE_DELETER_H_
boost::shared_ptr< Enclosure >
actionlib::EnclosureDeleter::EnclosureDeleter
EnclosureDeleter(const boost::shared_ptr< Enclosure > &enc_ptr)
Definition: enclosure_deleter.h:130
setup.d
d
Definition: setup.py:6
actionlib::EnclosureDeleter::enc_ptr_
boost::shared_ptr< Enclosure > enc_ptr_
Definition: enclosure_deleter.h:140
actionlib::share_member
boost::shared_ptr< Member > share_member(boost::shared_ptr< Enclosure > enclosure, Member &member)
Definition: enclosure_deleter.h:109
actionlib::EnclosureDeleter::operator()
void operator()(Member *)
Definition: enclosure_deleter.h:134
actionlib
Definition: action_definition.h:40


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Fri May 19 2023 02:36:55