com.ibutton.tmex.container
Interface iButtonContainer

All Known Implementing Classes:

iButtonContainer08, iButtonContainerGeneral, iButtonContainer09, iButtonContainer20, iButtonContainer40, iButtonContainer21, iButtonContainer10, iButtonContainer1A, iButtonContainer23, iButtonContainer11, iButtonContainer1B, iButtonContainer12, iButtonContainer1C, iButtonContainer0A, iButtonContainer1D, iButtonContainer01, iButtonContainer0B, iButtonContainer14, iButtonContainer02, iButtonContainer0C, iButtonContainer1F, iButtonContainer16, iButtonContainer04, iButtonContainer05, iButtonContainer0F, iButtonContainer18, iButtonContainer06

public abstract interface iButtonContainer

Interace that all iButton container classes must implement

Method Summary

java.lang.String	getAlternateNames() Retrieve the alternate Dallas Semiconductor part numbers or names.
java.lang.String	getDescription() Retrieve a short description of the function of the iButton type.
java.lang.String	getiButtonPartName() Retrieve the Dallas Semiconductor part number of the iButton as a string.
int[]	getID() Get the ID as an array of ints.
java.lang.String	getIDString() Get the ID as a String.
boolean	isAlarming() Checks to see that if the iButton is currently connected to the MicroLan whether it is in an 'alarm' condition.
boolean	isPresent() Verifies that this iButton is currently connected to the MicroLan.
void	setupContainer(DSPortAdapter sourceAdapter, iButtonID newID) Set the adapter object used to access this iButton and the ID

Method Detail

setupContainer

public void setupContainer(DSPortAdapter sourceAdapter,
                           iButtonID newID)

Set the adapter object used to access this iButton and the ID

getiButtonPartName

public java.lang.String getiButtonPartName()

Retrieve the Dallas Semiconductor part number of the iButton as a string. For example 'Crypto iButton' or 'DS1992'.

Returns:

string represetation of the iButton name.

getAlternateNames

public java.lang.String getAlternateNames()

Retrieve the alternate Dallas Semiconductor part numbers or names. A 'family' of MicroLAN devices may have more than one part number depending on packaging. There can also be nicknames such as 'Crypto iButton'.

Returns:

string represetation of the alternate names.

getDescription

public java.lang.String getDescription()

Retrieve a short description of the function of the iButton type.

Returns:

string represetation of the function description.

isPresent

public boolean isPresent()
                  throws PortNotSelectedException,
                         PortInUseException,
                         AdapterNotDetectedException,
                         MicroLanIOException

Verifies that this iButton is currently connected to the MicroLan.

Returns:

'true' if device present on the MicroLAN.

Throws:

PortNotSelectedException -

PortInUseException -

AdapterNotDetectedException -

MicroLanIOException -

isAlarming

public boolean isAlarming()
                   throws PortNotSelectedException,
                          PortInUseException,
                          AdapterNotDetectedException,
                          MicroLanIOException

Checks to see that if the iButton is currently connected to the MicroLan whether it is in an 'alarm' condition. This does not apply to all iButton types.

Returns:

'true' if device present on the MicroLAN.

Throws:

PortNotSelectedException -

PortInUseException -

AdapterNotDetectedException -

MicroLanIOException -

getID

public int[] getID()

Get the ID as an array of ints.

Returns:

array of ints that is the iButton ID

getIDString

public java.lang.String getIDString()

Get the ID as a String.

Returns:

String representation of the iButton ID