Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 9776 in orxonox.OLD


Ignore:
Timestamp:
Sep 20, 2006, 12:17:44 AM (15 years ago)
Author:
bensch
Message:

doxy

Location:
branches/new_class_id/src/lib/util/loading
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • branches/new_class_id/src/lib/util/loading/load_param.cc

    r9775 r9776  
    2424 * @param root the XML-element to load this Parameter from
    2525 * @param paramName the Parameter to load
    26  * @param object the BaseObject, to load this parameter on to (will be cast to executor's Parameter)
    2726 * @param inLoadCycle If we are in a LoadCycle (loading differs.).
    2827 */
     
    4140
    4241/**
     42 * @param classID the ID of the class. This is needed to identify into what class this Parameter belongs.
    4343 * @param descriptionText The text to set as a description for this Parameter
    4444 * @returns a pointer to itself.
  • branches/new_class_id/src/lib/util/loading/load_param.h

    r9771 r9776  
    150150                            const MultiType& value4 = MT_NULL)
    151151  { this->executor->defaultValues(value0, value1, value2, value3, value4); return *this;  };
     152  //! Describes a LoadParam
    152153  CLoadParam& describe(const std::string& descriptionText) { LoadParamBase::describe(OperateClass::staticClassID(), descriptionText); return *this; };
    153154  //     CLoadParam& attribute(const std::string& attributeName, const Executor<SubString>& executor);
     
    155156private:
    156157  Executor<const SubString, OperateClass>*         executor;            //!< The Executor, that actually executes the Loading process.
    157   OperateClass*                                    object;
     158  OperateClass*                                    object;              //!< The Object this LoadParam operates on.
    158159};
    159160
  • branches/new_class_id/src/lib/util/loading/load_param_class_description.cc

    r9775 r9776  
    3636{ }
    3737
     38
    3839/**
    39  *  deletes a classDescription (deletes all the parameterDescriptions as well
     40 * @brief clears all LoadParamDescriptions.
    4041 */
    41 LoadParamClassDescription::~LoadParamClassDescription()
    42 {}
    43 
    4442void LoadParamClassDescription::deleteAllDescriptions()
    4543{
     
    4846
    4947
    50 
     48/**
     49 * @brief describes a LoadParam-parameter.
     50 * @param classID the ID of the class.
     51 * @param paramName the Name of the Parameter.
     52 * @param descriptionText the Test to set.
     53 */
    5154void LoadParamClassDescription::describeClass(const ClassID& classID,
    5255    const std::string& paramName,
     
    5861}
    5962
    60 
     63/**
     64 * @brief sets Values of the specified LoadParam-parameter.
     65 * @param classID the ID of the class.
     66 * @param paramName the name of the Parameter.
     67 * @param paramCount the count of Parameters this LoadParam takes.
     68 * @param defaultValues the default Values.
     69 * @param retVal if the Parameter takes return Values.
     70 */
    6171void LoadParamClassDescription::setValuesOf(const ClassID& classID,
    6272    const std::string& paramName,
  • branches/new_class_id/src/lib/util/loading/load_param_class_description.h

    r9775 r9776  
    3434public:
    3535  LoadParamClassDescription(const std::string& className = "");
    36   ~LoadParamClassDescription();
    3736
     37  //! Compares a LoadParamClassDescription with a String.
    3838  bool operator==(const std::string& className) const { return this->_className == className; };
     39  //! Compares two LoadParamClassDescription with each other
    3940  bool operator==(const LoadParamClassDescription& classDescr) const { return this->_className == classDescr._className; };
     41  //! Compares two LoadParamClassDescription with each other, using the less operator
    4042  bool operator<(const LoadParamClassDescription& classDescr) const { return this->_className < classDescr._className; }
    4143
     
    5052                          bool retVal = false);
    5153
    52 
     54  /** @param createThem: if the Parameters should be created/stored. */
    5355  static void createDescriptions(bool createThem) { _createParametersDescription = createThem; };
     56  /** @returns if the Parameters are created/stored. */
    5457  static bool createsDescriptions() { return _createParametersDescription; };
    5558
     
    5962
    6063private:
     64  //! A Type definition for the Map of Class Descriptions
    6165  typedef std::map<ClassID, LoadParamClassDescription>  ClassDescriptionMap;
     66  //! A type definition for the Map of Parameter Descriptions inside of Class-descriptions.
    6267  typedef std::map<std::string, LoadParamDescription>   ParamDescriptionMap;
    6368
  • branches/new_class_id/src/lib/util/loading/load_param_description.cc

    r9775 r9776  
    2020
    2121/**
     22 * @brief Creates a Description of a LoadParam
    2223 * @param paramName the name of the parameter to load
    2324 */
     
    2526    : _name(paramName), _parameterCount(0)
    2627{ }
    27 
    28 /**
    29  *  removes all the alocated memory
    30  */
    31 LoadParamDescription::~LoadParamDescription()
    32 {}
    3328
    3429/**
     
    4035}
    4136
     37/**
     38 * @brief sets the Values of the LoadParam in the Description.
     39 * @param paramCount the count of arguments the underlying paramDescription takes.
     40 * @param defaultValues the default Values the underlying parameter takes.
     41 * @param retVal if the underlying parameter has a return value
     42 */
    4243void LoadParamDescription::setValues(unsigned int paramCount,
    4344                                     const MultiType* const defaultValues,
  • branches/new_class_id/src/lib/util/loading/load_param_description.h

    r9772 r9776  
    3636public:
    3737  LoadParamDescription(const std::string& paramName = "");
    38   ~LoadParamDescription();
    3938
     39  //! Compares a LoadParamDescription with a String.
    4040  bool operator==(const std::string& paramName) const { return this->_name == paramName; };
     41  //! Compares two LoadParamDescription
    4142  bool operator==(const LoadParamDescription& paramDescr) const { return this->_name == paramDescr._name; };
     43  //! Compares two LoadParamDescription with the less operator
    4244  bool operator<(const LoadParamDescription& paramDescr) const { return this->_name < paramDescr._name; };
    4345
     
    5658  std::string                _description;           //!< A longer description about this function.
    5759
    58   std::vector<std::string>   _types;
    59   std::vector<std::string>   _defaultValues;
     60  std::vector<std::string>   _types;                 //!< A Vector of types of this Parameter.
     61  std::vector<std::string>   _defaultValues;         //!< A Vector of defaultValues of this Parameter.
    6062};
    6163
Note: See TracChangeset for help on using the changeset viewer.