Maintains a collection of Universe objects.
|
| UniverseStore (class Preferences *preferences, class ExportMap *export_map) |
| Create a new UniverseStore.
|
|
| ~UniverseStore () |
| Destructor.
|
|
Universe * | GetUniverse (unsigned int universe_id) const |
| Lookup a universe from its universe-id.
|
|
Universe * | GetUniverseOrCreate (unsigned int universe_id) |
| Lookup a universe, or create it if it does not exist.
|
|
unsigned int | UniverseCount () const |
| Return the number of universes.
|
|
void | GetList (std::vector< Universe * > *universes) const |
| Returns a list of universes. This must be freed when you're done with it.
|
|
void | DeleteAll () |
| Delete all universes.
|
|
void | AddUniverseGarbageCollection (Universe *universe) |
| Mark a universe as a candidate for garbage collection.
|
|
void | GarbageCollectUniverses () |
| Garbage collect any pending universes.
|
|
◆ UniverseStore()
◆ AddUniverseGarbageCollection()
void ola::UniverseStore::AddUniverseGarbageCollection |
( |
Universe * | universe | ) |
|
Mark a universe as a candidate for garbage collection.
- Parameters
-
universe | the Universe which has no clients or ports bound. |
◆ GetList()
void ola::UniverseStore::GetList |
( |
std::vector< Universe * > * | universes | ) |
const |
Returns a list of universes. This must be freed when you're done with it.
- Parameters
-
[out] | universes | a pointer to a vector of Universes. |
◆ GetUniverse()
Universe * ola::UniverseStore::GetUniverse |
( |
unsigned int | universe_id | ) |
const |
Lookup a universe from its universe-id.
- Parameters
-
universe_id | the universe-id of the universe. |
- Returns
- the universe, or NULL if the universe doesn't exist.
◆ GetUniverseOrCreate()
Universe * ola::UniverseStore::GetUniverseOrCreate |
( |
unsigned int | universe_id | ) |
|
Lookup a universe, or create it if it does not exist.
- Parameters
-
universe_id | the universe-id of the universe. |
- Returns
- the universe, or NULL on error
The documentation for this class was generated from the following files: