Package com.inductiveautomation.perspective.common.config.constants

Interface TagBindingConstants

public interface TagBindingConstants

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONFIG_FALLBACK_DELAY
    The key in the binding config object for the delay before assuming a write has failed
    static final String
    CONFIG_MODE
    The key in the binding config object for the mode of the path of the source tag
    static final String
    CONFIG_PUBLISH_INITIAL
    Key in the binding config for publishing the null / UncertainInitialValue from first subscribing
    static final String
    CONFIG_REFERENCES
    The key in the binding config object for the references when the mode is indirect
    static final String
    CONFIG_TAG_PATH
    The key in the binding config object for the path of the source tag
    static final double
    DEFAULT_FALLBACK_DELAY
    Default value for the editor, plus the value if the key is missing from binding config.
    static final String
    TYPE_ID
    The type ID for tag bindings.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static BindingConfig
    makeTagBinding(TagPath tagPath, String tagProperty, boolean bidirectional, boolean coalesce)
    Convenience method to create a direct tag binding.

  • Field Details

    • TYPE_ID

      static final String TYPE_ID
      The type ID for tag bindings.
      See Also:

    • CONFIG_TAG_PATH

      static final String CONFIG_TAG_PATH
      The key in the binding config object for the path of the source tag
      See Also:

    • CONFIG_MODE

      static final String CONFIG_MODE
      The key in the binding config object for the mode of the path of the source tag
      See Also:

    • CONFIG_REFERENCES

      static final String CONFIG_REFERENCES
      The key in the binding config object for the references when the mode is indirect
      See Also:

    • CONFIG_FALLBACK_DELAY

      static final String CONFIG_FALLBACK_DELAY
      The key in the binding config object for the delay before assuming a write has failed
      See Also:

    • DEFAULT_FALLBACK_DELAY

      static final double DEFAULT_FALLBACK_DELAY
      Default value for the editor, plus the value if the key is missing from binding config.
      See Also:

    • CONFIG_PUBLISH_INITIAL

      static final String CONFIG_PUBLISH_INITIAL
      Key in the binding config for publishing the null / UncertainInitialValue from first subscribing
      See Also:

  • Method Details

    • makeTagBinding

      static BindingConfig makeTagBinding(TagPath tagPath, String tagProperty, boolean bidirectional, boolean coalesce)
      Convenience method to create a direct tag binding.
      Parameters:
      tagPath - Path to the tag to bind to.
      tagProperty - Name of the tag property to bind to.
      bidirectional - Controls if the binding writes back to the tag.
      coalesce - Whether bidirectional write backs should be coalesced.
      Returns:
      A BindingConfig set up for a direct tag binding