/* A matcher to match any transition in an FSM controller or scheduling relation
in a Ptera controller.
Copyright (c) 1997-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.actor.gt;
import java.util.HashSet;
import java.util.Set;
import ptolemy.actor.gt.ingredients.criteria.AttributeCriterion;
import ptolemy.actor.gt.ingredients.criteria.Criterion;
import ptolemy.domains.modal.kernel.FSMActor;
import ptolemy.domains.modal.kernel.Transition;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.NamedObj;
import ptolemy.kernel.util.Settable;
import ptolemy.kernel.util.ValueListener;
import ptolemy.vergil.gt.GTIngredientsEditor;
/**
A matcher to match any transition in an FSM controller or scheduling relation
in a Ptera controller.
@author Thomas Huining Feng
@version $Id$
@since Ptolemy II 7.1
@Pt.ProposedRating Yellow (tfeng)
@Pt.AcceptedRating Red (tfeng)
*/
public class TransitionMatcher extends Transition implements GTEntity,
ValueListener {
/** Construct a transition matcher with the given name contained by the
* specified entity. The container argument must not be null, or a
* NullPointerException will be thrown. This transition will use the
* workspace of the container for synchronization and version counts.
* If the name argument is null, then the name is set to the empty string.
* @param container The container.
* @param name The name of the transition.
* @exception IllegalActionException If the container is incompatible
* with this transition.
* @exception NameDuplicationException If the name coincides with
* any relation already in the container.
*/
public TransitionMatcher(FSMActor container, String name)
throws IllegalActionException, NameDuplicationException {
super(container, name);
setClassName("ptolemy.actor.gt.TransitionMatcher");
criteria = new GTIngredientsAttribute(this, "criteria");
criteria.setExpression("");
criteria.addValueListener(this);
operations = new GTIngredientsAttribute(this, "operations");
operations.setExpression("");
operations.addValueListener(this);
patternObject = new PatternObjectAttribute(this, "patternObject");
patternObject.setExpression("");
patternObject.addValueListener(this);
editorFactory = new GTIngredientsEditor.Factory(this, "editorFactory");
}
/** Return the attribute that stores all the criteria for this matcher.
*
* @return The attribute that stores all the criteria.
*/
public GTIngredientsAttribute getCriteriaAttribute() {
return criteria;
}
/** Return null.
*
* @return null
*/
public String getDefaultIconDescription() {
return null;
}
/** Return the attribute that stores all the operations for this matcher.
*
* @return The attribute that stores all the operations.
*/
public GTIngredientsAttribute getOperationsAttribute() {
return operations;
}
/** Return the attribute that stores the name of the corresponding entity in
* the pattern of the same {@link TransformationRule}, if this entity is in
* the replacement, or <tt>null</tt> otherwise.
*
* @return The attribute that stires the name of the corresponding entity.
* @see #labelSet()
*/
public PatternObjectAttribute getPatternObjectAttribute() {
return patternObject;
}
/** Return the set of names of ingredients contained in this entity that can
* be resolved.
*
* @return The set of names.
*/
public Set<String> labelSet() {
long version = workspace().getVersion();
if (_labelSet == null || version > _version) {
_labelSet = new HashSet<String>();
try {
int i = 0;
for (GTIngredient ingredient : criteria.getIngredientList()) {
i++;
Criterion criterion = (Criterion) ingredient;
if (criterion instanceof AttributeCriterion) {
_labelSet.add("criterion" + i);
}
}
} catch (MalformedStringException e) {
return _labelSet;
}
}
return _labelSet;
}
/** Return true if the given object matches any transition in an FSM
* controller or the modal model controller.
*
* @param object The object to match.
* @return true if the object matches a transition.
*/
public boolean match(NamedObj object) {
return object instanceof Transition
|| object.getClass().getName().equals(
"ptolemy.domains.fsm.kernel.Transition");
}
/** Update appearance of this entity.
*
* @param attribute The attribute containing ingredients of this entity.
* @see GTEntityUtils#updateAppearance(GTEntity, GTIngredientsAttribute)
*/
public void updateAppearance(GTIngredientsAttribute attribute) {
// GTEntityUtils.updateAppearance(this, attribute);
}
/** React to the fact that the specified Settable has changed.
*
* @param settable The object that has changed value.
* @see GTEntityUtils#valueChanged(GTEntity, Settable)
*/
public void valueChanged(Settable settable) {
GTEntityUtils.valueChanged(this, settable);
}
/** The attribute containing all the criteria in a list
* ({@link GTIngredientList}).
*/
public GTIngredientsAttribute criteria;
/** The editor factory for ingredients in this matcher.
*/
public GTIngredientsEditor.Factory editorFactory;
/** The attribute containing all the operations in a list
* ({@link GTIngredientList}).
*/
public GTIngredientsAttribute operations;
/** The attribute that specifies the name of the corresponding entity in the
* pattern.
*/
public PatternObjectAttribute patternObject;
/** Cache of the label set.
*/
private Set<String> _labelSet;
/** The workspace version the last time when _labelSet was updated.
*/
private long _version = -1;
}