/* The default adapter class for ptolemy.actor.lib.Const.

 Copyright (c) 2006-2014 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.ontologies.lattice.adapters.defaultAdapters.actor.lib;

import java.util.List;

import ptolemy.data.ontologies.lattice.LatticeOntologyAdapter;
import ptolemy.data.ontologies.lattice.LatticeOntologySolver;
import ptolemy.graph.Inequality;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.IllegalActionException;

///////////////////////////////////////////////////////////////////
//// Const

/** The default adapter class for ptolemy.actor.lib.Const.
 *
 *  @author Charles Shelton
 *  @version $Id: Const.java 70398 2014-10-22 23:44:32Z cxh $
 *  @since Ptolemy II 10.0
 *  @Pt.ProposedRating Red (cshelton)
 *  @Pt.AcceptedRating Red (cshelton)
 */
public class Const extends LatticeOntologyAdapter {

    /** Construct a default lattice ontology adapter for the Const actor.
     *  @param solver The given solver.
     *  @param actor The given Const actor.
     *  @exception IllegalActionException If the adapter cannot be initialized.
     */
    public Const(LatticeOntologySolver solver, ptolemy.actor.lib.Const actor)
            throws IllegalActionException {
        super(solver, actor, false);
        _constActor = (ptolemy.actor.lib.Const) getComponent();
    }

    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /** Return the list of constraints for the Const actor. The only
     *  constraint specified is that the ontology concept applied to the
     *  output port of the actor must be greater than or
     *  equal to the concept applied to the value held by the actor.
     *  @return The list of constraints for this adapter.
     *  @exception IllegalActionException If there is an error creating
     *   the constraint list.
     */
    @Override
    public List<Inequality> constraintList() throws IllegalActionException {
        setAtLeast(_constActor.output, _constActor.value);
        return super.constraintList();
    }

    /** Return a list of property-able NamedObj contained by the component. All
     *  ports and parameters are considered property-able. For the Const actor,
     *  remove the trigger port since it by default they should not be
     *  evaluated by the ontology solver.
     *  @return The list of property-able named object.
     */
    @Override
    public List<Object> getPropertyables() {
        List<Object> result = super.getPropertyables();
        result.remove(_constActor.trigger);

        return result;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         protected methods                 ////

    /** Return the list of property-able Attributes by calling the super
     *  class method. For the Const actor, remove the firingCountLimit
     *  and NONE attributes since by default they should not be evaluated by
     *  the ontology solver.
     *  @return The list of property-able Attributes.
     */
    @Override
    protected List<Attribute> _getPropertyableAttributes() {
        List<Attribute> result = super._getPropertyableAttributes();
        result.remove(_constActor.firingCountLimit);
        result.remove(_constActor.getAttribute("NONE"));

        return result;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private variables                 ////

    /** The Const actor referred to by this lattice ontology adapter. */
    private ptolemy.actor.lib.Const _constActor;
}