libkmid Library API Documentation

NoteArray Class Reference

Holds a resizeable array of note on/off and patch change events. Stores an array of note on/off events. More...

#include <notearray.h>

List of all members.

Public Member Functions

 NoteArray (void)
 ~NoteArray ()
void at (ulong pos, ulong ms, int chn, int cmd, int note)
void at (ulong pos, noteCmd s)
noteCmd at (int pos)
void add (ulong ms, int chn, int cmd, int note)
void iteratorBegin (void)
noteCmd * get (void)
void next (void)
void moveIteratorTo (ulong ms, int *pgm=NULL)


Detailed Description

Holds a resizeable array of note on/off and patch change events. Stores an array of note on/off events.

It can increase it size, but it doesn't decreases (until destruction :-) )

Version:
0.9.5 17/01/2000
Author:
Antonio Larrosa Jimenez <larrosa@kde.org>

Definition at line 37 of file notearray.h.


Constructor & Destructor Documentation

NoteArray::NoteArray void   ) 
 

Constructor.

Initializes internal variables.

Definition at line 30 of file notearray.cc.

NoteArray::~NoteArray  ) 
 

Destructor.

Definition at line 37 of file notearray.cc.


Member Function Documentation

void NoteArray::at ulong  pos,
ulong  ms,
int  chn,
int  cmd,
int  note
 

Adds (or modifies) an event in the given position .

Note that this has nothing to do with what is being played, this just modifies an internal array.

Definition at line 57 of file notearray.cc.

References at().

Referenced by at().

void NoteArray::at ulong  pos,
noteCmd  s
 

A convenience function, which differs from the above in the parameters it accepts.

Definition at line 66 of file notearray.cc.

References at().

NoteArray::noteCmd NoteArray::at int  pos  ) 
 

Returns the note event at a given position.

Definition at line 75 of file notearray.cc.

References at().

void NoteArray::add ulong  ms,
int  chn,
int  cmd,
int  note
 

Adds a note/patch event at a given millisecond.

Note: This method always appends at the end of the list.

Definition at line 80 of file notearray.cc.

References add().

Referenced by add().

void NoteArray::iteratorBegin void   )  [inline]
 

Initializes the iterator.

See also:
get()

next()

Definition at line 125 of file notearray.h.

Referenced by moveIteratorTo().

noteCmd* NoteArray::get void   )  [inline]
 

Get the command currently pointed to by the iterator.

Definition at line 130 of file notearray.h.

Referenced by moveIteratorTo().

void NoteArray::next void   ) 
 

Advances the iterator to the next position.

Definition at line 99 of file notearray.cc.

Referenced by moveIteratorTo().

void NoteArray::moveIteratorTo ulong  ms,
int *  pgm = NULL
 

Calls next() until the next event is over ms milliseconds and puts in pgm[16] the instruments used at this moment.

Definition at line 105 of file notearray.cc.

References get(), iteratorBegin(), moveIteratorTo(), and next().

Referenced by moveIteratorTo().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkmid Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 12 15:09:20 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003