DART  6.7.3
sub_ptr.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2019, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
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  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_COMMON_SUB_PTR_HPP_
34 #define DART_COMMON_SUB_PTR_HPP_
35 
36 #include "dart/common/Observer.hpp"
37 
38 namespace dart {
39 namespace common {
40 
45 template <class T>
46 class sub_ptr : public Observer
47 {
48 public:
50  sub_ptr();
51 
54  sub_ptr(T* _ptr);
55 
57  sub_ptr& operator = (const sub_ptr& _sp);
58 
60  sub_ptr& operator = (T* _ptr);
61 
63  operator T*() const;
64 
66  T& operator*() const;
67 
69  T* operator->() const;
70 
72  T* get() const;
73 
75  void set(T* _ptr);
76 
78  bool valid();
79 
80 protected:
81 
82  void handleDestructionNotification(const Subject* _subject) override;
83 
85  T* mT;
86 
89 };
90 
91 } // namespace common
92 
93 // Make an alias for sub_ptr in the dart namespace for convenience
94 template <class T>
96 
97 } // namespace dart
98 
100 
101 #endif // DART_COMMON_SUB_PTR_HPP_
The Observer class should be inherited by any class that wants to respond in a customized way to the ...
Definition: Observer.hpp:52
The Subject class is a base class for any object that wants to report when it gets destroyed.
Definition: Subject.hpp:58
sub_ptr is a pointer to a Subject.
Definition: sub_ptr.hpp:47
T * operator->() const
Dereferencing operation.
Definition: sub_ptr.hpp:89
sub_ptr & operator=(const sub_ptr &_sp)
Change the Subject of this sub_ptr.
Definition: sub_ptr.hpp:59
Subject * mSubjectBase
Store the pointer to the virtual Subject base.
Definition: sub_ptr.hpp:88
void set(T *_ptr)
Set the subject of this sub_ptr.
Definition: sub_ptr.hpp:103
T * mT
Store the pointer to the full object.
Definition: sub_ptr.hpp:85
sub_ptr()
Default constructor.
Definition: sub_ptr.hpp:43
T * get() const
Get the Subject of this sub_ptr.
Definition: sub_ptr.hpp:96
void handleDestructionNotification(const Subject *_subject) override
Called by receiveDestructionNotification().
Definition: sub_ptr.hpp:123
T & operator*() const
Dereferencing operator.
Definition: sub_ptr.hpp:82
bool valid()
True if and only if this sub_ptr still points to a valid Subject.
Definition: sub_ptr.hpp:116
Definition: BulletCollisionDetector.cpp:63