Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/cd_ancient/src/util/loading/load_param.h @ 7616

Last change on this file since 7616 was 5671, checked in by bensch, 19 years ago

orxonox/trunk: renamed class LoadParam to CLoadParam and Macro LoadParamNew to LoadParam

File size: 3.9 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.h
18 * A Class and macro-functions, that makes our lives easy to load-in parameters
19 */
20
21#ifndef _LOAD_PARAM_H
22#define _LOAD_PARAM_H
23
24#include "base_object.h"
25
26#include "executor/executor.h"
27#include "executor/executor_specials.h"
28
29#include "helper_functions.h"
30
31// Forward Declaration //
32template<class T> class tList;
33class LoadClassDescription;
34class LoadParamDescription;
35class MultiType;
36
37
38/**
39 * Loads a Parameter from ROOT named PARAMETER_NAME
40 * onto OBJECT of CLASS, trough the FUNCTION
41 * @param ROOT the TiXmlElement to load the Parameter from
42 * @param PARAMETER_NAME the Name of the Parameter to load
43 * @param OBJECT The BaseObject to load the new setting to.
44 * @param CLASS What Class the BaseObejct is of (this is for identifying the Functuon)
45 * @param FUNCTION The function of Class to Load (if you want to call &CLASS::FUNCTION write FUNCTION here).
46 */
47#define LoadParam(ROOT, PARAMETER_NAME, OBJECT, CLASS, FUNCTION) \
48         CLoadParam(ROOT, PARAMETER_NAME, OBJECT, ExecutorObjective<CLASS>(&CLASS::FUNCTION), false)
49
50#define LoadParam_CYCLE(ROOT, PARAMETER_NAME, OBJECT, CLASS, FUNCTION) \
51         CLoadParam(ROOT, PARAMETER_NAME, OBJECT, ExecutorObjective<CLASS>(&CLASS::FUNCTION), true)
52
53#define LoadParamXML(ROOT, PARAMETER_NAME, OBJECT, CLASS, FUNCTION) \
54         CLoadParam(ROOT, PARAMETER_NAME, OBJECT, ExecutorXML<CLASS>(&CLASS::FUNCTION, ROOT, PARAMETER_NAME), false)
55
56#define LoadParamXML_CYCLE(ROOT, PARAMETER_NAME, OBJECT, CLASS, FUNCTION) \
57         CLoadParam(ROOT, PARAMETER_NAME, OBJECT, ExecutorXML<CLASS>(&CLASS::FUNCTION, ROOT, PARAMETER_NAME), true)
58
59
60/**
61 * this Starts a Cycle in the Loading Process
62 * be aware, that in the cycle the first parameter of load_param should because
63 * called element, and that you must say true at the Fith parameter, or it will fail
64 * also you will have to close the Cycle again with LOAD_PARAM_END_CYCLE
65 *
66 * @param ROOT The root XLM-element to search element under.
67 * @param ELEMENT the element to search
68 */
69#define LOAD_PARAM_START_CYCLE(ROOT, ELEMENT) \
70  const TiXmlElement* ELEMENT; \
71  ELEMENT= ROOT->FirstChildElement(); \
72  while( ELEMENT != NULL) \
73{
74/**
75   * closes a LoadParam Loop
76   * @see LOAD_PARAM_START_CYCLE
77   * @param ELEMENT the Element to step through.
78 */
79#define LOAD_PARAM_END_CYCLE(ELEMENT) \
80  ELEMENT = ELEMENT->NextSiblingElement(); \
81}
82
83/**************************
84**** REAL DECLARATIONS ****
85**************************/
86//! abstract Base class for a Loadable parameter
87class CLoadParam : public BaseObject
88{
89  public:
90    CLoadParam(const TiXmlElement* root, const char* paramName, BaseObject* object, const Executor& executor, bool inLoadCycle = false);
91    ~CLoadParam();
92
93    CLoadParam* describe(const char* descriptionText);
94    CLoadParam* defaultValues(unsigned int count, ...);
95
96
97  private:
98    bool                     inLoadCycle;
99    Executor*                executor;
100    BaseObject*              object;
101    const char*              paramName;
102
103    LoadClassDescription*    classDesc;            //!< The LoadClassDescription of this CLoadParameter
104    LoadParamDescription*    paramDesc;            //!< The LoadParameterDescription of this LoadParameter
105    const char*              loadString;           //!< The string loaded by this LoadParam
106    const void*              pointerToParam;       //!< A Pointer to a Parameter.
107
108    MultiType*               defaultValue;
109};
110
111// helper function
112
113const char* grabParameter(const TiXmlElement* root, const char* parameterName);
114
115#endif /* _LOAD_PARAM_H */
Note: See TracBrowser for help on using the repository browser.