source: rrlib_rtti/tIsListType.h @ 51:853eefb63c79

Last change on this file since 51:853eefb63c79 was 51:853eefb63c79, checked in by Max Reichardt <mreichardt@…>, 5 years ago

Adapted remaining classes to our standard code template

File size: 3.2 KB
Line 
1//
2// You received this file as part of RRLib
3// Robotics Research Library
4//
5// Copyright (C) Finroc GbR (finroc.org)
6//
7// This program is free software; you can redistribute it and/or modify
8// it under the terms of the GNU General Public License as published by
9// the Free Software Foundation; either version 2 of the License, or
10// (at your option) any later version.
11//
12// This program is distributed in the hope that it will be useful,
13// but WITHOUT ANY WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15// GNU General Public License for more details.
16//
17// You should have received a copy of the GNU General Public License along
18// with this program; if not, write to the Free Software Foundation, Inc.,
19// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20//
21//----------------------------------------------------------------------
22/*!\file    rrlib/rtti/tIsListType.h
23 *
24 * \author  Max Reichardt
25 *
26 * \date    2012-02-05
27 *
28 * \brief   Contains tIsListType
29 *
30 * \b tIsListType
31 *
32 * By deriving from this class, it can be indicated whether a class is suitable for use in lists.
33 * When this is indicated, list types are automatically instantiated when class is registered as data type.
34 *
35 * BY_VALUE   indicates whether automatic creation of list type std::vector<T> is desired.
36 * SHARED_PTR indicates whether automatic creation of list type std::vector<shared_ptr<T>> is desired.
37 *
38 */
39//----------------------------------------------------------------------
40#ifndef __rrlib__rtti__tIsListType_h__
41#define __rrlib__rtti__tIsListType_h__
42
43//----------------------------------------------------------------------
44// External includes (system with <>, local with "")
45//----------------------------------------------------------------------
46
47//----------------------------------------------------------------------
48// Internal includes with ""
49//----------------------------------------------------------------------
50
51//----------------------------------------------------------------------
52// Namespace declaration
53//----------------------------------------------------------------------
54namespace rrlib
55{
56namespace rtti
57{
58
59//----------------------------------------------------------------------
60// Forward declarations / typedefs / enums
61//----------------------------------------------------------------------
62
63//----------------------------------------------------------------------
64// Class declaration
65//----------------------------------------------------------------------
66//! A type suitable for containers?
67/*!
68 * By deriving from this class, it can be indicated whether a class is suitable for use in lists.
69 * When this is indicated, list types are automatically instantiated when class is registered as data type.
70 *
71 * BY_VALUE   indicates whether automatic creation of list type std::vector<T> is desired.
72 * SHARED_PTR indicates whether automatic creation of list type std::vector<shared_ptr<T>> is desired.
73 */
74template <bool BY_VALUE, bool SHARED_PTR>
75class tIsListType
76{
77};
78
79//----------------------------------------------------------------------
80// End of namespace declaration
81//----------------------------------------------------------------------
82}
83}
84
85
86#endif
Note: See TracBrowser for help on using the repository browser.