Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/config/ConfigFileEntryVectorValue.h @ 9841

Last change on this file since 9841 was 9559, checked in by landauf, 12 years ago

split ConfigFileManager.h/cc into multiple files, one for each class. why did I ever put them all into the same file?

  • Property svn:eol-style set to native
File size: 3.0 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 Config ConfigFile
32*/
33
34#ifndef _ConfigFileEntryVectorValue_H__
35#define _ConfigFileEntryVectorValue_H__
36
37#include "core/CorePrereqs.h"
38
39#include "ConfigFileEntryValue.h"
40
41namespace orxonox
42{
43    ////////////////////////////////
44    // ConfigFileEntryVectorValue //
45    ////////////////////////////////
46    /**
47        @brief Subclass of ConfigFileEntryValue, represents an element of a vector.
48    */
49    class _CoreExport ConfigFileEntryVectorValue : public ConfigFileEntryValue
50    {
51        public:
52            /**
53                @brief Constructor: Initializes the entry.
54
55                @param name                 The name of the vector
56                @param index                The index of the element in the vector
57                @param value                The value of the element
58                @param bString              If true, the value is treated as string which means some special treatment of special characters.
59                @param additionalComment    An optional comment that will be placed behind the value in the config file
60            */
61            inline ConfigFileEntryVectorValue(const std::string& name, unsigned int index, const std::string& value = "", bool bString = false, const std::string& additionalComment = "")
62                : ConfigFileEntryValue(name, value, bString, additionalComment)
63                , index_(index)
64                { this->update(); /*No virtual calls in base class ctor*/ }
65
66            /// Destructor
67            inline ~ConfigFileEntryVectorValue() {}
68
69            inline unsigned int getIndex() const
70                { return this->index_; }
71
72            /// Returns the "key" of the value (the name of the vector plus the index of the element)
73            inline const std::string& getKeyString() const
74                { return this->keyString_; }
75
76        private:
77            void update();
78
79            unsigned int index_;        ///< The index of the element in the vector
80            std::string keyString_;     ///< The full name of the entry (the name of the vector plus the index of the element)
81    };
82}
83
84#endif /* _ConfigFileEntryVectorValue_H__ */
Note: See TracBrowser for help on using the repository browser.