Interface BooleanControl

    • Field Detail

      • OPERATION_INVERSE

        static final java.lang.String OPERATION_INVERSE
        Specifies the inverse operation name. The operation can be executed with inverse() method.
        See Also:
        Constant Field Values
      • OPERATION_SET_TRUE

        static final java.lang.String OPERATION_SET_TRUE
        Specifies the operation name, which sets the control state to true value. The operation can be executed with setTrue() method.
        See Also:
        Constant Field Values
      • OPERATION_SET_FALSE

        static final java.lang.String OPERATION_SET_FALSE
        Specifies the operation name, which sets the control state to false value. The operation can be executed with setFalse() method.
        See Also:
        Constant Field Values
      • PROPERTY_DATA

        static final java.lang.String PROPERTY_DATA
        Specifies the state property name. The eventable property value is accessible with getData() method.
        See Also:
        BooleanData, Constant Field Values
    • Method Detail

      • getData

        BooleanData getData()
                     throws DeviceException
        Returns the current state of BooleanControl. It's a getter method for PROPERTY_DATA property.
        Returns:
        The current state of BooleanControl.
        Throws:
        java.lang.IllegalStateException - If this function service object has already been unregistered.
        DeviceException - If an operation error is available.
        See Also:
        BooleanData, PROPERTY_DATA
      • setData

        void setData​(boolean data)
              throws DeviceException
        Sets the BooleanControl state to the specified value. It's setter method for PROPERTY_DATA property.
        Parameters:
        data - The new function value.
        Throws:
        java.lang.IllegalStateException - If this function service object has already been unregistered.
        DeviceException - If an operation error is available.
        java.lang.IllegalArgumentException - If there is an invalid argument.
        See Also:
        PROPERTY_DATA
      • inverse

        void inverse()
              throws DeviceException
        Reverses the BooleanControl state. If the current state represents true value, it'll be changed to false. If the current state represents false value, it'll be changed to true. The operation name is OPERATION_INVERSE.
        Throws:
        java.lang.IllegalStateException - If this function service object has already been unregistered.
        DeviceException - If an operation error is available.
      • setTrue

        void setTrue()
              throws DeviceException
        Sets the BooleanControl state to true value. The operation name is OPERATION_SET_TRUE.
        Throws:
        java.lang.IllegalStateException - If this function service object has already been unregistered.
        DeviceException - If an operation error is available.
      • setFalse

        void setFalse()
               throws DeviceException
        Sets the BooleanControl state to false value. The operation name is OPERATION_SET_FALSE.
        Throws:
        java.lang.IllegalStateException - If this function service object has already been unregistered.
        DeviceException - If an operation error is available.