Class UtilityNetworkAttributeComparison

    • Constructor Detail

      • UtilityNetworkAttributeComparison

        public UtilityNetworkAttributeComparison​(UtilityNetworkAttribute networkAttribute,
                                                 UtilityAttributeComparisonOperator comparisonOperator,
                                                 java.lang.Object value)
        Creates a condition comparing a UtilityNetworkAttribute to specified value.
        Parameters:
        networkAttribute - the source utility network attribute that the value is compared to
        comparisonOperator - the type of comparison to do between the source utility network attribute and the value
        value - the specific value to compare networkAttribute against for each node in the trace. This must match the UtilityNetworkAttribute.DataType of networkAttribute.
        Throws:
        java.lang.IllegalArgumentException - if networkAttribute is null
        java.lang.IllegalArgumentException - if comparisonOperator is null
        java.lang.IllegalArgumentException - if value is null
        java.lang.IllegalArgumentException - if value is not a valid network attribute datatype
        Since:
        100.7.0
      • UtilityNetworkAttributeComparison

        public UtilityNetworkAttributeComparison​(UtilityNetworkAttribute networkAttribute,
                                                 UtilityAttributeComparisonOperator comparisonOperator,
                                                 UtilityNetworkAttribute otherNetworkAttribute)
        Creates a condition comparing the value of one UtilityNetworkAttribute to another.
        Parameters:
        networkAttribute - the source utility network attribute that the value is compared to
        comparisonOperator - the type of comparison to do between the source utility network attribute and another utility network attribute
        otherNetworkAttribute - the utility network attribute being compared against another utility network attribute on each of the nodes
        Throws:
        java.lang.IllegalArgumentException - if networkAttribute is null
        java.lang.IllegalArgumentException - if comparisonOperator is null
        java.lang.IllegalArgumentException - if otherNetworkAttribute is null
        Since:
        100.7.0
    • Method Detail

      • getNetworkAttribute

        public UtilityNetworkAttribute getNetworkAttribute()
        Get the source UtilityNetworkAttribute that either the second utility network attribute or the value is compared to.
        Returns:
        the source utility network attribute
        Since:
        100.7.0
      • getValue

        public java.lang.Object getValue()
        Gets the specific value to compare to UtilityNetworkAttribute against for each node in the trace. See getNetworkAttribute()

        The value can be an integer data type, which can contain a small or large integer, or it can be double data type, which can contain a double or a date (in milliseconds since January 1, 1970 at 00:00:00 GMT).

        Returns:
        the specific value or null if none
        Since:
        100.7.0