Class HostSetting

  • All Implemented Interfaces:
    xal.tools.data.DataListener

    public class HostSetting
    extends Object
    implements xal.tools.data.DataListener
    setting for a single host
    • Field Detail

      • DATA_LABEL

        public static final String DATA_LABEL
        the data adaptor label used for reading and writing this instance
        See Also:
        Constant Field Values
      • _host

        protected String _host
        name of the host
      • _enabled

        protected boolean _enabled
        indicates whether the host is enabled
    • Constructor Detail

      • HostSetting

        public HostSetting​(String host,
                           boolean enabled)
        Primary Constructor
      • HostSetting

        public HostSetting​(HostSetting setting)
        Copy Constructor
      • HostSetting

        public HostSetting()
        Empty Constructor
    • Method Detail

      • getHost

        public String getHost()
        get the host's address as a string
        Returns:
        the host's address as a string
      • setHost

        public void setHost​(String host)
        Set the host
        Parameters:
        host - the address of the host
      • isEnabled

        public boolean isEnabled()
        Determine if the host is enabled
        Returns:
        true if the host is enabled and false if not
      • setEnabled

        public void setEnabled​(boolean enabled)
        Set whether the host is enabled
        Parameters:
        enabled - true to enable the host and false to disable it
      • dataLabel

        public String dataLabel()
        dataLabel() provides the name used to identify the class in an external data source.
        Specified by:
        dataLabel in interface xal.tools.data.DataListener
        Returns:
        The tag for this data node.
      • update

        public void update​(xal.tools.data.DataAdaptor adaptor)
        Instructs the receiver to update its data based on the given adaptor.
        Specified by:
        update in interface xal.tools.data.DataListener
        Parameters:
        adaptor - The data adaptor corresponding to this object's data node.
      • write

        public void write​(xal.tools.data.DataAdaptor adaptor)
        Instructs the receiver to write its data to the adaptor for external storage.
        Specified by:
        write in interface xal.tools.data.DataListener
        Parameters:
        adaptor - The data adaptor corresponding to this object's data node.