1 // tiedpropertylist.hxx -- Maintain tied properties
3 // Written by Torsten Dreyer started in 2010
5 // Copyright (C) 2010 Torsten Dreyer - torsten (at) t3r _dot_ de
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 #ifndef __TIEDPROPERTYLIST_HXX
22 #define __TIEDPROPERTYLIST_HXX
23 #include <simgear/props/props.hxx>
24 using simgear::PropertyList;
29 * @brief A list of tied properties that get automatically untied
30 * This helper class keeps track of tied properties and unties
31 * each tied property when this class gets destructed.
33 class TiedPropertyList : PropertyList {
36 TiedPropertyList( SGPropertyNode_ptr root ) : _root(root) {}
38 void setRoot( SGPropertyNode_ptr root ) { _root = root; }
39 SGPropertyNode_ptr getRoot() const { return _root; }
41 template<typename T> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, const SGRawValue<T> &rawValue, bool useDefault = true ) {
42 bool success = node->tie( rawValue, useDefault );
44 SG_LOG( SG_ALL, SG_INFO, "Tied " << node->getPath() );
48 cerr << "Failed to tie property " << node->getPath() << endl;
50 SG_LOG(SG_GENERAL, SG_WARN, "Failed to tie property " << node->getPath() );
56 template <class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, V * value, bool useDefault = true ) {
57 return Tie( node, SGRawValuePointer<V>(value), useDefault );
60 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, V * value, bool useDefault = true ) {
61 return Tie( _root->getNode(relative_path,true), SGRawValuePointer<V>(value), useDefault );
64 template <class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, V (*getter)(), void (*setter)(V) = 0, bool useDefault = true ) {
65 return Tie(node, SGRawValueFunctions<V>(getter, setter), useDefault );
68 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, V (*getter)(), void (*setter)(V) = 0, bool useDefault = true ) {
69 return Tie(_root->getNode(relative_path, true), SGRawValueFunctions<V>(getter, setter), useDefault );
72 template <class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, int index, V (*getter)(int), void (*setter)(int, V) = 0, bool useDefault = true) {
73 return Tie( node, SGRawValueFunctionsIndexed<V>(index, getter, setter), useDefault );
76 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, int index, V (*getter)(int), void (*setter)(int, V) = 0, bool useDefault = true) {
77 return Tie( _root->getNode( relative_path, true ), SGRawValueFunctionsIndexed<V>(index, getter, setter), useDefault );
80 template <class T, class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, T * obj, V (T::*getter)() const, void (T::*setter)(V) = 0, bool useDefault = true) {
81 return Tie( node, SGRawValueMethods<T,V>(*obj, getter, setter), useDefault );
84 template <class T, class V> SGPropertyNode_ptr Tie( const char * relative_path, T * obj, V (T::*getter)() const, void (T::*setter)(V) = 0, bool useDefault = true) {
85 return Tie( _root->getNode( relative_path, true), SGRawValueMethods<T,V>(*obj, getter, setter), useDefault );
88 template <class T, class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, T * obj, int index, V (T::*getter)(int) const, void (T::*setter)(int, V) = 0, bool useDefault = true) {
89 return Tie( node, SGRawValueMethodsIndexed<T,V>(*obj, index, getter, setter), useDefault);
92 template <class T, class V> SGPropertyNode_ptr Tie( const char * relative_path, T * obj, int index, V (T::*getter)(int) const, void (T::*setter)(int, V) = 0, bool useDefault = true) {
93 return Tie( _root->getNode( relative_path, true ), SGRawValueMethodsIndexed<T,V>(*obj, index, getter, setter), useDefault);
98 SG_LOG( SG_ALL, SG_INFO, "untie of " << back()->getPath() );
104 SGPropertyNode_ptr _root;