Package ptolemy.domains.modal.kernel

Class FSMTransitionParameter

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable
    public class FSMTransitionParameter
extends AbstractSettableAttribute
    A parameter that contains FSM transition attributes. In large FSMs with long strings in actions, the graphical representation can be challenging. This parameter can be used represent configuration of transitions in a parameter that can be moved independent from the transition in vergil.
    Since:
    Ptolemy II 10.0
    Version:
    $Id$
    Author:
    Patricia Derler
    Pt.AcceptedRating:
    Red (derler)
    Pt.ProposedRating:
    Red (derler)

    • Constructor Detail

      • FSMTransitionParameter

        public FSMTransitionParameter​(NamedObj container,
                              java.lang.String name)
                       throws IllegalActionException,
                              NameDuplicationException
        Construct an attribute with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This attribute 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. Increment the version of the workspace.
        Parameters:
        container - The container.
        name - The name of this attribute.
        Throws:
        IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.
        NameDuplicationException - If the name coincides with an attribute already in the container.

    • Method Detail

      • clone

        public java.lang.Object clone​(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
        Clone the transition into the specified workspace. This calls the base class and then sets the attribute public members to refer to the attributes of the new transition.
        Overrides:
        clone in class Attribute
        Parameters:
        workspace - The workspace for the new transition.
        Returns:
        A new transition.
        Throws:
        java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.
        See Also:
        NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

      • getExpression

        public java.lang.String getExpression()
        Return the name of the parameter.
        Returns:
        The name.
        See Also:
        Settable.setExpression(String)

      • hide

        public void hide​(boolean hide)
          throws IllegalActionException
        If hide is true, hide the parameter and display transition parameters next to the transition. FIXME this should probably be done in setVisibility.
        Parameters:
        hide - True if the parameter should be hidden.
        Throws:
        IllegalActionException - If thrown while creating the _hide parameter, while validating the location or while creating a location.

      • setContainer

        public void setContainer​(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException
        Description copied from class: Attribute
        Specify the container NamedObj, adding this attribute to the list of attributes in the container. If the container already contains an attribute with the same name, then throw an exception and do not make any changes. Similarly, if the container is not in the same workspace as this attribute, throw an exception. If this attribute is already contained by the NamedObj, do nothing. If the attribute already has a container, remove this attribute from its attribute list first. Otherwise, remove it from the directory of the workspace, if it is there. If the argument is null, then remove it from its container. It is not added to the workspace directory, so this could result in this object being garbage collected. Note that since an Attribute is a NamedObj, it can itself have attributes. However, recursive containment is not allowed, where an attribute is an attribute of itself, or indirectly of any attribute it contains. This method is write-synchronized on the workspace and increments its version number.

        Subclasses may constrain the type of container by overriding Attribute.setContainer(NamedObj).

        Overrides:
        setContainer in class Attribute
        Parameters:
        container - The container to attach this attribute to..
        Throws:
        IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.
        NameDuplicationException - If the container already has an attribute with the name of this attribute.
        See Also:
        Attribute.getContainer()

      • setVisibility

        public void setVisibility​(Settable.Visibility visibility)
        Set visibility. Nothing to do.
        Parameters:
        visibility - Ignored.
        See Also:
        getVisibility()