Package jmri.jmrix.ecos

Class EcosProgrammer

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrix.AbstractProgrammer

jmri.jmrix.ecos.EcosProgrammer

All Implemented Interfaces:

EventListener, PropertyChangeFirer, PropertyChangeProvider, Disposable, AbstractMRListener, EcosListener, Programmer

Direct Known Subclasses:

EcosOpsModeProgrammer

public class EcosProgrammer
extends AbstractProgrammer
implements EcosListener

Implements the jmri.Programmer interface via commands for the ECoS programmer. This provides a service mode programmer.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Programmer

Programmer.Configurator, Programmer.WriteConfirmMode

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	_cv
(package private) boolean	_progRead
(package private) int	_val
(package private) static final int	COMMANDSENT
(package private) int	ecosObject
(package private) static final int	MODESENT
(package private) static final int	NOTPROGRAMMING
(package private) int	progState
(package private) String	readCommand
(package private) EcosTrafficController	tc
(package private) String	writeCommand

Fields inherited from class jmri.jmrix.AbstractProgrammer

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
EcosProgrammer(EcosTrafficController etc)

Method Summary

Modifier and Type	Method	Description
void	confirmCV(String CV, int val, ProgListener p)	Confirm the value of a CV using the specified programming mode.
List<ProgrammingMode>	getSupportedModes()	Get the list of ProgrammingMode supported by this Programmer.
void	message(EcosMessage m)
protected void	notifyProgListenerEnd(int value, int status)	Internal method to notify of the final result.
void	readCV(String CVname, ProgListener p)	Perform a CV read in the system-specific manner, and using the specified programming mode.
void	reply(EcosReply reply)
protected void	timeout()	Internal routine to handle a timeout, should be synchronized!
protected void	useProgrammer(ProgListener p)
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, getCanRead, getCanRead, 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, dispose, getConfigurator, notifyProgListenerEnd, readCV, removePropertyChangeListener

Field Details

tc

EcosTrafficController tc

ecosObject

int ecosObject

readCommand

String readCommand

writeCommand

String writeCommand

progState

int progState

NOTPROGRAMMING

static final int NOTPROGRAMMING

See Also:

• Constant Field Values

MODESENT

static final int MODESENT

See Also:

• Constant Field Values

COMMANDSENT

static final int COMMANDSENT

See Also:

• Constant Field Values

_progRead

boolean _progRead

_val

int _val

_cv

int _cv

Constructor Details

EcosProgrammer

public EcosProgrammer(EcosTrafficController etc)

Method Details

getSupportedModes

@Nonnull
public List<ProgrammingMode> getSupportedModes()

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

Specified by:

getSupportedModes in interface Programmer

Specified by:

getSupportedModes in class AbstractProgrammer

Returns:

list of programming modes implemented for ECoS

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)

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

confirmCV

public void confirmCV(String CV,
 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:

CV - 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

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

useProgrammer

protected void useProgrammer(ProgListener p)
                      throws ProgrammerException

Throws:

ProgrammerException

message

public void message(EcosMessage m)

Specified by:

message in interface EcosListener

reply

public void reply(EcosReply reply)

Specified by:

reply in interface EcosListener

timeout

protected void timeout()

Internal routine to handle a timeout, should be synchronized! Internal routine to handle a timeout.

Specified by:

timeout in class AbstractProgrammer

notifyProgListenerEnd

protected void notifyProgListenerEnd(int value,
 int status)

Internal method to notify of the final result.

Parameters:

value - Value transferred, particularly if a read operation

status - Status of completed operation