Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::Filter Class Reference

Interface for a MidiEvent filter. More...

#include <Filter.h>

Inheritance diagram for TSE3::Filter:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Filter ()
virtual ~Filter ()=0
virtual MidiEvent filter (const MidiEvent &e) const=0

Detailed Description

Interface for a MidiEvent filter.

The Filter is an interface that allows the use of MidiEvent 'filters'. These filters accept a single MidiEvent, and return the MidiEvent filtered in some way.

Author:
Pete Goodliffe
Version:
3.00
See also:
MidiEvent


Constructor & Destructor Documentation

TSE3::Filter::Filter  ) 
 

virtual TSE3::Filter::~Filter  )  [pure virtual]
 


Member Function Documentation

virtual MidiEvent TSE3::Filter::filter const MidiEvent e  )  const [pure virtual]
 

Filter a MidiEvent by doing something suitably marvellous to it. If the event is removed altogether the filter will return a MidiEvent with a MidiCommand_Invalid. These can propagate up the Playable hierarchy and be ignored by the MidiScheduler at the top.

Parameters:
e MidiEvent to filter
Returns:
MidiEvent (may be a MidiCommand_Invalid)

Implemented in TSE3::MidiFilter, TSE3::MidiMapper, and TSE3::MidiParams.


The documentation for this class was generated from the following file:
Generated on Wed May 25 14:46:13 2005 for TSE3 by doxygen 1.3.2