Debian Codegraph @

olad/plugin_api/UniverseStore.h

raw
1 /*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU Library General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15 *
16 * UniverseStore.h
17 * The Universe Store class - this manages the universes
18 * Copyright (C) 2005 Simon Newton
19 */
20
21 #ifndef OLAD_PLUGIN_API_UNIVERSESTORE_H_
22 #define OLAD_PLUGIN_API_UNIVERSESTORE_H_
23
24 #include <map>
25 #include <set>
26 #include <string>
27 #include <vector>
28
29 #include "ola/Clock.h"
30 #include "ola/base/Macro.h"
31
32 namespace ola {
33
34 class Universe;
35
36 /**
37 * @brief Maintains a collection of Universe objects.
38 */
39 class UniverseStore {
40 public:
41 /**
42 * @brief Create a new UniverseStore.
43 * @param preferences The Preferences store.
44 * @param export_map the ExportMap to use for stats, may be NULL.
45 */
46 UniverseStore(class Preferences *preferences, class ExportMap *export_map);
47
48 /**
49 * @brief Destructor.
50 */
51 ~UniverseStore();
52
53 /**
54 * @brief Lookup a universe from its universe-id.
55 * @param universe_id the universe-id of the universe.
56 * @return the universe, or NULL if the universe doesn't exist.
57 */
58 Universe *GetUniverse(unsigned int universe_id) const;
59
60 /**
61 * @brief Lookup a universe, or create it if it does not exist.
62 * @param universe_id the universe-id of the universe.
63 * @return the universe, or NULL on error
64 */
65 Universe *GetUniverseOrCreate(unsigned int universe_id);
66
67 /**
68 * @brief Return the number of universes.
69 */
70 unsigned int UniverseCount() const { return m_universe_map.size(); }
71
72 /**
73 * @brief Returns a list of universes. This must be freed when you're
74 * done with it.
75 * @param[out] universes a pointer to a vector of Universes.
76 */
77 void GetList(std::vector<Universe*> *universes) const;
78
79 /**
80 * @brief Delete all universes.
81 */
82 void DeleteAll();
83
84 /**
85 * @brief Mark a universe as a candidate for garbage collection.
86 * @param universe the Universe which has no clients or ports bound.
87 */
88 void AddUniverseGarbageCollection(Universe *universe);
89
90 /**
91 * @brief Garbage collect any pending universes.
92 */
93 void GarbageCollectUniverses();
94
95 private:
96 typedef std::map<unsigned int, Universe*> UniverseMap;
97
98 Preferences *m_preferences;
99 ExportMap *m_export_map;
100 UniverseMap m_universe_map;
101 std::set<Universe*> m_deletion_candidates; // list of universes we may be
102 // able to delete
103 Clock m_clock;
104
105 bool RestoreUniverseSettings(Universe *universe) const;
106 bool SaveUniverseSettings(Universe *universe) const;
107
108 static const unsigned int MINIMUM_RDM_DISCOVERY_INTERVAL;
109
110 DISALLOW_COPY_AND_ASSIGN(UniverseStore);
111 };
112 } // namespace ola
113 #endif // OLAD_PLUGIN_API_UNIVERSESTORE_H_