Class SingletonParameter

    • Constructor Detail

      • SingletonParameter

        public SingletonParameter​(NamedObj container,
                                  java.lang.String name)
                           throws IllegalActionException,
                                  NameDuplicationException
        Construct a parameter with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This parameter 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. The object is not added to the list of objects in the workspace unless the container is null. Increment the version of the workspace.
        Parameters:
        container - The container.
        name - The name of the parameter.
        Throws:
        IllegalActionException - If the parameter is not of an acceptable class for the container.
        NameDuplicationException - If the name coincides with a parameter already in the container.
      • SingletonParameter

        public SingletonParameter​(NamedObj container,
                                  java.lang.String name,
                                  Token token)
                           throws IllegalActionException,
                                  NameDuplicationException
        Construct a Parameter with the given container, name, and Token. The container argument must not be null, or a NullPointerException will be thrown. This parameter 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. The object is not added to the list of objects in the workspace unless the container is null. Increment the version of the workspace. If the name argument is null, then the name is set to the empty string.
        Parameters:
        container - The container.
        name - The name.
        token - The Token contained by this Parameter.
        Throws:
        IllegalActionException - If the parameter is not of an acceptable class for the container.
        NameDuplicationException - If the name coincides with an parameter already in the container.
    • Method Detail

      • setContainer

        public void setContainer​(NamedObj container)
                          throws IllegalActionException,
                                 NameDuplicationException
        Remove any previous attribute in the container that has the same name as this attribute, and then call the base class method to set the container. 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 this attribute from its container. It is not added to the workspace directory, so this could result in this object being garbage collected.

        This method is write-synchronized on the workspace and increments its version number.

        Overrides:
        setContainer in class Variable
        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 that is of class SingletonConfigurableAttribute.
        See Also:
        Attribute.getContainer()