OneWireContainer01 Class Reference

Inherits com::dalsemi::onewire::container::OneWireContainer.

List of all members.


Detailed Description

1-Wire® container that encapsulates the functionality of the 1-Wire family type 01 (hex), Maxim Integrated Products part number: DS1990A, Serial Number.

This 1-Wire device is used as a unique serial number.

Features

Alternate Names

DataSheets

http://pdfserv.maxim-ic.com/arpdf/DS1990A.pdf
http://pdfserv.maxim-ic.com/arpdf/DS2401.pdf
http://pdfserv.maxim-ic.com/arpdf/DS1420.pdf

Version:
0.00, 28 Aug 2000
Author:
DS

Public Member Functions

 OneWireContainer01 ()
 Create an empty container.
 OneWireContainer01 (DSPortAdapter sourceAdapter, byte[] newAddress)
 Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
 OneWireContainer01 (DSPortAdapter sourceAdapter, long newAddress)
 Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
 OneWireContainer01 (DSPortAdapter sourceAdapter, String newAddress)
 Create a container with a provided adapter object and the address of the iButton or 1-Wire device.
String getName ()
 Retrieves the Maxim Integrated Products part number of the 1-Wire device as a String.
String getAlternateNames ()
 Retrieves the alternate Maxim Integrated Products part numbers or names.
String getDescription ()
 Retrieves a short description of the function of the 1-Wire device type.

Constructor & Destructor Documentation

Create an empty container.

Must call setupContainer before using this new container.

This is one of the methods to construct a container. The others are through creating a OneWireContainer with parameters.

See also:
OneWireContainer01(DSPortAdapter,byte[])

OneWireContainer01(DSPortAdapter,long)

OneWireContainer01(DSPortAdapter,String)

setupContainer(DSPortAdapter,byte[])

setupContainer(DSPortAdapter,long)

setupContainer(DSPortAdapter,String)

OneWireContainer01 ( DSPortAdapter  sourceAdapter,
byte[]  newAddress 
)

Create a container with a provided adapter object and the address of the iButton or 1-Wire device.

This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.

Parameters:
sourceAdapter adapter object required to communicate with this iButton.
newAddress address of this 1-Wire device
See also:
OneWireContainer01()

com.dalsemi.onewire.utils.Address

OneWireContainer01 ( DSPortAdapter  sourceAdapter,
long  newAddress 
)

Create a container with a provided adapter object and the address of the iButton or 1-Wire device.

This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.

Parameters:
sourceAdapter adapter object required to communicate with this iButton.
newAddress address of this 1-Wire device
See also:
OneWireContainer01()

com.dalsemi.onewire.utils.Address

OneWireContainer01 ( DSPortAdapter  sourceAdapter,
String  newAddress 
)

Create a container with a provided adapter object and the address of the iButton or 1-Wire device.

This is one of the methods to construct a container. The other is through creating a OneWireContainer with NO parameters.

Parameters:
sourceAdapter adapter object required to communicate with this iButton.
newAddress address of this 1-Wire device
See also:
OneWireContainer01()

com.dalsemi.onewire.utils.Address


Member Function Documentation

String getName (  ) 

Retrieves the Maxim Integrated Products part number of the 1-Wire device as a String.

For example 'Crypto iButton' or 'DS1992'.

Returns:
1-Wire device name

Reimplemented from OneWireContainer.

String getAlternateNames (  ) 

Retrieves the alternate Maxim Integrated Products part numbers or names.

A 'family' of 1-Wire Network devices may have more than one part number depending on packaging. There can also be nicknames such as 'Crypto iButton'.

Returns:
1-Wire device alternate names

Reimplemented from OneWireContainer.

String getDescription (  ) 

Retrieves a short description of the function of the 1-Wire device type.

Returns:
device functional description

Reimplemented from OneWireContainer.


The documentation for this class was generated from the following file:

Generated on Thu Aug 28 15:42:33 2008 for 1-Wire API for .NET by  doxygen 1.5.6