Package pulse.properties

Class Flag

  • All Implemented Interfaces:
    Serializable, Property
    public class Flag
extends Object
implements Property
    A Flag is a Property that has a type represented by a NumericPropertyKeyword, a boolean value, and a String with a short abbreviation describing the type of this flag (this is usually defined by the corresponding NumericProperty).
    See Also:
    Serialized Form

    • Constructor Detail

      • Flag

        public Flag​(NumericPropertyKeyword type)
        Creates a Flag with the type type. The default value is set to false.
        Parameters:
        type - the NumericPropertyKeyword associated with this Flag

      • Flag

        public Flag​(Flag f)

      • Flag

        public Flag​(NumericProperty property,
            boolean value)
        Creates a Flag with the following pre-specified parameters: type type, short description abbreviations, and value.
        Parameters:
        property - the NumericProperty parameter containing the NumericPropertyKeyword identifier
        value - the boolean value of this flag

    • Method Detail

      • convert

        public static List<NumericPropertyKeyword> convert​(List<Flag> flags)
        A static method for converting enabled flags to a List of NumericPropertyKeywords. Each keyword in this list corresponds to an enabled flag in the flags List.
        Parameters:
        flags - the list of flags that needs to be analysed
        Returns:
        a list of NumericPropertyKeywords corresponding to enabled flags.

      • allFlags

        public static List<Flag> allFlags()
        List of all possible Flags that can be used in finding the reverse solution of the heat conduction problems. Includes all flags that correspond to NumericProperties satisfying p.isOptimisable() = true. The default value of the flag is set to p.isDefaultSearchVariable() -- based on the information contained in the NumericProperty.xml file.
        Returns:
        a List of all possible Flags

      • getType

        public NumericPropertyKeyword getType()
        Returns the type of this Flag.
        Returns:
        a NumericPropertyKeyword representing the type of this Flag.

      • derive

        public Flag derive​(boolean value)
        Creates a new Flag object based on this Flag, but with a different value.
        Parameters:
        value - either true or false
        Returns:
        a Flag that replicates the type and abbreviation of this Flag, but sets a new value

      • getDescriptor

        public String getDescriptor​(boolean addHtmlTags)
        Creates a short description for the GUI.
        Specified by:
        getDescriptor in interface Property
        Parameters:
        addHtmlTags - if true, adds the 'html' tags at both ends of the descriptor String.
        Returns:
        a String, with or without 'html' tags, describing this Property

      • getValue

        public Object getValue()
        The value for this Property is a boolean.
        Specified by:
        getValue in interface Property
        Returns:
        an object representing the value of this Property

      • setValue

        public void setValue​(boolean value)

      • abbreviation

        public String abbreviation​(boolean addHtmlTags)

      • setAbbreviation

        public void setAbbreviation​(String abbreviation)