/*
Copyright (c) 2006, Geomatics and Cartographic Research Centre, Carleton 
University All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

 - Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 - Neither the name of the Geomatics and Cartographic Research Centre, 
   Carleton University nor the names of its contributors may be used to 
   endorse or promote products derived from this software without specific 
   prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.

$Id$
*/
package ca.carleton.gcrc.atlas;

import java.lang.IllegalStateException;
import javax.sound.midi.Receiver;
import javax.sound.midi.MidiMessage;

/**
 * <code>OnePassMidiTransformerReceiver</code> implements the Receiver
 * interface for a <code>OnePassMidiTransformer</code>.  The parent 
 * transformer maintains all transformation configuration and implements
 * the details of the <code>Receiver</code> send interface to carry out
 * the configured transformations.
 * 
 * @author Glenn Brauen
 *
 */
public class OnePassMidiTransformerReceiver implements Receiver {
	/*
	 * m_parent identifies the transformer that created this receiver.  
	 */
	private OnePassMidiTransformer m_parent;
	
	/**
	 * Create a <code>OnePassMidiTransformerReceiver</code> on behalf of the 
	 * identified parent_ transformer (typically the creator).  The parent_
	 * maintains the transformation configurations and its <code>send</code>
	 * function implements those transformations.
	 * 
	 * @param parent_ the parent <code>OnePassMidiTransformer</code>.
	 */
	public OnePassMidiTransformerReceiver(OnePassMidiTransformer parent_) {
		m_parent = parent_;
	}
	
	/*
	 * Receiver interfaces...
	 */
	
    /* (non-Javadoc)
     * @see javax.sound.midi.Receiver#send(javax.sound.midi.MidiMessage, long)
     */
    public void send(MidiMessage message_, long timeStamp_) throws IllegalStateException {
    		if (null == m_parent) { throw new IllegalStateException("parent undefined"); }
    		m_parent.send(message_, timeStamp_);
    } // send()
	
    /* (non-Javadoc)
     * @see javax.sound.midi.Receiver#close()
     */
    public void close() {
    		m_parent = null;
    }

} // OnePassMidiTransformerReceiver