[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 | /*! |
---|
[9869] | 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 | |
---|
[9869] | 24 | #include <vector> |
---|
| 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: |
---|
[9869] | 37 | LoadParamDescription(const std::string& paramName = ""); |
---|
[5332] | 38 | |
---|
[9869] | 39 | //! Compares a LoadParamDescription with a String. |
---|
| 40 | bool operator==(const std::string& paramName) const { return this->_name == paramName; }; |
---|
| 41 | //! Compares two LoadParamDescription |
---|
| 42 | bool operator==(const LoadParamDescription& paramDescr) const { return this->_name == paramDescr._name; }; |
---|
| 43 | //! Compares two LoadParamDescription with the less operator |
---|
| 44 | bool operator<(const LoadParamDescription& paramDescr) const { return this->_name < paramDescr._name; }; |
---|
| 45 | |
---|
[7221] | 46 | void setDescription(const std::string& descriptionText); |
---|
[9869] | 47 | void setValues(unsigned int paramCount, |
---|
| 48 | const MultiType* const defaultValues, |
---|
| 49 | bool retVal = false); |
---|
| 50 | |
---|
[5332] | 51 | /** @returns the descriptionString */ |
---|
[9869] | 52 | const std::string& description() { return this->_description; }; |
---|
[5332] | 53 | |
---|
[9869] | 54 | void print(FILE* stream = stdout, bool withComments = true) const; |
---|
[5708] | 55 | |
---|
[7221] | 56 | private: |
---|
[9869] | 57 | std::string _name; //!< The Name of the Parameter. |
---|
| 58 | unsigned int _parameterCount; //!< The Count of parameters. |
---|
| 59 | std::string _description; //!< A longer description about this function. |
---|
[5332] | 60 | |
---|
[9869] | 61 | std::vector<std::string> _types; //!< A Vector of types of this Parameter. |
---|
| 62 | std::vector<std::string> _defaultValues; //!< A Vector of defaultValues of this Parameter. |
---|
[5332] | 63 | }; |
---|
| 64 | |
---|
[5546] | 65 | #endif /* _LOAD_PARAM_DESCRIPTION_H */ |
---|