Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/gui/src/core/ConfigValueContainer.h @ 1764

Last change on this file since 1764 was 1505, checked in by rgrieder, 16 years ago

f* svn: It doesn't even inform you if you attempt to set a non existing property. It is svn:eol-style and not eol-style when using the command by the way…

  • Property svn:eol-style set to native
File size: 6.2 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 ConfigValueContainer.h
31    @brief Definition of the ConfigValueContainer class.
32
33    The ConfigValueContainer class contains all needed informations about a configurable variable:
34     - the name of the variable
35     - the name of the class the variable belongs to
36     - the default value
37     - the user-specified value
38     - a pointer to the entry in the config-file
39
40    This is needed to assign the configured values to all newly created objects.
41*/
42
43#ifndef _ConfigValueContainer_H__
44#define _ConfigValueContainer_H__
45
46#include "CorePrereqs.h"
47
48#include <string>
49#include <vector>
50
51#include "util/Math.h"
52#include "util/MultiTypeMath.h"
53#include "ConfigFileManager.h"
54
55namespace orxonox
56{
57    //! The ConfigValuecontainer contains all needed informations about a configurable variable.
58    /**
59        The ConfigValueContainer class contains all needed informations about a configurable variable:
60         - the name of the variable
61         - the name of the class the variable belongs to
62         - the default value
63         - the user-specified value
64         - a pointer to the entry in the config-file
65
66        This is needed to assign the configured values to all newly created objects.
67
68        The container searches for the entry in the config file.
69        If there is an entry, it parses the specified value and assigns it to the variable of the right type.
70        If there is no entry, it adds the entry with the default-value to the section of the variables class.
71        If there is no section, the section and the entry are added to the end of the config-file.
72    */
73    class _CoreExport ConfigValueContainer
74    {
75        public:
76            ConfigValueContainer(ConfigFileType type, Identifier* identifier, const std::string& varname, const MultiTypeMath& defvalue);
77            ConfigValueContainer(ConfigFileType type, Identifier* identifier, const std::string& varname, const std::vector<MultiTypeMath>& defvalue);
78
79            /** @brief Returns the configured value. @param value This is only needed to determine the right type. @return The value */
80            template <typename T>
81            inline ConfigValueContainer& getValue(T* value)
82                { this->value_.getValue(value); return *this; }
83            template <typename T>
84            inline ConfigValueContainer& getValue(std::vector<T>* value)
85            {
86                value->clear();
87                for (unsigned int i = 0; i < this->valueVector_.size(); i++)
88                    value->push_back(this->valueVector_[i]);
89                return *this;
90            }
91
92            template <typename T>
93            inline void setVectorType(const std::vector<T>& value)
94            {
95                this->value_ = T();
96                this->update();
97            }
98
99            inline const std::string& getName() const
100                { return this->varname_; }
101            inline bool isVector() const
102                { return this->bIsVector_; }
103            inline unsigned int getVectorSize() const
104                { return this->valueVector_.size(); }
105
106            void description(const std::string& description);
107            const std::string& getDescription() const;
108
109            bool set(const MultiTypeMath& input);
110            bool tset(const MultiTypeMath& input);
111
112            bool set(unsigned int index, const MultiTypeMath& input);
113            bool tset(unsigned int index, const MultiTypeMath& input);
114            bool add(const MultiTypeMath& input);
115            bool remove(unsigned int index);
116
117            bool reset();
118            void update();
119
120            /** @brief Converts the config-value to a string. @return The string */
121            inline std::string toString() const
122                { return this->value_.toString(); }
123            /** @brief Returns the typename of the assigned config-value. @return The typename */
124            inline std::string getTypename() const
125                { return this->value_.getTypename(); }
126
127        private:
128            bool callFunctionWithIndex(bool (ConfigValueContainer::* function) (unsigned int, const MultiTypeMath&), const std::string& input);
129
130            bool                       bIsVector_;                  //!< True if the container contains a std::vector
131
132            ConfigFileType             type_;                       //!< The type of the corresponding config-file
133            Identifier*                identifier_;                 //!< The identifier of the class
134            std::string                sectionname_;                //!< The name of the class the variable belongs to
135            std::string                varname_;                    //!< The name of the variable
136            std::string                defvalueString_;             //!< The string of the default-value
137            std::vector<std::string>   defvalueStringVector_;       //!< A vector, containg the strings of the default-values in case we're storing a vector
138
139            MultiTypeMath              value_;                      //!< The value
140            std::vector<MultiTypeMath> valueVector_;                //!< A vector, containg the values in case we're storing a vector
141
142            bool                       bAddedDescription_;          //!< True if a description was added
143            LanguageEntryLabel         description_;                //!< The description
144    };
145}
146
147#endif /* _ConfigValueContainer_H__ */
Note: See TracBrowser for help on using the repository browser.