.. _moduleStreamIterator:

music21.stream.iterator
=======================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.stream.iterator

StreamIterator
--------------

.. autoclass:: music21.stream.iterator.StreamIterator

.. rubric:: :class:`~music21.stream.iterator.StreamIterator` bases

- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.stream.iterator.StreamIterator` read-only properties

.. autoattribute:: music21.stream.iterator.StreamIterator.activeElementList

.. autoattribute:: music21.stream.iterator.StreamIterator.notes

.. autoattribute:: music21.stream.iterator.StreamIterator.notesAndRests

.. autoattribute:: music21.stream.iterator.StreamIterator.parts

.. autoattribute:: music21.stream.iterator.StreamIterator.spanners

.. autoattribute:: music21.stream.iterator.StreamIterator.variants

.. autoattribute:: music21.stream.iterator.StreamIterator.voices

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.stream.iterator.StreamIterator` methods

.. automethod:: music21.stream.iterator.StreamIterator.__getitem__

.. automethod:: music21.stream.iterator.StreamIterator.addFilter

.. automethod:: music21.stream.iterator.StreamIterator.cleanup

.. automethod:: music21.stream.iterator.StreamIterator.clone

.. automethod:: music21.stream.iterator.StreamIterator.first

.. automethod:: music21.stream.iterator.StreamIterator.getElementById

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByClass

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByGroup

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByOffset

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByQuerySelector

.. automethod:: music21.stream.iterator.StreamIterator.getElementsNotOfClass

.. automethod:: music21.stream.iterator.StreamIterator.last

.. automethod:: music21.stream.iterator.StreamIterator.matchesFilters

.. automethod:: music21.stream.iterator.StreamIterator.matchingElements

.. automethod:: music21.stream.iterator.StreamIterator.removeFilter

.. automethod:: music21.stream.iterator.StreamIterator.reset

.. automethod:: music21.stream.iterator.StreamIterator.resetCaches

.. automethod:: music21.stream.iterator.StreamIterator.stream

.. automethod:: music21.stream.iterator.StreamIterator.updateActiveInformation

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

RecursiveIterator
-----------------

.. autoclass:: music21.stream.iterator.RecursiveIterator

.. rubric:: :class:`~music21.stream.iterator.RecursiveIterator` bases

- :class:`~music21.stream.iterator.StreamIterator`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.stream.iterator.RecursiveIterator` read-only properties

Read-only properties inherited from :class:`~music21.stream.iterator.StreamIterator`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.iterator.StreamIterator.activeElementList`
   - :attr:`~music21.stream.iterator.StreamIterator.notes`
   - :attr:`~music21.stream.iterator.StreamIterator.notesAndRests`
   - :attr:`~music21.stream.iterator.StreamIterator.parts`
   - :attr:`~music21.stream.iterator.StreamIterator.spanners`
   - :attr:`~music21.stream.iterator.StreamIterator.variants`
   - :attr:`~music21.stream.iterator.StreamIterator.voices`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.stream.iterator.RecursiveIterator` methods

.. automethod:: music21.stream.iterator.RecursiveIterator.currentHierarchyOffset

.. automethod:: music21.stream.iterator.RecursiveIterator.getElementsByOffsetInHierarchy

.. automethod:: music21.stream.iterator.RecursiveIterator.iteratorStack

.. automethod:: music21.stream.iterator.RecursiveIterator.matchingElements

.. automethod:: music21.stream.iterator.RecursiveIterator.reset

.. automethod:: music21.stream.iterator.RecursiveIterator.streamStack

Methods inherited from :class:`~music21.stream.iterator.StreamIterator`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.iterator.StreamIterator.__getitem__`
   - :meth:`~music21.stream.iterator.StreamIterator.addFilter`
   - :meth:`~music21.stream.iterator.StreamIterator.cleanup`
   - :meth:`~music21.stream.iterator.StreamIterator.clone`
   - :meth:`~music21.stream.iterator.StreamIterator.first`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementById`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByClass`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByGroup`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByOffset`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByQuerySelector`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsNotOfClass`
   - :meth:`~music21.stream.iterator.StreamIterator.last`
   - :meth:`~music21.stream.iterator.StreamIterator.matchesFilters`
   - :meth:`~music21.stream.iterator.StreamIterator.removeFilter`
   - :meth:`~music21.stream.iterator.StreamIterator.resetCaches`
   - :meth:`~music21.stream.iterator.StreamIterator.stream`
   - :meth:`~music21.stream.iterator.StreamIterator.updateActiveInformation`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

OffsetIterator
--------------

.. autoclass:: music21.stream.iterator.OffsetIterator

.. rubric:: :class:`~music21.stream.iterator.OffsetIterator` bases

- :class:`~music21.stream.iterator.StreamIterator`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.stream.iterator.OffsetIterator` read-only properties

Read-only properties inherited from :class:`~music21.stream.iterator.StreamIterator`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.iterator.StreamIterator.activeElementList`
   - :attr:`~music21.stream.iterator.StreamIterator.notes`
   - :attr:`~music21.stream.iterator.StreamIterator.notesAndRests`
   - :attr:`~music21.stream.iterator.StreamIterator.parts`
   - :attr:`~music21.stream.iterator.StreamIterator.spanners`
   - :attr:`~music21.stream.iterator.StreamIterator.variants`
   - :attr:`~music21.stream.iterator.StreamIterator.voices`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.stream.iterator.OffsetIterator` methods

.. automethod:: music21.stream.iterator.OffsetIterator.reset

Methods inherited from :class:`~music21.stream.iterator.StreamIterator`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.iterator.StreamIterator.__getitem__`
   - :meth:`~music21.stream.iterator.StreamIterator.addFilter`
   - :meth:`~music21.stream.iterator.StreamIterator.cleanup`
   - :meth:`~music21.stream.iterator.StreamIterator.clone`
   - :meth:`~music21.stream.iterator.StreamIterator.first`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementById`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByClass`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByGroup`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByOffset`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByQuerySelector`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsNotOfClass`
   - :meth:`~music21.stream.iterator.StreamIterator.last`
   - :meth:`~music21.stream.iterator.StreamIterator.matchesFilters`
   - :meth:`~music21.stream.iterator.StreamIterator.matchingElements`
   - :meth:`~music21.stream.iterator.StreamIterator.removeFilter`
   - :meth:`~music21.stream.iterator.StreamIterator.resetCaches`
   - :meth:`~music21.stream.iterator.StreamIterator.stream`
   - :meth:`~music21.stream.iterator.StreamIterator.updateActiveInformation`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`
