Package jmri.jmrix.bidib

Class BiDiBOpsModeProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.bidib.BiDiBOpsModeProgrammer

All Implemented Interfaces:

AddressedProgrammer, PropertyChangeFirer, PropertyChangeProvider, Disposable, Programmer

public class BiDiBOpsModeProgrammer
extends AbstractProgrammer
implements AddressedProgrammer

Provides an Ops mode programming interface for BiDiB Currently only Byte mode is implemented, though BiDiB also supports bit mode writes for POM

See Also:

• Programmer

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
protected int	cv
protected int	mAddress
(package private) org.bidib.jbidibc.core.MessageListener	messageListener
protected org.bidib.jbidibc.messages.Node	node
protected static final int	NOTPROGRAMMING
protected ProgListener	progListener
protected int	progState
protected static final int	READREQUEST
protected BiDiBTrafficController	tc
protected int	value
protected static final int	WRITEREQUEST

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
BiDiBOpsModeProgrammer(int pAddress, BiDiBTrafficController controller)

Method Summary

Modifier and Type	Method	Description
void	confirmCV(String CVname, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
String	getAddress()
int	getAddressNumber()
boolean	getCanRead()	Checks the general read capability, regardless of mode
boolean	getCanRead(String addr)	Checks the general read capability, regardless of mode, for a specific address
boolean	getLongAddress()
List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	notifyProgListenerEnd(ProgListener p, int value, org.bidib.jbidibc.messages.enums.PomAcknowledge result)
void	readCV(String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
protected void	timeout()	Internal routine to handle a timeout, should be synchronized!
void	writeCV(String CVname, int val, ProgListener p)	Perform a CV write in the system-specific manner, and using the specified programming mode.

Methods inherited from class jmri.jmrix.AbstractProgrammer

decodeErrorCode, getBestMode, getCanWrite, getCanWrite, getMode, getWriteConfirmMode, registerFromCV, restartTimer, setMode, startLongTimer, startShortTimer, stopTimer

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Programmer

addPropertyChangeListener, decodeErrorCode, dispose, getCanWrite, getCanWrite, getConfigurator, getMode, getWriteConfirmMode, notifyProgListenerEnd, readCV, removePropertyChangeListener, setMode

Field Details

mAddress

protected int mAddress

progState

protected int progState

value

protected int value

cv

protected int cv

progListener

protected ProgListener progListener

NOTPROGRAMMING

protected static final int NOTPROGRAMMING

See Also:

• Constant Field Values

READREQUEST

protected static final int READREQUEST

See Also:

• Constant Field Values

WRITEREQUEST

protected static final int WRITEREQUEST

See Also:

• Constant Field Values

tc

protected BiDiBTrafficController tc

messageListener

org.bidib.jbidibc.core.MessageListener messageListener

node

protected org.bidib.jbidibc.messages.Node node

Constructor Details

BiDiBOpsModeProgrammer

public BiDiBOpsModeProgrammer(int pAddress,
 BiDiBTrafficController controller)

Method Details

writeCV

public void writeCV(String CVname,
 int val,
 ProgListener p)
             throws ProgrammerException

Perform a CV write in the system-specific manner, and using the specified programming mode.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier) Send an ops-mode write request to BiDiB.

Specified by:

writeCV in interface Programmer

Specified by:

writeCV in class AbstractProgrammer

Parameters:

CVname - the CV to write

val - the value to write

p - the listener that will be notified of the write

Throws:

ProgrammerException - if unable to communicate

readCV

public void readCV(String CVname,
 ProgListener p)
            throws ProgrammerException

Perform a CV read in the system-specific manner, and using the specified programming mode.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

Specified by:

readCV in interface Programmer

Specified by:

readCV in class AbstractProgrammer

Parameters:

CVname - the CV to read

p - the listener that will be notified of the read

Throws:

ProgrammerException - if unable to communicate

confirmCV

public void confirmCV(String CVname,
 int val,
 ProgListener p)
               throws ProgrammerException

Confirm the value of a CV using the specified programming mode. On some systems, this is faster than a read.

Handles a general address space through a String address. Each programmer defines the acceptable formats.

Note that this returns before the write is complete; you have to provide a ProgListener to hear about completion. For simplicity, expect the return to be on the GUI thread.

Exceptions will only be thrown at the start, not during the actual programming sequence. A typical exception would be due to an invalid mode (though that should be prevented earlier)

Specified by:

confirmCV in interface Programmer

Specified by:

confirmCV in class AbstractProgrammer

Parameters:

CVname - the CV to confirm

val - the value to confirm

p - the listener that will be notified of the confirmation

Throws:

ProgrammerException - if unable to communicate

notifyProgListenerEnd

public void notifyProgListenerEnd(ProgListener p,
 int value,
 org.bidib.jbidibc.messages.enums.PomAcknowledge result)

getSupportedModes

@Nonnull
public List<ProgrammingMode> getSupportedModes()

Get the list of ProgrammingMode supported by this Programmer. If the order is significant, earlier modes are better. Types implemented here.

Specified by:

getSupportedModes in interface Programmer

Specified by:

getSupportedModes in class AbstractProgrammer

Returns:

the list of supported modes or an empty list

getCanRead

public boolean getCanRead()

Checks the general read capability, regardless of mode Basic implementation. Override this to turn reading on and off globally. Can this ops-mode programmer read back values?

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class AbstractProgrammer

Returns:

true to allow us to trigger an ops mode read

getCanRead

public boolean getCanRead(String addr)

Checks the general read capability, regardless of mode, for a specific address Checks using the current default programming mode Checks using the current default programming mode

Specified by:

getCanRead in interface Programmer

Overrides:

getCanRead in class AbstractProgrammer

Parameters:

addr - the address to read

Returns:

true if the address can be read; false otherwise

getLongAddress

public boolean getLongAddress()

Specified by:

getLongAddress in interface AddressedProgrammer

getAddressNumber

public int getAddressNumber()

Specified by:

getAddressNumber in interface AddressedProgrammer

getAddress

public String getAddress()

Specified by:

getAddress in interface AddressedProgrammer

timeout

protected void timeout()

Internal routine to handle a timeout, should be synchronized!

Specified by:

timeout in class AbstractProgrammer