MKNoteFilter Class Reference

MKNoteFilter is an abstract class that combines the functionality it inherits from MKInstrument with the protocol defined in the MKPerformer class. More...

#import <MKNoteFilter.h>

Inheritance diagram for MKNoteFilter:

MKInstrument

List of all members.

Public Member Functions

(id) - init
 Creates MKNoteSenders and sends [super init].
(NSArray *) - noteSenders
 Returns a copy of the receiver's NSArray of MKNoteSenders.
(BOOL) - isNoteSenderPresent:
 Returns YES if aNoteSender is one of the receiver's MKNoteSenders.
(id) - copyWithZone:
 Creates and returns a MKNoteFilter as a copy of the receiver.
(id) - releaseNoteSenders
 Removes and frees the receiver's MKNoteSenders.
(id) - removeNoteSenders
 Removes all the receiver's MKNoteSenders.
(MKNoteSender *) - noteSender
 Returns the receiver's first MKNoteSender.
(MKNoteSender *) - addNoteSender:
 Removes aNoteSender from its present owner (if any) and adds it to the receiver.
(MKNoteSender *) - removeNoteSender:
 Removes aNoteSender from the receiver's NSArray of MKNoteSenders.
(void) - dealloc
 Sends releaseNoteSenders to the receiver then releases the receivers ivars.


Detailed Description

MKNoteFilter is an abstract class that combines the functionality it inherits from MKInstrument with the protocol defined in the MKPerformer class.

MKNoteFilter is an abstract class that combines the functionality it inherits from MKInstrument with the protocol defined in the MKPerformer class. MKNoteFilter objects can both receive and send MKNotes; they're interposed between MKPerformers and MKInstruments to create a MKNote processing pipeline. The subclass responsibility realizeNote:fromNoteReceiver: is passed on to MKNoteFilter subclasses. Keep in mind that notes must be copied on write or store.


Member Function Documentation

- (id) init  

Creates MKNoteSenders and sends [super init].

Returns:
Returns a newly initialized MKNoteFilter.

- (NSArray *) noteSenders  

Returns a copy of the receiver's NSArray of MKNoteSenders.

Returns:
Returns an NSArray instance.

- (BOOL) isNoteSenderPresent: (MKNoteSender *)  aNoteSender  

Returns YES if aNoteSender is one of the receiver's MKNoteSenders.

Parameters:
aNoteSender is an MKNoteSender instance.
Returns:
Returns a BOOL. Otherwise returns NO.

- (id) copyWithZone: (NSZone *)  zone  

Creates and returns a MKNoteFilter as a copy of the receiver.

Parameters:
zone is a NSZone.
Returns:
Returns an id. The new object contains copies of the receiver's MKNoteSenders and MKNoteReceivers.

Reimplemented from MKInstrument.

- (id) releaseNoteSenders  

Removes and frees the receiver's MKNoteSenders.

Returns:
Returns an id. Returns the receiver.

- (id) removeNoteSenders  

Removes all the receiver's MKNoteSenders.

Returns:
Returns an id. Returns the receiver.

- (MKNoteSender *) noteSender  

Returns the receiver's first MKNoteSender.

Returns:
Returns an MKNoteSender instance. This is method should only by invoked if the receiver only contains one MKNoteSender or if you don't care which MKNoteSender you get. If there are currently no MKNoteSenders, this method creates and adds a MKNoteSender.

- (MKNoteSender *) addNoteSender: (MKNoteSender *)  aNoteSender  

Removes aNoteSender from its present owner (if any) and adds it to the receiver.

Parameters:
aNoteSender is an MKNoteSender instance.
Returns:
Returns an MKNoteSender instance. Returns aNoteSender. If the receiver is in performance, or if aNoteSender is already a member of the receiver, does nothing and returns nil.

- (MKNoteSender *) removeNoteSender: (MKNoteSender *)  aNoteSender  

Removes aNoteSender from the receiver's NSArray of MKNoteSenders.

Parameters:
aNoteSender is an MKNoteSender instance.
Returns:
Returns an MKNoteSender instance. Returns aNoteSender. If the receiver is in a performance, does nothing and returns nil.


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

Generated on Sat Dec 5 17:01:15 2009 for MusicKit by  doxygen 1.5.6