Package jmri.jmrix.roco.z21

Class Z21Adapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractNetworkPortController

jmri.jmrix.roco.z21.Z21Adapter

All Implemented Interfaces:

NetworkPortAdapter, PortAdapter

Direct Known Subclasses:

Z21SimulatorAdapter

public class Z21Adapter
extends AbstractNetworkPortController

Adapter representing a Z21 communication port.

Note: This connection uses UDP for communication.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractPortController

AbstractPortController.Option

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	COMMUNICATION_UDP_PORT
protected static java.lang.String	DEFAULT_IP_ADDRESS
protected static java.util.ResourceBundle	rb

Fields inherited from class jmri.jmrix.AbstractNetworkPortController

connTimeout, m_HostName, m_port, socketConn

Fields inherited from class jmri.jmrix.AbstractPortController

allowConnectionRecovery, manufacturerName, opened, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval

Constructor Summary

Constructors

Constructor	Description
Z21Adapter()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure all of the other jmrix widgets needed to work with this adapter
void	connect()	Open the connection.
void	dispose()	Clean up before removal.
java.net.DatagramSocket	getSocket()
Z21SystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo associated with this object.
protected void	resetupConnection()	Customizable method to deal with resetting a system connection after a successful recovery of a connection.
boolean	status()	Check that this object is ready to operate.

Methods inherited from class jmri.jmrix.AbstractNetworkPortController

autoConfigure, closeConnection, connect, getAdvertisementName, getConnectionTimeout, getCurrentPortName, getHostAddress, getHostName, getInputStream, getMdnsConfigure, getOutputStream, getPort, getServiceType, reconnectFromLoop, setAdvertisementName, setConnectionTimeout, setHostAddress, setHostName, setMdnsConfigure, setPort, setPort, setServiceType

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption1, configureOption2, configureOption3, configureOption4, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, recover, safeSleep, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.PortAdapter

configureOption1, configureOption2, configureOption3, configureOption4, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setManufacturer, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Field Detail

rb

protected static java.util.ResourceBundle rb

COMMUNICATION_UDP_PORT

protected static int COMMUNICATION_UDP_PORT

DEFAULT_IP_ADDRESS

protected static java.lang.String DEFAULT_IP_ADDRESS

Constructor Detail

Z21Adapter

public Z21Adapter()

Method Detail

configure

public void configure()

Configure all of the other jmrix widgets needed to work with this adapter

connect

public void connect()
             throws java.io.IOException

Description copied from interface: PortAdapter

Open the connection.

Specified by:

connect in interface PortAdapter

Overrides:

connect in class AbstractNetworkPortController

Throws:

java.io.IOException - if unable to connect

getSocket

public java.net.DatagramSocket getSocket()

Returns:

the DatagramSocket of this connection. Returns null if not connected.

status

public boolean status()

Check that this object is ready to operate. This is a question of configuration, not transient hardware status.

Specified by:

status in interface NetworkPortAdapter

Specified by:

status in interface PortAdapter

Overrides:

status in class AbstractPortController

Returns:

true if OK, at least as far as known

getSystemConnectionMemo

public Z21SystemConnectionMemo getSystemConnectionMemo()

Description copied from class: AbstractPortController

Get the SystemConnectionMemo associated with this object.

This method should only be overridden to ensure that a specific subclass of SystemConnectionMemo is returned. The recommended pattern is: public MySystemConnectionMemo getSystemConnectionMemo() { return (MySystemConnectionMemo) super.getSystemConnectionMemo(); }

Specified by:

getSystemConnectionMemo in interface PortAdapter

Overrides:

getSystemConnectionMemo in class AbstractPortController

Returns:

the currently associated SystemConnectionMemo

resetupConnection

protected void resetupConnection()

Customizable method to deal with resetting a system connection after a successful recovery of a connection.

Overrides:

resetupConnection in class AbstractNetworkPortController

dispose

public void dispose()

Description copied from class: AbstractPortController

Clean up before removal. Overriding methods must call super.dispose() or document why they are not calling the overridden implementation. In most cases, failure to call the overridden implementation will cause user-visible error.

Specified by:

dispose in interface PortAdapter

Overrides:

dispose in class AbstractPortController