[4592] | 1 | /* |
---|
[4250] | 2 | orxonox - the future of 3D-vertical-scrollers |
---|
[4233] | 3 | |
---|
[4250] | 4 | Copyright (C) 2004 orx |
---|
| 5 | |
---|
| 6 | This program is free software; you can redistribute it and/or modify |
---|
| 7 | it under the terms of the GNU General Public License as published by |
---|
| 8 | the Free Software Foundation; either version 2, or (at your option) |
---|
| 9 | any later version. |
---|
| 10 | |
---|
| 11 | ### File Specific: |
---|
| 12 | main-programmer: Benjamin Grauer |
---|
| 13 | co-programmer: ... |
---|
| 14 | */ |
---|
| 15 | |
---|
[4592] | 16 | /*! |
---|
[9765] | 17 | * @file load_param_description.h |
---|
[5129] | 18 | * A Class and macro-functions, that makes our lives easy to load-in parameters |
---|
| 19 | */ |
---|
[4250] | 20 | |
---|
[5546] | 21 | #ifndef _LOAD_PARAM_DESCRIPTION_H |
---|
| 22 | #define _LOAD_PARAM_DESCRIPTION_H |
---|
[4233] | 23 | |
---|
[9765] | 24 | #include <vector> |
---|
[9764] | 25 | #include <string> |
---|
[5129] | 26 | |
---|
[4251] | 27 | // Forward Declaration // |
---|
[5556] | 28 | class MultiType; |
---|
[4251] | 29 | |
---|
[5332] | 30 | /************************ |
---|
| 31 | *** DESCRIPTION STUFF *** |
---|
| 32 | ************************/ |
---|
| 33 | //! A class that handles the description of loadable parameters |
---|
| 34 | class LoadParamDescription |
---|
| 35 | { |
---|
[7221] | 36 | public: |
---|
| 37 | LoadParamDescription(const std::string& paramName); |
---|
[5332] | 38 | ~LoadParamDescription(); |
---|
| 39 | |
---|
[9765] | 40 | bool operator==(const std::string& paramName) const { return this->name == paramName; }; |
---|
| 41 | bool operator==(const LoadParamDescription& paramDescr) const { return this->name == paramDescr.name; }; |
---|
| 42 | bool operator<(const LoadParamDescription& paramDescr) const { return this->name < paramDescr.name; }; |
---|
| 43 | |
---|
[7221] | 44 | void setDescription(const std::string& descriptionText); |
---|
[5332] | 45 | /** @returns the descriptionString */ |
---|
[7221] | 46 | const std::string& getDescription() { return this->description; }; |
---|
[5332] | 47 | |
---|
| 48 | void print() const; |
---|
[5708] | 49 | |
---|
[7221] | 50 | private: |
---|
[9765] | 51 | const std::string name; //!< The Name of the Parameter. |
---|
| 52 | unsigned int parameterCount; //!< The Count of parameters. |
---|
[9764] | 53 | std::string description; //!< A longer description about this function. |
---|
| 54 | |
---|
[9765] | 55 | std::vector<std::string> types; |
---|
[9764] | 56 | std::vector<std::string> defaultValues; |
---|
| 57 | |
---|
[5332] | 58 | }; |
---|
| 59 | |
---|
[5546] | 60 | #endif /* _LOAD_PARAM_DESCRIPTION_H */ |
---|