1 // Base class for property controlled subsystems
3 // Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Library General Public
7 // License as published by the Free Software Foundation; either
8 // version 2 of the License, or (at your option) any later version.
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Library General Public License for more details.
15 // You should have received a copy of the GNU Library General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 #ifndef SG_PROPERTY_BASED_MGR_HXX_
20 #define SG_PROPERTY_BASED_MGR_HXX_
22 #include "PropertyBasedElement.hxx"
23 #include <simgear/structure/subsystem_mgr.hxx>
25 #include <boost/shared_ptr.hpp>
26 #include <boost/function.hpp>
32 class PropertyBasedMgr:
34 public SGPropertyChangeListener
38 virtual void shutdown();
40 virtual void update (double delta_time_sec);
43 * Create a new PropertyBasedElement
45 * @param name Name of the new element
47 PropertyBasedElementPtr createElement(const std::string& name = "");
50 * Get an existing PropertyBasedElement by its index
52 * @param index Index of element node in property tree
54 PropertyBasedElementPtr getElement(size_t index) const;
57 * Get an existing PropertyBasedElement by its name
59 * @param name Name (value of child node "name" will be matched)
61 PropertyBasedElementPtr getElement(const std::string& name) const;
63 virtual const SGPropertyNode* getPropertyRoot() const;
67 typedef boost::function<PropertyBasedElementPtr(SGPropertyNode*)>
70 /** Branch in the property tree for this property managed subsystem */
71 SGPropertyNode_ptr _props;
73 /** Property name of managed elements */
74 const std::string _name_elements;
76 /** The actually managed elements */
77 std::vector<PropertyBasedElementPtr> _elements;
79 /** Function object which creates a new element */
80 ElementFactory _element_factory;
83 * @param props Root node of property branch used for controlling
85 * @param name_elements The name of the nodes for the managed elements
87 PropertyBasedMgr( SGPropertyNode_ptr props,
88 const std::string& name_elements,
89 ElementFactory element_factory );
90 virtual ~PropertyBasedMgr() = 0;
92 virtual void childAdded( SGPropertyNode * parent,
93 SGPropertyNode * child );
94 virtual void childRemoved( SGPropertyNode * parent,
95 SGPropertyNode * child );
97 virtual void elementCreated(PropertyBasedElementPtr element) {}
101 } // namespace simgear
103 #endif /* SG_PROPERTY_BASED_MGR_HXX_ */