/*---------------------------------------------------------------------------
 * Copyright (C) 1999,2000 Dallas Semiconductor Corporation, All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL DALLAS SEMICONDUCTOR BE LIABLE FOR ANY CLAIM, DAMAGES
 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Except as contained in this notice, the name of Dallas Semiconductor
 * shall not be used except as stated in the Dallas Semiconductor
 * Branding Policy.
 *---------------------------------------------------------------------------
 */

package com.dalsemi.onewire.utils;

import com.dalsemi.onewire.container.OneWireContainer;


/**
 * 1-Wire Network path element.
 *
 * @version    0.00, 18 September 2000
 * @author     DS
 */
public class OWPathElement
{

   //--------
   //-------- Variables 
   //--------

   /** OneWireContainer of the path element */
   private OneWireContainer owc;

   /** Channel the path is on */
   private int channel;

   //--------
   //-------- Constructors
   //--------
   private OWPathElement ()
   {
   }

   /**
    * Create a new path element
    *
    * @param  owcInstance device that is the path element. Must implement
    *         SwitchContainer.
    * @param  channelNumber channel number the path is on
    */
   public OWPathElement (OneWireContainer owcInstance, int channelNumber)
   {
      owc     = owcInstance;
      channel = channelNumber;
   }

   /**
    * Retrieve the container for this element
    *
    * @return OneWireContainer of elemement
    */
   public OneWireContainer getContainer ()
   {
      return owc;
   }

   /**
    * Retrieve the channel number of this element
    *
    * @return channel number of this element
    */
   public int getChannel ()
   {
      return channel;
   }
}