DART  6.10.1
Aspect.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, 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_DETAIL_ASPECT_HPP_
34 #define DART_COMMON_DETAIL_ASPECT_HPP_
35 
36 #include <cassert>
37 
38 #include "dart/common/Aspect.hpp"
39 #include "dart/common/Console.hpp"
40 
41 namespace dart {
42 namespace common {
43 
44 //==============================================================================
45 template <class CompositeType>
47  : mComposite(
48  nullptr) // This will be set later when the Composite calls setComposite
49 {
50  // Do nothing
51 }
52 
53 //==============================================================================
54 template <class CompositeType>
56 {
57  return mComposite;
58 }
59 
60 //==============================================================================
61 template <class CompositeType>
63  const
64 {
65  return mComposite;
66 }
67 
68 //==============================================================================
69 template <class CompositeType>
71 {
72  return (nullptr != mComposite);
73 }
74 
75 //==============================================================================
76 template <class CompositeType>
78  Composite* newComposite)
79 {
80  assert(nullptr == mComposite);
81 
82  mComposite = dynamic_cast<CompositeType*>(newComposite);
83  // Note: Derived classes should be responsible for handling the case in which
84  // the new composite type does not match the expected type. We should not
85  // assume here that it is an error.
86 }
87 
88 //==============================================================================
89 template <class CompositeType>
91  Composite* oldComposite)
92 {
93  DART_UNUSED(oldComposite);
94  assert(oldComposite == mComposite);
95  mComposite = nullptr;
96 }
97 
98 } // namespace common
99 } // namespace dart
100 
101 #endif // DART_COMMON_DETAIL_ASPECT_HPP_
#define DART_UNUSED(x)
Definition: StlHelpers.hpp:44
CompositeTrackingAspect()
Default constructor.
Definition: Aspect.hpp:46
void setComposite(Composite *newComposite) override
Grab the new Composite.
Definition: Aspect.hpp:77
CompositeType * getComposite()
Get the Composite of this Aspect.
Definition: Aspect.hpp:55
bool hasComposite() const
Returns true if this Aspect has a Composite that matches CompositeType.
Definition: Aspect.hpp:70
void loseComposite(Composite *oldComposite) override
Clear the old Composite.
Definition: Aspect.hpp:90
Composite is a base class that should be virtually inherited by any class that wants to be able to ma...
Definition: Composite.hpp:53
Definition: BulletCollisionDetector.cpp:65