OwnedArray< ObjectClass, TypeOfCriticalSectionToUse > Class Template Reference

Inheritance diagram for OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >:

ArrayAllocationBase< ObjectClass * > List of all members.

Detailed Description

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
class OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >

An array designed for holding objects.

This holds a list of pointers to objects, and will automatically delete the objects when they are removed from the array, or when the array is itself deleted.

Declare it in the form: OwnedArray<MyObjectClass>

..and then add new objects, e.g. myOwnedArray.add (new MyObjectClass());

After adding objects, they are 'owned' by the array and will be deleted when removed or replaced.

To make all the array's methods thread-safe, pass in "CriticalSection" as the templated TypeOfCriticalSectionToUse parameter, instead of the default DummyCriticalSection.

See also:
Array, ReferenceCountedArray, StringArray, CriticalSection


Public Member Functions

 OwnedArray (const int granularity=juceDefaultArrayGranularity) throw ()
 Creates an empty array.
 ~OwnedArray ()
 Deletes the array and also deletes any objects inside it.
void clear (const bool deleteObjects=true)
 Clears the array, optionally deleting the objects inside it first.
int size () const throw ()
 Returns the number of items currently in the array.
ObjectClass * operator[] (const int index) const throw ()
 Returns a pointer to the object at this index in the array.
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.
ObjectClass * getFirst () const throw ()
 Returns a pointer to the first object in the array.
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 an object which might be in the array.
bool contains (const ObjectClass *const objectToLookFor) const throw ()
 Returns true if the array contains a specified object.
void add (const ObjectClass *const newObject) throw ()
 Appends a new object to the end of the array.
void insert (int indexToInsertAt, const ObjectClass *const newObject) throw ()
 Inserts a new object into the array at the given index.
void addIfNotAlreadyThere (const 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, const ObjectClass *const newObject, const bool deleteOldElement=true)
 Replaces an object in the array with a different one.
template<class ElementComparator>
void addSorted (ElementComparator &comparator, ObjectClass *const newObject) throw ()
 Inserts a new object into the array assuming that the array is sorted.
template<class ElementComparator>
int indexOfSorted (ElementComparator &comparator, const ObjectClass *const objectToLookFor) const throw ()
 Finds the index of an object in the array, assuming that the array is sorted.
void remove (const int indexToRemove, const bool deleteObject=true)
 Removes an object from the array.
void removeObject (const ObjectClass *const objectToRemove, const bool deleteObject=true)
 Removes a specified object from the array.
void removeRange (int startIndex, const int numberToRemove, const bool deleteObjects=true)
 Removes a range of objects from the array.
void removeLast (int howManyToRemove=1, const bool deleteObjects=true)
 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.
template<class OtherArrayType>
void swapWithArray (OtherArrayType &otherArray) throw ()
 This swaps the contents of this array with those of another array.
void minimiseStorageOverheads () throw ()
 Reduces the amount of storage being used by the array.
void ensureStorageAllocated (const int minNumElements) throw ()
 Increases the array's internal storage to hold a minimum number of elements.
template<class ElementComparator>
void sort (ElementComparator &comparator, const bool retainOrderOfEquivalentItems=false) const throw ()
 Sorts the elements in the array.
void lockArray () const throw ()
 Locks the array's CriticalSection.
void unlockArray () const throw ()
 Unlocks the array's CriticalSection.

Constructor & Destructor Documentation

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::OwnedArray (  const int  granularity = juceDefaultArrayGranularity  )  throw ()
 

Creates an empty array.

Parameters:
granularity this is the size of increment by which the internal storage used by the array will grow. Only change it from the default if you know the array is going to be very big and needs to be able to grow efficiently.
See also:
ArrayAllocationBase

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::~OwnedArray (   ) 
 

Deletes the array and also deletes any objects inside it.

To get rid of the array without deleting its objects, use its clear (false) method before deleting it.

Member Function Documentation

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::clear (  const bool  deleteObjects = true  ) 
 

Clears the array, optionally deleting the objects inside it first.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::size (   )  const throw ()
 

Returns the number of items currently in the array.

See also:
operator[]

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< 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).

See also:
getUnchecked

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< 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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< 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.

See also:
getLast

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
ObjectClass* OwnedArray< 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.

See also:
getFirst

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOf (  const ObjectClass *const   objectToLookFor  )  const throw ()
 

Finds the index of an object which might be in the array.

Parameters:
objectToLookFor the object to look for
Returns:
the index at which the object was found, or -1 if it's not found

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
bool OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::contains (  const ObjectClass *const   objectToLookFor  )  const throw ()
 

Returns true if the array contains a specified object.

Parameters:
objectToLookFor the object to look for
Returns:
true if the object is in the array

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::add (  const ObjectClass *const   newObject  )  throw ()
 

Appends a new object to the end of the array.

Note that the this object will be deleted by the OwnedArray when it is removed, so be careful not to delete it somewhere else.

Also be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.

Parameters:
newObject the new object to add to the array
See also:
set, insert, addIfNotAlreadyThere, addSorted

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::insert (  int  indexToInsertAt,
const ObjectClass *const   newObject
)  throw ()
 

Inserts a new object into the array at the given index.

Note that the this object will be deleted by the OwnedArray when it is removed, so be careful not to delete it somewhere else.

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.

Be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.

Parameters:
indexToInsertAt the index at which the new element should be inserted
newObject the new object to add to the array
See also:
add, addSorted, addIfNotAlreadyThere, set

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addIfNotAlreadyThere (  const 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.

Parameters:
newObject the new object to add to the array

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::set (  const int  indexToChange,
const ObjectClass *const   newObject,
const bool  deleteOldElement = true
) 
 

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.

Be careful not to add the same object to the array more than once, as this will obviously cause deletion of dangling pointers.

Parameters:
indexToChange the index whose value you want to change
newObject the new value to set for this index.
deleteOldElement whether to delete the object that's being replaced with the new one
See also:
add, insert, remove

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::addSorted (  ElementComparator &  comparator,
ObjectClass *const   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.

Parameters:
comparator the comparator to use to compare the elements - see the sort method for details about this object's structure
newObject the new object to insert to the array
See also:
add, sort, indexOfSorted

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator>
int OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::indexOfSorted (  ElementComparator &  comparator,
const ObjectClass *const   objectToLookFor
)  const throw ()
 

Finds the index of an object in the array, assuming that the array is sorted.

This will use a comparator to do a binary-chop to find the index of the given element, if it exists. If the array isn't sorted, the behaviour of this method will be unpredictable.

Parameters:
comparator the comparator to use to compare the elements - see the sort() method for details about the form this object should take
objectToLookFor the object to search for
Returns:
the index of the element, or -1 if it's not found
See also:
addSorted, sort

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::remove (  const int  indexToRemove,
const bool  deleteObject = true
) 
 

Removes an object from the array.

This will remove the object at a given index (optionally also deleting it) and move back all the subsequent objects to close the gap. If the index passed in is out-of-range, nothing will happen.

Parameters:
indexToRemove the index of the element to remove
deleteObject whether to delete the object that is removed
See also:
removeObject, removeRange

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeObject (  const ObjectClass *const   objectToRemove,
const bool  deleteObject = true
) 
 

Removes a specified object from the array.

If the item isn't found, no action is taken.

Parameters:
objectToRemove the object to try to remove
deleteObject whether to delete the object (if it's found)
See also:
remove, removeRange

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeRange (  int  startIndex,
const int  numberToRemove,
const bool  deleteObjects = true
) 
 

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.

Parameters:
startIndex the index of the first object to remove
numberToRemove how many objects should be removed
deleteObjects whether to delete the objects that get removed
See also:
remove, removeObject

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::removeLast (  int  howManyToRemove = 1,
const bool  deleteObjects = true
) 
 

Removes the last n objects from the array.

Parameters:
howManyToRemove how many objects to remove from the end of the array
deleteObjects whether to also delete the objects that are removed
See also:
remove, removeObject, removeRange

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< 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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< 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 }.

Parameters:
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

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class OtherArrayType>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::swapWithArray (  OtherArrayType &  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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< 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.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::ensureStorageAllocated (  const int  minNumElements  )  throw ()
 

Increases the array's internal storage to hold a minimum number of elements.

Calling this before adding a large known number of elements means that the array won't have to keep dynamically resizing itself as the elements are added, and it'll therefore be more efficient.

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
template<class ElementComparator>
void OwnedArray< 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:

  • a value of < 0 if the first comes before the second
  • a value of 0 if the two objects are equivalent
  • a value of > 0 if the second comes before the first

To improve performance, the compareElements() method can be declared as static or const.

Parameters:
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.
See also:
sortArray, indexOfSorted

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::lockArray (   )  const throw ()
 

Locks the array's CriticalSection.

Of course if the type of section used is a DummyCriticalSection, this won't have any effect.

See also:
unlockArray

template<class ObjectClass, class TypeOfCriticalSectionToUse = DummyCriticalSection>
void OwnedArray< ObjectClass, TypeOfCriticalSectionToUse >::unlockArray (   )  const throw ()
 

Unlocks the array's CriticalSection.

Of course if the type of section used is a DummyCriticalSection, this won't have any effect.

See also:
lockArray

The documentation for this class was generated from the following file: