Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/new_class_id/src/lib/util/loading/load_param_description.h @ 9765

Last change on this file since 9765 was 9765, checked in by bensch, 18 years ago

compiles again

File size: 1.8 KB
Line 
1/*
2   orxonox - the future of 3D-vertical-scrollers
3
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
16/*!
17 * @file load_param_description.h
18 * A Class and macro-functions, that makes our lives easy to load-in parameters
19 */
20
21#ifndef _LOAD_PARAM_DESCRIPTION_H
22#define _LOAD_PARAM_DESCRIPTION_H
23
24#include <vector>
25#include <string>
26
27// Forward Declaration //
28class MultiType;
29
30/************************
31*** DESCRIPTION STUFF ***
32************************/
33//! A class that handles the description of loadable parameters
34class LoadParamDescription
35{
36public:
37  LoadParamDescription(const std::string& paramName);
38  ~LoadParamDescription();
39
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
44  void setDescription(const std::string& descriptionText);
45  /** @returns the descriptionString */
46  const std::string& getDescription() { return this->description; };
47
48  void print() const;
49
50private:
51  const std::string          name;                  //!< The Name of the Parameter.
52  unsigned int               parameterCount;        //!< The Count of parameters.
53  std::string                description;           //!< A longer description about this function.
54
55  std::vector<std::string>   types;
56  std::vector<std::string>   defaultValues;
57
58};
59
60#endif /* _LOAD_PARAM_DESCRIPTION_H */
Note: See TracBrowser for help on using the repository browser.