HiseEventBuffer::Iterator Class Reference

A iterator type for the HiseEventBuffer. More...

Public Member Functions
const HiseEvent *	getNextConstEventPointer (bool skipIgnoredEvents=false, bool skipArtificialNotes=false) const
	Returns a read pointer to the event in the buffer. More...
bool	getNextEvent (HiseEvent &e, int &samplePosition, bool skipIgnoredEvents=false, bool skipArtificialEvents=false) const
	Saves the next event into the given HiseEvent address. More...
HiseEvent *	getNextEventPointer (bool skipIgnoredEvents=false, bool skipArtificialNotes=false)
	Returns a write pointer to the event in the buffer. More...
	Iterator (const HiseEventBuffer &b)
	Creates an iterator which allows access to the HiseEvents in the buffer. More...

Detailed Description

A iterator type for the HiseEventBuffer.

Constructor & Destructor Documentation

Iterator

(

const HiseEventBuffer &

b

)

Creates an iterator which allows access to the HiseEvents in the buffer.

Member Function Documentation

const HiseEvent * getNextConstEventPointer	(	bool	skipIgnoredEvents = false,
		bool	skipArtificialNotes = false
	)		const

Returns a read pointer to the event in the buffer.

bool getNextEvent	(	HiseEvent &	e,
		int &	samplePosition,
		bool	skipIgnoredEvents = false,
		bool	skipArtificialEvents = false
	)		const

Saves the next event into the given HiseEvent address.

Parameters

e	- the event adress. Remember this will copy the event. If you want to alter the event in the buffer, use the other iterator methods which return a pointer to the element in the buffer.
samplePosition	- the timestamp position. This will be sorted and compatible to the MidiBuffer::Iterator method.
skipIgnoredEvents	- skips HiseEvents which are ignored.
skipArtificialNotes	- skips artificial notes. Use this to avoid loops when processing HiseEventBuffers.

HiseEvent * getNextEventPointer	(	bool	skipIgnoredEvents = false,
		bool	skipArtificialNotes = false
	)

Returns a write pointer to the event in the buffer.