Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/command/ExecutorPtr.h @ 7401

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

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 2.9 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 ExecutorPtr, ExecutorStaticPtr, and ExecutorMemberPtr
33
34    Instances of orxonox::Executor are usually managed by an orxonox::SharedPtr. This ensures
35    that Executors will be destroyed after usage. To make things easier, there's a typedef
36    that defines ExecutorPtr as SharedPtr<Executor>.
37
38    Because there's not only orxonox::Executor, but also orxonox::ExecutorStatic, and
39    orxonox::ExecutorMember, the shared pointers need to store them all and also reflect
40    their hierarchy - ExecutorStatic and ExecutorMember should not be mixed, but both can
41    be converted to Executor. 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 ExecutorMemberPtr<T> that makes it easier to use ExecutorMember.
45*/
46
47#ifndef _ExecutorPtr_H__
48#define _ExecutorPtr_H__
49
50#include "core/CorePrereqs.h"
51#include "util/SharedPtr.h"
52
53namespace orxonox
54{
55    /// ExecutorPtr is just a typedef of SharedPtr
56    typedef SharedPtr<Executor> ExecutorPtr;
57
58    /// ExecutorStaticPtr is just a typedef of SharedChildPtr
59    typedef SharedChildPtr<ExecutorStatic, ExecutorPtr> ExecutorStaticPtr;
60
61    /// It's not possible to use a typedef for ExecutorMemberPtr<T>, so we have to create a child-class instead. It inherits all functions from SharedChildPtr, but needs to (re-)implement some constructors.
62    template <class T>
63    class ExecutorMemberPtr : public SharedChildPtr<ExecutorMember<T>, ExecutorPtr>
64    {
65        public:
66            inline ExecutorMemberPtr() : SharedChildPtr<ExecutorMember<T>, ExecutorPtr>() {}
67            inline ExecutorMemberPtr(ExecutorMember<T>* pointer) : SharedChildPtr<ExecutorMember<T>, ExecutorPtr>(pointer) {}
68            inline ExecutorMemberPtr(const SharedPtr<ExecutorMember<T> >& other) : SharedChildPtr<ExecutorMember<T>, ExecutorPtr>(other) {}
69    };
70}
71
72#endif /* _ExecutorPtr_H__ */
Note: See TracBrowser for help on using the repository browser.