Class TaggedDevice

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.util.Vector<TaggedDevice> branchVector
      A Vector of branches describing how to physically get to the tagged device through a set of 1-Wire switches.
      java.lang.Integer channel
      The channel on which to probe for info.
      java.lang.String clusterName
      The name of the cluster to which the tagged device is associated.
      OneWireContainer DeviceContainer
      1-Wire Container for the tagged device.
      java.lang.String DeviceType
      Device type for the device (i.e., contact, switch, d2a, etc.).
      java.lang.String init
      An initialization parameter for the tagged device.
      java.lang.String label
      Label for the "name" of the device.
      java.lang.String max
      A string message representing a high or maximum value.
      java.lang.String min
      A string message representing a low or minimum value.
      java.lang.Boolean state
      A true or false describing the state of the tagged device.
    • Constructor Summary

      Constructors 
      Constructor Description
      TaggedDevice()
      Creates an object for the device.
      TaggedDevice​(DSPortAdapter adapter, java.lang.String netAddress)
      Creates an object for the device with the supplied address and device type connected to the supplied port adapter.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.util.Vector<TaggedDevice> getBranches()
      Gets a vector of branches (to get to) the tagged device.
      int getChannel()
      Gets the channel for the tagged device as an int.
      java.lang.String getChannelAsString()
      Gets the channel for the tagged device as a String.
      java.lang.String getClusterName()
      Gets the cluster name for the tagged device.
      OneWireContainer getDeviceContainer()
      Gets the 1-Wire Container for the tagged device.
      java.lang.String getDeviceType()
      Gets the device type for the tagged device.
      java.lang.String getInit()
      Gets the init (Initialization String) for the tagged device.
      java.lang.String getLabel()
      Gets the label for the tagged device.
      java.lang.String getMax()
      Gets the max string for the tagged device.
      java.lang.String getMin()
      Gets the min string for the tagged device.
      OWPath getOWPath()
      Gets the OWPath for the tagged device.
      int hashCode()  
      void setBranches​(java.util.Vector<TaggedDevice> branches)
      Sets the vector of branches to get to the tagged device.
      void setChannel​(int channel)
      Sets the channel for the tagged device from an int.
      void setChannelFromString​(java.lang.String Channel)
      Sets the channel for the tagged device from a String.
      void setClusterName​(java.lang.String cluster)
      Sets the cluster name for the tagged device.
      void setDeviceContainer​(DSPortAdapter adapter, java.lang.String netAddress)
      Sets the 1-Wire Container for the tagged device.
      void setDeviceType​(java.lang.String tType)
      Sets the device type for the tagged device.
      void setInit​(java.lang.String init)
      Sets the init (initialization String) for the tagged device.
      void setLabel​(java.lang.String Label)
      Sets the label for the tagged device.
      void setOWPath​(DSPortAdapter adapter, java.util.Vector<TaggedDevice> Branches)
      Sets the OWPath for the tagged device.
      void setOWPath​(OWPath branchOWPath)
      Sets the OWPath for the tagged device.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • DeviceContainer

        public OneWireContainer DeviceContainer
        1-Wire Container for the tagged device.
      • DeviceType

        public java.lang.String DeviceType
        Device type for the device (i.e., contact, switch, d2a, etc.).
      • label

        public java.lang.String label
        Label for the "name" of the device.
      • channel

        public java.lang.Integer channel
        The channel on which to probe for info.
      • max

        public java.lang.String max
        A string message representing a high or maximum value.
      • min

        public java.lang.String min
        A string message representing a low or minimum value.
      • state

        public java.lang.Boolean state
        A true or false describing the state of the tagged device.
      • init

        public java.lang.String init
        An initialization parameter for the tagged device.
      • clusterName

        public java.lang.String clusterName
        The name of the cluster to which the tagged device is associated. Nested clusters will have a forward slash ("/") between each cluster, much like a path.
      • branchVector

        public java.util.Vector<TaggedDevice> branchVector
        A Vector of branches describing how to physically get to the tagged device through a set of 1-Wire switches.
    • Constructor Detail

      • TaggedDevice

        public TaggedDevice​(DSPortAdapter adapter,
                            java.lang.String netAddress)
        Creates an object for the device with the supplied address and device type connected to the supplied port adapter.
        Parameters:
        adapter - The adapter serving the sensor.
        netAddress - The 1-Wire network address of the sensor.
      • TaggedDevice

        public TaggedDevice()
        Creates an object for the device.
    • Method Detail

      • setDeviceContainer

        public void setDeviceContainer​(DSPortAdapter adapter,
                                       java.lang.String netAddress)
        Sets the 1-Wire Container for the tagged device.
      • setDeviceType

        public void setDeviceType​(java.lang.String tType)
        Sets the device type for the tagged device.
        Parameters:
        tType -
      • setLabel

        public void setLabel​(java.lang.String Label)
        Sets the label for the tagged device.
        Parameters:
        Label -
      • setChannelFromString

        public void setChannelFromString​(java.lang.String Channel)
        Sets the channel for the tagged device from a String.
        Parameters:
        Channel -
      • setChannel

        public void setChannel​(int channel)
        Sets the channel for the tagged device from an int.
        Parameters:
        Channel -
      • setInit

        public void setInit​(java.lang.String init)
        Sets the init (initialization String) for the tagged device.
        Parameters:
        init -
      • setClusterName

        public void setClusterName​(java.lang.String cluster)
        Sets the cluster name for the tagged device.
        Parameters:
        cluster -
      • setBranches

        public void setBranches​(java.util.Vector<TaggedDevice> branches)
        Sets the vector of branches to get to the tagged device.
        Parameters:
        branches -
      • setOWPath

        public void setOWPath​(OWPath branchOWPath)
        Sets the OWPath for the tagged device. An OWPath is a description of how to physically get to a 1-Wire device through a set of nested 1-Wire switches.
        Parameters:
        branchOWPath -
      • setOWPath

        public void setOWPath​(DSPortAdapter adapter,
                              java.util.Vector<TaggedDevice> Branches)
        Sets the OWPath for the tagged device. An OWPath is a description of how to physically get to a 1-Wire device through a set of nested 1-Wire switches.
        Parameters:
        adapter -
        Branches -
      • getDeviceContainer

        public OneWireContainer getDeviceContainer()
        Gets the 1-Wire Container for the tagged device.
        Returns:
        The 1-Wire container for the tagged device.
      • getDeviceType

        public java.lang.String getDeviceType()
        Gets the device type for the tagged device.
        Returns:
        The device type for the tagged device.
      • getLabel

        public java.lang.String getLabel()
        Gets the label for the tagged device.
        Returns:
        The label for the tagged device.
      • getChannelAsString

        public java.lang.String getChannelAsString()
        Gets the channel for the tagged device as a String.
        Returns:
        The channel for the tagged device as a String.
      • getChannel

        public int getChannel()
        Gets the channel for the tagged device as an int.
        Returns:
        The channel for the tagged device as an int.
      • getInit

        public java.lang.String getInit()
        Gets the init (Initialization String) for the tagged device.
        Returns:
        String init (Initialization String)
      • getMax

        public java.lang.String getMax()
        Gets the max string for the tagged device.
        Returns:
        String Gets the max string
      • getMin

        public java.lang.String getMin()
        Gets the min string for the tagged device.
        Returns:
        String Gets the min string
      • getClusterName

        public java.lang.String getClusterName()
        Gets the cluster name for the tagged device.
        Returns:
        The cluster name for the tagged device.
      • getBranches

        public java.util.Vector<TaggedDevice> getBranches()
        Gets a vector of branches (to get to) the tagged device.
        Returns:
        The vector of branches to get to the tagged device.
      • getOWPath

        public OWPath getOWPath()
        Gets the OWPath for the tagged device. An OWPath is a description of how to physically get to a 1-Wire device through a set of nested 1-Wire switches.
        Returns:
        The OWPath for the tagged device.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object