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>
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 : simgear::PropertyList {
36 TiedPropertyList( SGPropertyNode_ptr root ) : _root(root) {}
37 virtual ~TiedPropertyList()
42 SG_LOG(SG_GENERAL, SG_ALERT, "Detected properties with dangling ties. Use 'Untie' before removing a TiedPropertyList.");
43 // running debug mode: go, fix it!
48 void setRoot( SGPropertyNode_ptr root ) { _root = root; }
49 SGPropertyNode_ptr getRoot() const { return _root; }
51 template<typename T> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, const SGRawValue<T> &rawValue, bool useDefault = true ) {
52 bool success = node->tie( rawValue, useDefault );
54 SG_LOG( SG_ALL, SG_DEBUG, "Tied " << node->getPath() );
58 cerr << "Failed to tie property " << node->getPath() << endl;
60 SG_LOG(SG_GENERAL, SG_WARN, "Failed to tie property " << node->getPath() );
66 template <class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, V * value, bool useDefault = true ) {
67 return Tie( node, SGRawValuePointer<V>(value), useDefault );
70 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, V * value, bool useDefault = true ) {
71 return Tie( _root->getNode(relative_path,true), SGRawValuePointer<V>(value), useDefault );
74 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, int prop_index, V * value, bool useDefault = true ) {
75 return Tie( _root->getNode(relative_path,prop_index,true), SGRawValuePointer<V>(value), useDefault );
78 template <class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, V (*getter)(), void (*setter)(V) = 0, bool useDefault = true ) {
79 return Tie(node, SGRawValueFunctions<V>(getter, setter), useDefault );
82 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, V (*getter)(), void (*setter)(V) = 0, bool useDefault = true ) {
83 return Tie(_root->getNode(relative_path,true), SGRawValueFunctions<V>(getter, setter), useDefault );
86 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, int prop_index, V (*getter)(), void (*setter)(V) = 0, bool useDefault = true ) {
87 return Tie(_root->getNode(relative_path,prop_index,true), SGRawValueFunctions<V>(getter, setter), useDefault );
90 template <class V> SGPropertyNode_ptr Tie( SGPropertyNode_ptr node, int index, V (*getter)(int), void (*setter)(int, V) = 0, bool useDefault = true) {
91 return Tie( node, SGRawValueFunctionsIndexed<V>(index, getter, setter), useDefault );
94 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, int index, V (*getter)(int), void (*setter)(int, V) = 0, bool useDefault = true) {
95 return Tie( _root->getNode( relative_path, true ), SGRawValueFunctionsIndexed<V>(index, getter, setter), useDefault );
98 template <class V> SGPropertyNode_ptr Tie( const char * relative_path, int prop_index, int index, V (*getter)(int), void (*setter)(int, V) = 0, bool useDefault = true) {
99 return Tie( _root->getNode( relative_path,prop_index,true ), SGRawValueFunctionsIndexed<V>(index, getter, setter), useDefault );
102 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) {
103 return Tie( node, SGRawValueMethods<T,V>(*obj, getter, setter), useDefault );
106 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) {
107 return Tie( _root->getNode( relative_path, true), SGRawValueMethods<T,V>(*obj, getter, setter), useDefault );
110 template <class T, class V> SGPropertyNode_ptr Tie( const char * relative_path, int prop_index, T * obj, V (T::*getter)() const, void (T::*setter)(V) = 0, bool useDefault = true) {
111 return Tie( _root->getNode( relative_path,prop_index,true), SGRawValueMethods<T,V>(*obj, getter, setter), useDefault );
114 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) {
115 return Tie( node, SGRawValueMethodsIndexed<T,V>(*obj, index, getter, setter), useDefault);
118 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) {
119 return Tie( _root->getNode( relative_path, true ), SGRawValueMethodsIndexed<T,V>(*obj, index, getter, setter), useDefault);
122 template <class T, class V> SGPropertyNode_ptr Tie( const char * relative_path, int prop_index, T * obj, int index, V (T::*getter)(int) const, void (T::*setter)(int, V) = 0, bool useDefault = true) {
123 return Tie( _root->getNode( relative_path,prop_index,true ), SGRawValueMethodsIndexed<T,V>(*obj, index, getter, setter), useDefault);
127 while( size() > 0 ) {
128 SG_LOG( SG_ALL, SG_DEBUG, "untie of " << back()->getPath() );
134 void setAttribute (SGPropertyNode::Attribute attr, bool state)
136 for (std::vector<SGPropertyNode_ptr>::iterator it=begin() ; it < end(); it++ )
137 (*it)->setAttribute(attr, state);
140 SGPropertyNode_ptr _root;