source: src/Parameters/Parameter.hpp@ 1e06ed

Candidate_v1.6.1 Candidate_v1.7.0 stable
Last change on this file since 1e06ed was 2eded3e, checked in by Frederik Heber <frederik.heber@…>, 8 years ago

Added specific Value and Parameter implemenations for Vector.

  • for the CommandLineParser the values are get parsed immediately (prior to executing any Action). Hence, names of geometry objects that first need to be created by an action cannot yet be present in the registry and thus the Action will fail.
  • we need to postpone the replacement of the geometry name by its stored vector components until the Parameter<>::get() call. This is possible as the value is validated only on get(), not on set(), i.e. giving illegal values is ok, only the Action will fail.
  • therefore, we override the specialize the template Value for Vector to allow storing of a string instead of a Vector and to allow putting the actual parsing of the string in front.
  • the Parameter overriding becomes necessary in order to override clone() and copy cstor(), there using string setters.
  • ContinuousValueTest now needs lib..Parameters, lib..Geometry.
  • static functions parseAsVector and setFromVector for convenience, e.g. QtUI needs to convert from string and to Vector.
  • TESTS: Marked dryrun store-session again as XFAIL, removed XFAIL from load- session python.
  • Property mode set to 100644
File size: 2.5 KB
RevLine 
[adcfc6]1/*
2 * Parameter.hpp
3 *
4 * Created on: Apr 16, 2012
5 * Author: ankele
6 */
7
8#ifndef PARAMETER_HPP_
9#define PARAMETER_HPP_
10
11
12
13// include config.h
14#ifdef HAVE_CONFIG_H
15#include <config.h>
16#endif
17
18#include <string>
19
20#include "Value.hpp"
[cf1d82]21#include "ValueInterface.hpp"
[adcfc6]22#include "ParameterInterface.hpp"
23
[e45c1d]24class ParameterException;
25class ParameterValueException;
26
[2eded3e]27/** This class encapsulates a cloneable, continuous value.
[adcfc6]28 *
29 */
30template <typename T>
[6440c6]31class Parameter :
[cf1d82]32 public ParameterInterface,
33 public ValueInterface<T>
[adcfc6]34{
35public:
[f10b0c]36 Parameter(const Parameter<T> &instance);
[adcfc6]37 Parameter(const std::string &_name);
38 Parameter(const std::string &_name, const T &_value);
39 Parameter(const std::string &_name, const Validator<T> &_Validator);
40 Parameter(const std::string &_name, const Validator<T> &_Validator, const T &_value);
41 Parameter(const std::string &_name, const std::vector<T> &_ValidValues);
42 Parameter(const std::string &_name, const std::vector<T> &_ValidValues, const T &_value);
43 Parameter(const std::string &_name, const range<T> &_ValidRange);
44 Parameter(const std::string &_name, const range<T> &_ValidRange, const T &_value);
45 virtual ~Parameter();
46
[cf1d82]47 // wrap the following functions from ValueAsString to add exception information
48 bool isValidAsString(const std::string &_value) const throw(ParameterValidatorException);
[e45c1d]49 const std::string getAsString() const throw(ParameterValueException);
[6d78b6f]50 const std::string getAsStringUnvalidated() const throw(ParameterValueException);
[cf1d82]51 void setAsString(const std::string &_value) throw(ParameterValueException);
52
53 // wrap the following functions from Value<T> to add exception information
54 bool isValid(const T &_value) const throw(ParameterValidatorException);
[e45c1d]55 const T & get() const throw(ParameterValueException);
[b56114]56 const T & getUnvalidated() const throw(ParameterValueException);
[e45c1d]57 void set(const T & _value) throw(ParameterValueException);
[cf1d82]58 bool isSet() const
59 { return value.isSet(); }
60
61 const Validator<T> & getValidator() const
62 { return value.getValidator(); }
63 Validator<T> & getValidator()
64 { return value.getValidator(); }
[e45c1d]65
[adcfc6]66 // comparator
[e45c1d]67 bool operator==(const Parameter<T> &_instance) const throw(ParameterException);
68 bool operator!=(const Parameter<T> &_instance) const throw(ParameterException)
[adcfc6]69 { return !((*this)==(_instance)); }
70
[6440c6]71 ParameterInterface* clone() const;
[adcfc6]72
[f10b0c]73//private: // TODO...
[adcfc6]74 Parameter();
[cf1d82]75
76private:
77 //!> contained value of this parameter
78 Value<T> value;
[adcfc6]79};
80
[2eded3e]81#include "Parameters/Specifics/Parameter_vector.hpp"
82
[adcfc6]83#include "Parameter_impl.hpp"
84
85
86#endif /* PARAMETER_HPP_ */
Note: See TracBrowser for help on using the repository browser.