Holds a list of objects derived from ReferenceCountedObject. More...
Public Types | |
| typedef TypeOfCriticalSectionToUse::ScopedLockType | ScopedLockType |
| Returns the type of scoped lock to use for locking this array. | |
Public Member Functions | |
| ReferenceCountedArray () throw () | |
| Creates an empty array. | |
| ReferenceCountedArray (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &other) throw () | |
| Creates a copy of another array. | |
| ReferenceCountedArray < ObjectClass, TypeOfCriticalSectionToUse > & | operator= (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &other) throw () |
| Copies another array into this one. | |
| ~ReferenceCountedArray () | |
| Destructor. | |
| void | clear () |
| Removes all objects from the array. | |
| int | size () const throw () |
| Returns the current number of objects in the array. | |
| const ReferenceCountedObjectPtr < ObjectClass > | operator[] (const int index) const throw () |
| Returns a pointer to the object at this index in the array. | |
| const ReferenceCountedObjectPtr < ObjectClass > | getUnchecked (const int index) const throw () |
| Returns a pointer to the object at this index in the array, without checking whether the index is in-range. | |
| const ReferenceCountedObjectPtr < ObjectClass > | getFirst () const throw () |
| Returns a pointer to the first object in the array. | |
| const ReferenceCountedObjectPtr < ObjectClass > | getLast () const throw () |
| Returns a pointer to the last object in the array. | |
| int | indexOf (const ObjectClass *const objectToLookFor) const throw () |
| Finds the index of the first occurrence of an object in the array. | |
| bool | contains (const ObjectClass *const objectToLookFor) const throw () |
| Returns true if the array contains a specified object. | |
| void | add (ObjectClass *const newObject) throw () |
| Appends a new object to the end of the array. | |
| void | insert (int indexToInsertAt, ObjectClass *const newObject) throw () |
| Inserts a new object into the array at the given index. | |
| void | addIfNotAlreadyThere (ObjectClass *const newObject) throw () |
| Appends a new object at the end of the array as long as the array doesn't already contain it. | |
| void | set (const int indexToChange, ObjectClass *const newObject) |
| Replaces an object in the array with a different one. | |
| void | addArray (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &arrayToAddFrom, int startIndex=0, int numElementsToAdd=-1) throw () |
| Adds elements from another array to the end of this array. | |
| template<class ElementComparator > | |
| void | addSorted (ElementComparator &comparator, ObjectClass *newObject) throw () |
| Inserts a new object into the array assuming that the array is sorted. | |
| template<class ElementComparator > | |
| void | addOrReplaceSorted (ElementComparator &comparator, ObjectClass *newObject) throw () |
| Inserts or replaces an object in the array, assuming it is sorted. | |
| void | remove (const int indexToRemove) |
| Removes an object from the array. | |
| void | removeObject (ObjectClass *const objectToRemove) |
| Removes the first occurrence of a specified object from the array. | |
| void | removeRange (const int startIndex, const int numberToRemove) |
| Removes a range of objects from the array. | |
| void | removeLast (int howManyToRemove=1) |
| Removes the last n objects from the array. | |
| void | swap (const int index1, const int index2) throw () |
| Swaps a pair of objects in the array. | |
| void | move (const int currentIndex, int newIndex) throw () |
| Moves one of the objects to a different position. | |
| void | swapWithArray (ReferenceCountedArray &otherArray) throw () |
| This swaps the contents of this array with those of another array. | |
| bool | operator== (const ReferenceCountedArray &other) const throw () |
| Compares this array to another one. | |
| bool | operator!= (const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > &other) const throw () |
| Compares this array to another one. | |
| template<class ElementComparator > | |
| void | sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) const throw () |
| Sorts the elements in the array. | |
| void | minimiseStorageOverheads () throw () |
| Reduces the amount of storage being used by the array. | |
| const TypeOfCriticalSectionToUse & | getLock () const throw () |
| Returns the CriticalSection that locks this array. | |
Holds a list of objects derived from ReferenceCountedObject.
A ReferenceCountedArray holds objects derived from ReferenceCountedObject, and takes care of incrementing and decrementing their ref counts when they are added and removed from the array.
To make all the array's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.
| typedef TypeOfCriticalSectionToUse::ScopedLockType ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ScopedLockType |
Returns the type of scoped lock to use for locking this array.
| ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ReferenceCountedArray | ( | ) | throw () |
Creates an empty array.
| ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::ReferenceCountedArray | ( | const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > & | other | ) | throw () |
Creates a copy of another array.
| ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::~ReferenceCountedArray | ( | ) |
Destructor.
Any objects in the array will be released, and may be deleted if not referenced from elsewhere.
| ReferenceCountedArray<ObjectClass, TypeOfCriticalSectionToUse>& ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator= | ( | const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > & | other | ) | throw () |
Copies another array into this one.
Any existing objects in this array will first be released.
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::clear | ( | ) |
Removes all objects from the array.
Any objects in the array that are not referenced from elsewhere will be deleted.
Referenced by ReferenceCountedArray< SynthesiserSound >::~ReferenceCountedArray().
| int ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::size | ( | ) | const throw () |
Returns the current number of objects in the array.
Referenced by ReferenceCountedArray< SynthesiserSound >::addArray(), and ReferenceCountedArray< SynthesiserSound >::sort().
| const ReferenceCountedObjectPtr<ObjectClass> ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator[] | ( | const int | index | ) | const throw () |
Returns a pointer to the object at this index in the array.
If the index is out-of-range, this will return a null pointer, (and it could be null anyway, because it's ok for the array to hold null pointers as well as objects).
| const ReferenceCountedObjectPtr<ObjectClass> ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getUnchecked | ( | const int | index | ) | const throw () |
Returns a pointer to the object at this index in the array, without checking whether the index is in-range.
This is a faster and less safe version of operator[] which doesn't check the index passed in, so it can be used when you're sure the index if always going to be legal.
Referenced by ReferenceCountedArray< SynthesiserSound >::addArray().
| const ReferenceCountedObjectPtr<ObjectClass> ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getFirst | ( | ) | const throw () |
Returns a pointer to the first object in the array.
This will return a null pointer if the array's empty.
| const ReferenceCountedObjectPtr<ObjectClass> ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLast | ( | ) | const throw () |
Returns a pointer to the last object in the array.
This will return a null pointer if the array's empty.
| int ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOf | ( | const ObjectClass *const | objectToLookFor | ) | const throw () |
Finds the index of the first occurrence of an object in the array.
| objectToLookFor | the object to look for |
Referenced by ReferenceCountedArray< SynthesiserSound >::removeObject().
| bool ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::contains | ( | const ObjectClass *const | objectToLookFor | ) | const throw () |
Returns true if the array contains a specified object.
| objectToLookFor | the object to look for |
Referenced by ReferenceCountedArray< SynthesiserSound >::addIfNotAlreadyThere().
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::add | ( | ObjectClass *const | newObject | ) | throw () |
Appends a new object to the end of the array.
This will increase the new object's reference count.
| newObject | the new object to add to the array |
Referenced by ReferenceCountedArray< SynthesiserSound >::addArray(), ReferenceCountedArray< SynthesiserSound >::addIfNotAlreadyThere(), and ReferenceCountedArray< SynthesiserSound >::insert().
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert | ( | int | indexToInsertAt, | |
| ObjectClass *const | newObject | |||
| ) | throw () |
Inserts a new object into the array at the given index.
If the index is less than 0 or greater than the size of the array, the element will be added to the end of the array. Otherwise, it will be inserted into the array, moving all the later elements along to make room.
This will increase the new object's reference count.
| indexToInsertAt | the index at which the new element should be inserted | |
| newObject | the new object to add to the array |
Referenced by ReferenceCountedArray< SynthesiserSound >::addOrReplaceSorted(), and ReferenceCountedArray< SynthesiserSound >::addSorted().
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere | ( | ObjectClass *const | newObject | ) | throw () |
Appends a new object at the end of the array as long as the array doesn't already contain it.
If the array already contains a matching object, nothing will be done.
| newObject | the new object to add to the array |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::set | ( | const int | indexToChange, | |
| ObjectClass *const | newObject | |||
| ) |
Replaces an object in the array with a different one.
If the index is less than zero, this method does nothing. If the index is beyond the end of the array, the new object is added to the end of the array.
The object being added has its reference count increased, and if it's replacing another object, then that one has its reference count decreased, and may be deleted.
| indexToChange | the index whose value you want to change | |
| newObject | the new value to set for this index. |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addArray | ( | const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > & | arrayToAddFrom, | |
| int | startIndex = 0, |
|||
| int | numElementsToAdd = -1 | |||
| ) | throw () |
Adds elements from another array to the end of this array.
| arrayToAddFrom | the array from which to copy the elements | |
| startIndex | the first element of the other array to start copying from | |
| numElementsToAdd | how many elements to add from the other array. If this value is negative or greater than the number of available elements, all available elements will be copied. |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted | ( | ElementComparator & | comparator, | |
| ObjectClass * | newObject | |||
| ) | throw () |
Inserts a new object into the array assuming that the array is sorted.
This will use a comparator to find the position at which the new object should go. If the array isn't sorted, the behaviour of this method will be unpredictable.
| comparator | the comparator object to use to compare the elements - see the sort() method for details about this object's form | |
| newObject | the new object to insert to the array |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::addOrReplaceSorted | ( | ElementComparator & | comparator, | |
| ObjectClass * | newObject | |||
| ) | throw () |
Inserts or replaces an object in the array, assuming it is sorted.
This is similar to addSorted, but if a matching element already exists, then it will be replaced by the new one, rather than the new one being added as well.
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::remove | ( | const int | indexToRemove | ) |
Removes an object from the array.
This will remove the object at a given index and move back all the subsequent objects to close the gap.
If the index passed in is out-of-range, nothing will happen.
The object that is removed will have its reference count decreased, and may be deleted if not referenced from elsewhere.
| indexToRemove | the index of the element to remove |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject | ( | ObjectClass *const | objectToRemove | ) |
Removes the first occurrence of a specified object from the array.
If the item isn't found, no action is taken. If it is found, it is removed and has its reference count decreased.
| objectToRemove | the object to try to remove |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange | ( | const int | startIndex, | |
| const int | numberToRemove | |||
| ) |
Removes a range of objects from the array.
This will remove a set of objects, starting from the given index, and move any subsequent elements down to close the gap.
If the range extends beyond the bounds of the array, it will be safely clipped to the size of the array.
The objects that are removed will have their reference counts decreased, and may be deleted if not referenced from elsewhere.
| startIndex | the index of the first object to remove | |
| numberToRemove | how many objects should be removed |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeLast | ( | int | howManyToRemove = 1 |
) |
Removes the last n objects from the array.
The objects that are removed will have their reference counts decreased, and may be deleted if not referenced from elsewhere.
| howManyToRemove | how many objects to remove from the end of the array |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::swap | ( | const int | index1, | |
| const int | index2 | |||
| ) | throw () |
Swaps a pair of objects in the array.
If either of the indexes passed in is out-of-range, nothing will happen, otherwise the two objects at these positions will be exchanged.
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::move | ( | const int | currentIndex, | |
| int | newIndex | |||
| ) | throw () |
Moves one of the objects to a different position.
This will move the object to a specified index, shuffling along any intervening elements as required.
So for example, if you have the array { 0, 1, 2, 3, 4, 5 } then calling move (2, 4) would result in { 0, 1, 3, 4, 2, 5 }.
| currentIndex | the index of the object to be moved. If this isn't a valid index, then nothing will be done | |
| newIndex | the index at which you'd like this object to end up. If this is less than zero, it will be moved to the end of the array |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::swapWithArray | ( | ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > & | otherArray | ) | throw () |
This swaps the contents of this array with those of another array.
If you need to exchange two arrays, this is vastly quicker than using copy-by-value because it just swaps their internal pointers.
Referenced by ReferenceCountedArray< SynthesiserSound >::operator=().
| bool ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator== | ( | const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > & | other | ) | const throw () |
Compares this array to another one.
Referenced by ReferenceCountedArray< SynthesiserSound >::operator!=().
| bool ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::operator!= | ( | const ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse > & | other | ) | const throw () |
Compares this array to another one.
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::sort | ( | ElementComparator & | comparator, | |
| const bool | retainOrderOfEquivalentItems = false | |||
| ) | const throw () |
Sorts the elements in the array.
This will use a comparator object to sort the elements into order. The object passed must have a method of the form:
int compareElements (ElementType first, ElementType second);
..and this method must return:
To improve performance, the compareElements() method can be declared as static or const.
| comparator | the comparator to use for comparing elements. | |
| retainOrderOfEquivalentItems | if this is true, then items which the comparator says are equivalent will be kept in the order in which they currently appear in the array. This is slower to perform, but may be important in some cases. If it's false, a faster algorithm is used, but equivalent elements may be rearranged. |
| void ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::minimiseStorageOverheads | ( | ) | throw () |
Reduces the amount of storage being used by the array.
Arrays typically allocate slightly more storage than they need, and after removing elements, they may have quite a lot of unused space allocated. This method will reduce the amount of allocated storage to a minimum.
Referenced by ReferenceCountedArray< SynthesiserSound >::remove(), and ReferenceCountedArray< SynthesiserSound >::removeRange().
| const TypeOfCriticalSectionToUse& ReferenceCountedArray< ObjectClass, TypeOfCriticalSectionToUse >::getLock | ( | ) | const throw () |
Returns the CriticalSection that locks this array.
To lock, you can call getLock().enter() and getLock().exit(), or preferably use an object of ScopedLockType as an RAII lock for it.
Referenced by ReferenceCountedArray< SynthesiserSound >::add(), ReferenceCountedArray< SynthesiserSound >::addArray(), ReferenceCountedArray< SynthesiserSound >::addIfNotAlreadyThere(), ReferenceCountedArray< SynthesiserSound >::addOrReplaceSorted(), ReferenceCountedArray< SynthesiserSound >::addSorted(), ReferenceCountedArray< SynthesiserSound >::clear(), ReferenceCountedArray< SynthesiserSound >::contains(), ReferenceCountedArray< SynthesiserSound >::getFirst(), ReferenceCountedArray< SynthesiserSound >::getLast(), ReferenceCountedArray< SynthesiserSound >::getUnchecked(), ReferenceCountedArray< SynthesiserSound >::indexOf(), ReferenceCountedArray< SynthesiserSound >::insert(), ReferenceCountedArray< SynthesiserSound >::minimiseStorageOverheads(), ReferenceCountedArray< SynthesiserSound >::move(), ReferenceCountedArray< SynthesiserSound >::operator==(), ReferenceCountedArray< SynthesiserSound >::operator[](), ReferenceCountedArray< SynthesiserSound >::remove(), ReferenceCountedArray< SynthesiserSound >::removeLast(), ReferenceCountedArray< SynthesiserSound >::removeObject(), ReferenceCountedArray< SynthesiserSound >::removeRange(), ReferenceCountedArray< SynthesiserSound >::set(), ReferenceCountedArray< SynthesiserSound >::sort(), ReferenceCountedArray< SynthesiserSound >::swap(), and ReferenceCountedArray< SynthesiserSound >::swapWithArray().
1.6.3