Clean up the properties code and Tie methods. (#1317)

Author: bcoconni

src/input_output/FGPropertyManager.h

@@ -56,35 +56,24 @@ INCLUDES
 FORWARD DECLARATIONS
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
-template<typename T> T getValue(const SGPropertyNode* node)
-{
-  static_assert(std::is_enum_v<T>, "PropertyTraits specialization for enum types only");
-  return static_cast<T>(node->getIntValue());
-}
-
 template <class C, class T>
 class SGRawValueMethodsEnum : public SGRawValue<int>
 {
 public:
   typedef T(C::* getter_t)() const;
   typedef void (C::* setter_t)(T);
   SGRawValueMethodsEnum(C& obj,
-    getter_t getter = 0, setter_t setter = 0)
-    : _obj(obj), _getter(getter), _setter(setter) {
-  }
-  virtual ~SGRawValueMethodsEnum() {}
-  virtual int getValue() const {
-    if (_getter) { return (int)(_obj.*_getter)(); }
+    getter_t getter = nullptr, setter_t setter = nullptr)
+    : _obj(obj), _getter(getter), _setter(setter) {}
+  int getValue() const override {
+    if (_getter) { return static_cast<int>((_obj.*_getter)()); }
     else { return SGRawValue<int>::DefaultValue(); }
   }
-  virtual bool setValue(int value) {
-      return this->setValue((T)value);
-  }
-  bool setValue(T value) {
-    if (_setter) { (_obj.*_setter)(value); return true; }
+  bool setValue(int value) override {
+    if (_setter) { (_obj.*_setter)(static_cast<T>(value)); return true; }
     else return false;
   }
-  virtual SGRaw* clone() const {
+  SGRaw* clone() const override {
     return new SGRawValueMethodsEnum(_obj, _getter, _setter);
   }
 private:
@@ -100,19 +89,17 @@ class SGRawValueMethodsIndexedEnum : public SGRawValue<T>
   typedef T(C::* getter_t)(U) const;
   typedef void (C::* setter_t)(U, T);
   SGRawValueMethodsIndexedEnum(C& obj, U index,
-    getter_t getter = 0, setter_t setter = 0)
-    : _obj(obj), _index(index), _getter(getter), _setter(setter) {
-  }
-  virtual ~SGRawValueMethodsIndexedEnum() {}
-  virtual T getValue() const {
+    getter_t getter = nullptr, setter_t setter = nullptr)
+    : _obj(obj), _index(index), _getter(getter), _setter(setter) {}
+  T getValue() const override {
     if (_getter) { return (_obj.*_getter)(_index); }
     else { return SGRawValue<T>::DefaultValue(); }
   }
-  virtual bool setValue(T value) {
+  bool setValue(T value) override {
     if (_setter) { (_obj.*_setter)(_index, value); return true; }
     else return false;
   }
-  virtual SGRaw* clone() const {
+  SGRaw* clone() const override {
     return new SGRawValueMethodsIndexedEnum(_obj, _index, _getter, _setter);
   }
 private:
@@ -249,77 +236,6 @@ class JSBSIM_API FGPropertyManager
       }
     }
 
-     /**
-     * Tie a property to a pair of simple functions.
-     *
-     * Every time the property value is queried, the getter (if any) will
-     * be invoked; every time the property value is modified, the setter
-     * (if any) will be invoked.  The getter can be 0 to make the property
-     * unreadable, and the setter can be 0 to make the property
-     * unmodifiable.
-     *
-     * @param name The property name to tie (full path).
-     * @param getter The getter function, or 0 if the value is unreadable.
-     * @param setter The setter function, or 0 if the value is unmodifiable.
-     */
-
-    template <typename T> void
-    Tie (const std::string &name, T (*getter)(), void (*setter)(T) = nullptr)
-    {
-      SGPropertyNode* property = root->getNode(name.c_str(), true);
-      if (!property) {
-        std::cerr << "Could not get or create property " << name << std::endl;
-        return;
-      }
-
-      if (!property->tie(SGRawValueFunctions<T>(getter, setter), false))
-        std::cerr << "Failed to tie property " << name << " to functions"
-                  << std::endl;
-      else {
-        tied_properties.push_back(PropertyState(property, nullptr));
-        if (!setter) property->setAttribute(SGPropertyNode::WRITE, false);
-        if (!getter) property->setAttribute(SGPropertyNode::READ, false);
-        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
-      }
-    }
-
-    /**
-     * Tie a property to a pair of indexed functions.
-     *
-     * Every time the property value is queried, the getter (if any) will
-     * be invoked with the index provided; every time the property value
-     * is modified, the setter (if any) will be invoked with the index
-     * provided.  The getter can be 0 to make the property unreadable, and
-     * the setter can be 0 to make the property unmodifiable.
-     *
-     * @param name The property name to tie (full path).
-     * @param index The integer argument to pass to the getter and
-     *        setter functions.
-     * @param getter The getter function, or 0 if the value is unreadable.
-     * @param setter The setter function, or 0 if the value is unmodifiable.
-     */
-    template <typename T> void
-    Tie (const std::string &name, int index, T (*getter)(int),
-         void (*setter)(int, T) = nullptr)
-    {
-      SGPropertyNode* property = root->getNode(name.c_str(), true);
-      if (!property) {
-        std::cerr << "Could not get or create property " << name << std::endl;
-        return;
-      }
-
-      if (!property->tie(SGRawValueFunctionsIndexed<T>(index, getter, setter),
-                                                       false))
-        std::cerr << "Failed to tie property " << name << " to indexed functions"
-                  << std::endl;
-      else {
-        tied_properties.push_back(PropertyState(property, nullptr));
-        if (!setter) property->setAttribute(SGPropertyNode::WRITE, false);
-        if (!getter) property->setAttribute(SGPropertyNode::READ, false);
-        if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
-      }
-    }
-
     /**
      * Tie a property to a pair of object methods.
      *
@@ -337,7 +253,7 @@ class JSBSIM_API FGPropertyManager
      *        unmodifiable.
      */
     template <class T, class V>
-    typename std::enable_if<std::is_enum_v<V>, void>::type
+    typename std::enable_if_t<std::is_enum_v<V>, void>
     Tie (const std::string &name, T * obj, V (T::*getter)() const,
          void (T::*setter)(V) = nullptr)
     {
@@ -357,8 +273,9 @@ class JSBSIM_API FGPropertyManager
         if (FGJSBBase::debug_lvl & 0x20) std::cout << name << std::endl;
       }
     }
+
     template <class T, class V>
-    typename std::enable_if<!std::is_enum_v<V>, void>::type
+    typename std::enable_if_t<!std::is_enum_v<V>, void>
     Tie (const std::string &name, T * obj, V (T::*getter)() const,
          void (T::*setter)(V) = nullptr)
     {
@@ -433,11 +350,11 @@ class JSBSIM_API FGPropertyManager
      * @param getter The getter method, or 0 if the value is unreadable.
      * @param setter The setter method, or 0 if the value is unmodifiable.
      */
-    template <class T, class V, class U> void
-      Tie(const std::string& name, T* obj, U index, V(T::* getter)(U) const,
+    template <class T, class V, class U>
+    typename std::enable_if_t<std::is_enum_v<U>, void>
+    Tie(const std::string& name, T* obj, U index, V(T::* getter)(U) const,
         void (T::* setter)(U, V) = nullptr)
     {
-      static_assert(std::is_enum_v<U>, "Specialization for enum types only");
       SGPropertyNode* property = root->getNode(name.c_str(), true);
       if (!property) {
         std::cerr << "Could not get or create property " << name << std::endl;

src/models/FGPropagate.cpp

@@ -74,11 +74,6 @@ INCLUDES
 
 using namespace std;
 
-// Property traits specialization to tie properties using FGPropagate enums.
-namespace simgear::props {
-  template<> struct PropertyTraits<JSBSim::FGPropagate::eIntegrateType> : public PropertyTraits<int> {};
-};
-
 namespace JSBSim {
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

src/models/atmosphere/FGWinds.cpp

@@ -50,12 +50,6 @@ INCLUDES
 
 using namespace std;
 
-// Property traits specialization to tie properties using FGWinds enums.
-namespace simgear::props {
-  template<> struct PropertyTraits<JSBSim::FGWinds::tType> : public PropertyTraits<int> {};
-  template<> struct PropertyTraits<JSBSim::FGWinds::eGustFrame> : public PropertyTraits<int> {};
-};
-
 namespace JSBSim {
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

src/simgear/props/props.cxx

@@ -20,6 +20,7 @@
 #include <iterator>
 #include <stdio.h>
 #include <string.h>
+#include <cassert>
 
 #if PROPS_STANDALONE
 # include <iostream>
@@ -555,11 +556,23 @@ find_node (SGPropertyNode * current,
 // Private methods from SGPropertyNode (may be inlined for speed).
 ////////////////////////////////////////////////////////////////////////
 
+template <typename T>
+inline T getValueFromRaw(SGRaw* value)
+{
+#ifdef NDEBUG
+  return static_cast<SGRawValue<T>*>(value)->getValue();
+#else
+  auto raw_value = dynamic_cast<SGRawValue<T>*>(value);
+  assert(raw_value); // Intercepts casting errors in debug mode.
+  return raw_value->getValue();
+#endif
+}
+
 inline bool
 SGPropertyNode::get_bool () const
 {
   if (_tied)
-    return static_cast<SGRawValue<bool>*>(_value.val)->getValue();
+    return getValueFromRaw<bool>(_value.val);
   else
     return _local_val.bool_val;
 }
@@ -568,7 +581,7 @@ inline int
 SGPropertyNode::get_int () const
 {
   if (_tied)
-      return (static_cast<SGRawValue<int>*>(_value.val))->getValue();
+    return getValueFromRaw<int>(_value.val);
   else
     return _local_val.int_val;
 }
@@ -577,7 +590,7 @@ inline long
 SGPropertyNode::get_long () const
 {
   if (_tied)
-    return static_cast<SGRawValue<long>*>(_value.val)->getValue();
+    return getValueFromRaw<long>(_value.val);
   else
     return _local_val.long_val;
 }
@@ -586,7 +599,7 @@ inline float
 SGPropertyNode::get_float () const
 {
   if (_tied)
-    return static_cast<SGRawValue<float>*>(_value.val)->getValue();
+    return getValueFromRaw<float>(_value.val);
   else
     return _local_val.float_val;
 }
@@ -595,7 +608,7 @@ inline double
 SGPropertyNode::get_double () const
 {
   if (_tied)
-    return static_cast<SGRawValue<double>*>(_value.val)->getValue();
+    return getValueFromRaw<double>(_value.val);
   else
     return _local_val.double_val;
 }
@@ -604,7 +617,7 @@ inline const char *
 SGPropertyNode::get_string () const
 {
   if (_tied)
-      return static_cast<SGRawValue<const char*>*>(_value.val)->getValue();
+    return getValueFromRaw<const char*>(_value.val);
   else
     return _local_val.string_val;
 }
@@ -838,12 +851,12 @@ const int SGPropertyNode::LAST_USED_ATTRIBUTE = PRESERVE;
  * Default constructor: always creates a root node.
  */
 SGPropertyNode::SGPropertyNode ()
-  : _parent(nullptr),
-    _listeners(nullptr),
-    _index(0),
+  : _index(0),
+    _parent(nullptr),
     _type(props::NONE),
     _tied(false),
-    _attr(READ|WRITE)
+    _attr(READ|WRITE),
+    _listeners(nullptr)
 {
   _local_val.string_val = 0;
   _value.val = 0;
@@ -855,13 +868,13 @@ SGPropertyNode::SGPropertyNode ()
  */
 SGPropertyNode::SGPropertyNode (const SGPropertyNode &node)
   : SGReferenced(node),
-    _parent(nullptr),		// don't copy the parent
-    _listeners(nullptr),	// CHECK!!
     _index(node._index),
     _name(node._name),
+    _parent(nullptr),		// don't copy the parent
     _type(node._type),
     _tied(node._tied),
-    _attr(node._attr)
+    _attr(node._attr),
+    _listeners(nullptr)	// CHECK!!
 {
   _local_val.string_val = 0;
   _value.val = 0;
@@ -910,13 +923,13 @@ template<typename Itr>
 SGPropertyNode::SGPropertyNode (Itr begin, Itr end,
 				int index,
 				SGPropertyNode * parent)
-  : _parent(parent),
-    _listeners(nullptr),
-    _index(index),
+  : _index(index),
     _name(begin, end),
+    _parent(parent),
     _type(props::NONE),
     _tied(false),
-    _attr(READ|WRITE)
+    _attr(READ|WRITE),
+    _listeners(nullptr)
 {
   _local_val.string_val = 0;
   _value.val = 0;
@@ -927,13 +940,13 @@ SGPropertyNode::SGPropertyNode (Itr begin, Itr end,
 SGPropertyNode::SGPropertyNode( const std::string& name,
                                 int index,
                                 SGPropertyNode * parent)
-  : _parent(parent),
-    _listeners(nullptr),
-    _index(index),
+  : _index(index),
     _name(name),
+    _parent(parent),
     _type(props::NONE),
     _tied(false),
-    _attr(READ|WRITE)
+    _attr(READ|WRITE),
+    _listeners(nullptr)
 {
   _local_val.string_val = 0;
   _value.val = 0;