Class AbstractSettableAttribute

    • Constructor Detail

      • AbstractSettableAttribute

        public AbstractSettableAttribute()
        Construct an attribute in the default workspace with an empty string as its name. The object is added to the directory of the workspace. Increment the version number of the workspace.
      • AbstractSettableAttribute

        public AbstractSettableAttribute​(Workspace workspace)
        Construct an attribute in the specified workspace with an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. The object is added to the directory of the workspace. Increment the version number of the workspace.
        Parameters:
        workspace - The workspace that will list the attribute.
      • AbstractSettableAttribute

        public AbstractSettableAttribute​(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.
      • AbstractSettableAttribute

        protected AbstractSettableAttribute​(NamedObj container,
                                            java.lang.String name,
                                            boolean incrementWorkspaceVersion)
                                     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.
        incrementWorkspaceVersion - False to not add this to the workspace or do anything else that might change the workspace version number.
        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

      • getDefaultExpression

        public java.lang.String getDefaultExpression()
        Return the default value of this Settable, or null if no default has been set. If this object is derived (in the actor-oriented class mechanism, see the Instantiable interface), then the default is the value of the object from which this is derived (the "prototype"). If this is not a derived object, then the default is the first value set using setExpression(), or null if setExpression() has not been called.
        Specified by:
        getDefaultExpression in interface Settable
        Returns:
        The default value of this attribute, or null if there is none.
        See Also:
        setExpression(String), Instantiable
      • getValueAsString

        public java.lang.String getValueAsString()
        Get the value of the attribute, which is the evaluated expression.
        Specified by:
        getValueAsString in interface Settable
        Returns:
        The same as getExpression().
        See Also:
        Settable.getExpression()
      • setExpression

        public void setExpression​(java.lang.String expression)
                           throws IllegalActionException
        Set the value of this attribute to the specified expression. This base class implementation merely records the first value to serve as the default value if needed. Subclasses are required to override this to also record the value and to call super.setExpression().
        Specified by:
        setExpression in interface Settable
        Parameters:
        expression - The value of this attribute.
        Throws:
        IllegalActionException - If the expression is invalid (not thrown in this base class).
        See Also:
        getDefaultExpression()