001/* Firing object to be listed in a static Schedule to allow for different
002 * firing modes.
003
004 Copyright (c) 1997-2014 The Regents of the University of California.
005 All rights reserved.
006 Permission is hereby granted, without written agreement and without
007 license or royalty fees, to use, copy, modify, and distribute this
008 software and its documentation for any purpose, provided that the above
009 copyright notice and the following two paragraphs appear in all copies
010 of this software.
011
012 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
013 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
014 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
015 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
016 SUCH DAMAGE.
017
018 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
019 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
021 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
022 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
023 ENHANCEMENTS, OR MODIFICATIONS.
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028
029package ptolemy.domains.sdf.optimize;
030
031import ptolemy.actor.Actor;
032import ptolemy.actor.sched.Firing;
033
034///////////////////////////////////////////////////////////////////
035//// BufferingProfileFiring
036
037/**
038<h1>Class comments</h1>
039BufferingProfileFiring is a subclass of Firing. A Schedule object represents a static
040schedule of actor firings. An object of this class enable the use of different firing modes.
041It is used by the OptimizingSDFDirector and OptimizingSDFSchedule duo when generating
042schedules
043<p>
044See {@link ptolemy.domains.sdf.optimize.OptimizingSDFDirector},
045{@link ptolemy.domains.sdf.optimize.OptimizingSDFScheduler} and
046{@link ptolemy.domains.sdf.optimize.BufferingProfile} for more information.
047</p>
048@see ptolemy.domains.sdf.optimize.OptimizingSDFDirector
049@see ptolemy.domains.sdf.optimize.OptimizingSDFScheduler
050@see ptolemy.domains.sdf.optimize.BufferingProfile
051
052@author Marc Geilen
053@version $Id$
054@since Ptolemy II 10.0
055@Pt.ProposedRating Red (mgeilen)
056@Pt.AcceptedRating Red ()
057 */
058public class BufferingProfileFiring extends Firing {
059
060    /**
061     * Construct an instance representing a firing of the given actor
062     * in the given mode, shared or exclusive.
063     * @param actor the actor which is to fire
064     * @param exclusive indicates firing is to be exclusive
065     */
066    public BufferingProfileFiring(Actor actor, boolean exclusive) {
067        super(actor);
068        fireExclusive = exclusive;
069    }
070
071    ///////////////////////////////////////////////////////////////////
072    ////                         public variables                  ////
073
074    /**
075     * Indicates whether this firing is to be performed exclusively (true)
076     * or shared (false).
077     */
078    public boolean fireExclusive;
079
080}