Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/command/FunctorPtr.h @ 9676

Last change on this file since 9676 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 3.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Command FunctorExecutor
32    @brief Typedefs and definitions of FunctorPtr, FunctorMemberPtr, FunctorStaticPtr, and FunctorPointerPtr
33
34    Instances of orxonox::Functor are usually managed by an orxonox::SharedPtr. This ensures
35    that Functors will be destroyed after usage. To make things easier, there's a typedef
36    that defines FunctorPtr as SharedPtr<Functor>.
37
38    Because there's not only orxonox::Functor, but also orxonox::FunctorStatic, and
39    orxonox::FunctorMember, the shared pointers need to store them all and also reflect
40    their hierarchy - FunctorStatic and FunctorMember should not be mixed, but both can
41    be converted to Functor. This is achieved by using orxonox::SharedChildPtr.
42
43    Because it's not possible to use a typedef for a template, we have to define the
44    helper class FunctorMemberPtr<T> that makes it easier to use FunctorMember. The
45    same is also done for FunctorPointerPtr<T>, which can be converted to both,
46    FunctorMemberPtr<T> as well as FunctorPtr.
47*/
48
49#ifndef _FunctorPtr_H__
50#define _FunctorPtr_H__
51
52#include "core/CorePrereqs.h"
53#include "util/SharedPtr.h"
54
55namespace orxonox
56{
57    /// FunctorPtr is just a typedef of SharedPtr
58    typedef SharedPtr<Functor> FunctorPtr;
59
60    /// It's not possible to use a typedef for FunctorMemberPtr<T>, so we have to create a child-class instead. It inherits all functions from SharedChildPtr, but needs to (re-)implement some constructors.
61    template <class T>
62    class FunctorMemberPtr : public SharedChildPtr<FunctorMember<T>, FunctorPtr>
63    {
64        public:
65            inline FunctorMemberPtr() : SharedChildPtr<FunctorMember<T>, FunctorPtr>() {}
66            inline FunctorMemberPtr(FunctorMember<T>* pointer) : SharedChildPtr<FunctorMember<T>, FunctorPtr>(pointer) {}
67            inline FunctorMemberPtr(const SharedPtr<FunctorMember<T> >& other) : SharedChildPtr<FunctorMember<T>, FunctorPtr>(other) {}
68    };
69
70    /// FunctorStaticPtr is just FunctorMemberPtr with @a T = void
71    typedef FunctorMemberPtr<void> FunctorStaticPtr;
72
73    /// It's not possible to use a typedef for FunctorPointerPtr<T>, so we have to create a child-class instead. It inherits all functions from SharedChildPtr, but needs to (re-)implement some constructors.
74    template <class F, class T>
75    class FunctorPointerPtr : public SharedChildPtr<FunctorPointer<F, T>, FunctorMemberPtr<T> >
76    {
77        public:
78            inline FunctorPointerPtr() : SharedChildPtr<FunctorPointer<F, T>, FunctorMemberPtr<T> >() {}
79            inline FunctorPointerPtr(FunctorPointer<F, T>* pointer) : SharedChildPtr<FunctorPointer<F, T>, FunctorMemberPtr<T> >(pointer) {}
80            inline FunctorPointerPtr(const SharedPtr<FunctorPointer<F, T> >& other) : SharedChildPtr<FunctorPointer<F, T>, FunctorMemberPtr<T> >(other) {}
81    };
82}
83
84#endif /* _FunctorPtr_H__ */
Note: See TracBrowser for help on using the repository browser.