com.serotonin.mango.rt.dataSource.onewire

Class Network

java.lang.Object

com.serotonin.mango.rt.dataSource.onewire.Network

public class Network
extends java.lang.Object

A utility that can scan a network, and return the network to its pre-scan state. This is important because we can't necessarily tell the difference between relays (that are controlling equipment), and latches (that are serving as branches to other devices).

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private com.dalsemi.onewire.adapter.DSPortAdapter	adapter
private static java.lang.String	DEFAULT_ADAPTER_NAME
(package private) java.util.Map<java.lang.Long,NetworkPath>	pathsByAddress The unique address of the device, and the network path to it.

Constructor Summary

Constructors

Constructor and Description
Network(com.dalsemi.onewire.adapter.DSPortAdapter adapter)
Network(java.lang.String commPortId)
Network(java.lang.String adapterName, java.lang.String commPortId)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addressPathsToString()
java.lang.String	getAdapterName()
java.util.List<java.lang.Long>	getAddresses()
NetworkPath	getNetworkPath(java.lang.Long address)
java.lang.String	getPortName()
void	initialize()
private void	initializeImpl(NetworkPath path, java.util.List<NetworkPathElement> toTurnBackOn) Recursive method for searching the network.
void	lock()
void	quickInitialize()
private void	quickInitializeImpl(NetworkPath path) Recursive method for searching the network.
void	reset()
void	terminate()
void	unlock()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ADAPTER_NAME

private static final java.lang.String DEFAULT_ADAPTER_NAME

See Also:

Constant Field Values

adapter

private final com.dalsemi.onewire.adapter.DSPortAdapter adapter

pathsByAddress

final java.util.Map<java.lang.Long,NetworkPath> pathsByAddress

The unique address of the device, and the network path to it.

Constructor Detail

Network

public Network(com.dalsemi.onewire.adapter.DSPortAdapter adapter)

Network

public Network(java.lang.String commPortId)
        throws com.dalsemi.onewire.adapter.OneWireIOException,
               com.dalsemi.onewire.OneWireException

Throws:

com.dalsemi.onewire.adapter.OneWireIOException

com.dalsemi.onewire.OneWireException

Network

public Network(java.lang.String adapterName,
               java.lang.String commPortId)
        throws com.dalsemi.onewire.adapter.OneWireIOException,
               com.dalsemi.onewire.OneWireException

Throws:

com.dalsemi.onewire.adapter.OneWireIOException

com.dalsemi.onewire.OneWireException

Method Detail

initialize

public void initialize()
                throws java.lang.Exception

Throws:

java.lang.Exception

quickInitialize

public void quickInitialize()
                     throws java.lang.Exception

Throws:

java.lang.Exception

terminate

public void terminate()
               throws com.dalsemi.onewire.OneWireException

Throws:

com.dalsemi.onewire.OneWireException

lock

public void lock()
          throws com.dalsemi.onewire.OneWireException

Throws:

com.dalsemi.onewire.OneWireException

reset

public void reset()
           throws com.dalsemi.onewire.OneWireException

Throws:

com.dalsemi.onewire.OneWireException

unlock

public void unlock()

getAdapterName

public java.lang.String getAdapterName()

getPortName

public java.lang.String getPortName()
                             throws com.dalsemi.onewire.OneWireException

Throws:

com.dalsemi.onewire.OneWireException

getAddresses

public java.util.List<java.lang.Long> getAddresses()

getNetworkPath

public NetworkPath getNetworkPath(java.lang.Long address)

addressPathsToString

public java.lang.String addressPathsToString()

initializeImpl

private void initializeImpl(NetworkPath path,
                            java.util.List<NetworkPathElement> toTurnBackOn)
                     throws com.dalsemi.onewire.OneWireException

Recursive method for searching the network.

Parameters:

path -

Throws:

com.dalsemi.onewire.OneWireException

com.dalsemi.onewire.adapter.OneWireIOException

java.lang.Exception

quickInitializeImpl

private void quickInitializeImpl(NetworkPath path)
                          throws com.dalsemi.onewire.OneWireException

Recursive method for searching the network. Only treats 1F containers as network branches, so the overhead of checking other latch types is avoided.

Parameters:

path -

Throws:

com.dalsemi.onewire.OneWireException

com.dalsemi.onewire.adapter.OneWireIOException

java.lang.Exception