001/*
002 * Copyright (c) 2009-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: berkley $'
006 * '$Date: 2010-04-28 00:12:36 +0000 (Wed, 28 Apr 2010) $' 
007 * '$Revision: 24000 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.provenance;
031
032import ptolemy.actor.IOPort;
033import ptolemy.kernel.util.DebugEvent;
034import ptolemy.kernel.util.NamedObj;
035
036/** An event that is published when a port is refilled.
037 * 
038 * @author Daniel Crawl
039 * @version $Id: IOPortRefillEvent.java 24000 2010-04-28 00:12:36Z berkley $
040 */
041public class IOPortRefillEvent implements DebugEvent
042{
043
044    /** Construct a new IOPortRefillEvent. */
045    public IOPortRefillEvent(IOPort port, int channel)
046    {
047        _port = port;
048        _channel = channel;
049    }
050
051    /** Return the channel. */
052    public int getChannel()
053    {
054        return _channel;
055    }
056    
057    /** Return the port where the event occurred. */
058    public IOPort getPort()
059    {
060        return _port;
061    }
062
063    /** Return the source of the event.
064     *  @return The ptolemy object that published this event.
065     */
066    public NamedObj getSource() 
067    {
068        return _port;
069    }
070
071    /** Return a string representation of this event.
072     *  @return A user-readable string describing the event.
073     */
074    public String toString()
075    {
076        return "The port " + _port.getFullName() +
077            " was refilled on channel " + _channel;
078    }
079
080    ///////////////////////////////////////////////////////////////////
081    ////                         private variables                 ////
082
083    /** The channel. */
084    private int _channel;
085    
086    /** The port. */
087    private IOPort _port;
088
089}