Limiter.java example

Explorer
ptii-master
/* An adapter class for ptolemy.actor.lib.Limiter.

 Copyright (c) 2006-2009 The Regents of the University of California.
 All rights reserved.
 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the above
 copyright notice and the following two paragraphs appear in all copies
 of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY

 */
package ptolemy.data.properties.lattice.logicalAND.actor.lib;

import java.util.List;

import ptolemy.data.ScalarToken;
import ptolemy.data.properties.Property;
import ptolemy.data.properties.lattice.MonotonicFunction;
import ptolemy.data.properties.lattice.PropertyConstraintSolver;
import ptolemy.data.properties.lattice.logicalAND.actor.AtomicActor;
import ptolemy.graph.InequalityTerm;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.IllegalActionException;

//////////////////////////////////////////////////////////////////////////
//// Limiter

/**
 An adapter class for ptolemy.actor.lib.Limiter.

 @author Thomas Mandl, Man-Kit Leung
 @version $Id$
 @since Ptolemy II 7.1
 @Pt.ProposedRating Red (mankit)
 @Pt.AcceptedRating Red (mankit)
*/
public class Limiter extends AtomicActor {
    /**
     * Construct an Limiter adapter.
     * @param actor the associated actor
     * @exception IllegalActionException
     */
    public Limiter(PropertyConstraintSolver solver,
            ptolemy.actor.lib.Limiter actor) throws IllegalActionException {

        super(solver, actor, false);
        _actor = actor;
    }

    public List<Inequality> constraintList() throws IllegalActionException {
        setAtLeast(_actor.output, new FunctionTerm());

        return super.constraintList();
    }

    protected List<Attribute> _getPropertyableAttributes() {
        List<Attribute> result = super._getPropertyableAttributes();
        result.add(_actor.top);
        result.add(_actor.bottom);
        return result;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private variables                 ////
    private ptolemy.actor.lib.Limiter _actor;

    ///////////////////////////////////////////////////////////////////
    ////                         inner classes                     ////
    // This class implements a monotonic function of the input port
    // type. The result of the function is the same as the input type
    // if is not Complex; otherwise, the result is Double.
    private class FunctionTerm extends MonotonicFunction {

        ///////////////////////////////////////////////////////////////
        ////                       public inner methods            ////

        /** Return the function result.
         *  @return A Type.
         * @exception IllegalActionException
         */
        public Object getValue() throws IllegalActionException {
            Property inputProperty = getSolver().getProperty(_actor.input);
            if ((inputProperty == null)
                    || (inputProperty == _lattice.getElement("UNKNOWN"))) {
                return inputProperty;
            }

            if ((getSolver().getProperty(_actor.bottom) == _lattice
                    .getElement("TRUE"))
                    && (getSolver().getProperty(_actor.top) == _lattice
                            .getElement("TRUE"))
                    && (!((ScalarToken) _actor.bottom.getToken()).isLessThan(
                            ((ScalarToken) _actor.top.getToken()))
                            .booleanValue())) {

                return (_lattice.getElement("TRUE"));
            }

            return (getSolver().getProperty(_actor.input));
        }

        public boolean isEffective() {
            return true;
        }

        public void setEffective(boolean isEffective) {
        }

        protected InequalityTerm[] _getDependentTerms() {
            return new InequalityTerm[] { getPropertyTerm(_actor.input) };
        }
    }
}