[7196] | 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 | |
---|
[7401] | 29 | /** |
---|
| 30 | @file |
---|
| 31 | @ingroup Command FunctorExecutor |
---|
| 32 | @brief Typedefs and definitions of ExecutorPtr, ExecutorStaticPtr, and ExecutorMemberPtr |
---|
| 33 | |
---|
[11071] | 34 | Instances of orxonox::Executor are usually managed by an std::shared_ptr. This ensures |
---|
[7401] | 35 | that Executors will be destroyed after usage. To make things easier, there's a typedef |
---|
[11071] | 36 | that defines ExecutorPtr as std::shared_ptr<Executor>. |
---|
[7401] | 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 | |
---|
[7196] | 47 | #ifndef _ExecutorPtr_H__ |
---|
| 48 | #define _ExecutorPtr_H__ |
---|
| 49 | |
---|
[7203] | 50 | #include "core/CorePrereqs.h" |
---|
[11071] | 51 | #include <memory> |
---|
[7196] | 52 | |
---|
| 53 | namespace orxonox |
---|
| 54 | { |
---|
[11071] | 55 | using ExecutorPtr = std::shared_ptr<Executor>; |
---|
| 56 | using ExecutorStaticPtr = std::shared_ptr<ExecutorStatic>; |
---|
[7196] | 57 | template <class T> |
---|
[11071] | 58 | using ExecutorMemberPtr = std::shared_ptr<ExecutorMember<T>>; |
---|
[7196] | 59 | } |
---|
| 60 | |
---|
| 61 | #endif /* _ExecutorPtr_H__ */ |
---|