Package jmri.jmrix.dccpp

Class DCCppClockControl

java.lang.Object

jmri.implementation.DefaultClockControl

jmri.jmrix.dccpp.DCCppClockControl

All Implemented Interfaces:

EventListener, ClockControl, AbstractMRListener, DCCppListener

public class DCCppClockControl
extends DefaultClockControl
implements DCCppListener

Class providing Clock Control to the DCC-EX client. Does nothing unless "Synchronize Internal Fast Clock and DCC-EX Fast Clock" is enabled. If "Time Source" is "Internal Computer Clock", send any changes to Fast Clock Rate or Time to the command station. If "Time Source" is "DCC-EX Fast Clock", listen for incoming Time messages and set the Fast Clock from these. Ignores incoming Rate messages.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Calendar	_cal
(package private) DCCppSystemConnectionMemo	_memo
(package private) DCCppTrafficController	_tc
(package private) boolean	isRunning
(package private) PropertyChangeListener	minuteChangeListener
(package private) static final long	MSECPERHOUR
(package private) static final long	MSECPERMINUTE
(package private) Timebase	timebase

Constructor Summary

Constructors

Constructor	Description
DCCppClockControl(DCCppSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
String	getHardwareClockName()	Get name of hardware clock, shown in UI
double	getRate()	Default implementation returns the rate of the internal clock.
Date	getTime()	Default implementation returns InstanceM default jmri.Timebase getTime().
void	initializeHardwareClock(double rate, Date now, boolean getTime)	Default implementation is to ignore this request.
void	message(DCCppMessage msg)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message sent to the layout.
void	message(DCCppReply msg)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout.
void	notifyTimeout(DCCppMessage msg)	Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
boolean	requiresIntegerRate()	Prevent user entry of a fractional rate, since DCC-EX only supports integer rates
void	setRate()
void	setRate(double newRate)	Send the new fastclock rate to CS if internal is master AND synchronize enabled send rate of zero if clock is not running Note: fastclock rate and time are in a single message
void	setTime()
void	setTime(Date newTimestamp)	Send the new fast clock time to CS if internal is master AND synchronize enabled Note: fastclock rate and time are in a single message
void	startHardwareClock(Date now)	Pause, unpause and initialize fast clock
void	stopHardwareClock()	Default implementation is to ignore.

Methods inherited from class jmri.implementation.DefaultClockControl

canCorrectHardwareClock, canSet12Or24HourClock, getStatus

Methods inherited from class java.lang.Object

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

Field Details

_memo

DCCppSystemConnectionMemo _memo

_tc

DCCppTrafficController _tc

timebase

Timebase timebase

_cal

Calendar _cal

minuteChangeListener

PropertyChangeListener minuteChangeListener

isRunning

boolean isRunning

MSECPERHOUR

static final long MSECPERHOUR

See Also:

• Constant Field Values

MSECPERMINUTE

static final long MSECPERMINUTE

See Also:

• Constant Field Values

Constructor Details

DCCppClockControl

public DCCppClockControl(DCCppSystemConnectionMemo memo)

Method Details

getHardwareClockName

public String getHardwareClockName()

Get name of hardware clock, shown in UI

Specified by:

getHardwareClockName in interface ClockControl

Overrides:

getHardwareClockName in class DefaultClockControl

Returns:

the name

setRate

public void setRate(double newRate)

Send the new fastclock rate to CS if internal is master AND synchronize enabled send rate of zero if clock is not running Note: fastclock rate and time are in a single message

Specified by:

setRate in interface ClockControl

Overrides:

setRate in class DefaultClockControl

Parameters:

newRate - the new rate

setRate

public void setRate()

getRate

public double getRate()

Description copied from class: DefaultClockControl

Default implementation returns the rate of the internal clock. Get the rate of the Fast Clock.

The rate is a number that multiplies the wall clock. For example, a rate of 4 specifies that the fast clock runs 4 times faster than the wall clock.

Specified by:

getRate in interface ClockControl

Overrides:

getRate in class DefaultClockControl

Returns:

Fast Clock rate.

setTime

public void setTime(Date newTimestamp)

Send the new fast clock time to CS if internal is master AND synchronize enabled Note: fastclock rate and time are in a single message

Specified by:

setTime in interface ClockControl

Overrides:

setTime in class DefaultClockControl

Parameters:

newTimestamp - the new time

setTime

public void setTime()

getTime

public Date getTime()

Description copied from class: DefaultClockControl

Default implementation returns InstanceM default jmri.Timebase getTime(). ie. the time of the internal clock. Get the fast clock time.

Specified by:

getTime in interface ClockControl

Overrides:

getTime in class DefaultClockControl

Returns:

current time.

startHardwareClock

public void startHardwareClock(Date now)

Pause, unpause and initialize fast clock

Specified by:

startHardwareClock in interface ClockControl

Overrides:

startHardwareClock in class DefaultClockControl

Parameters:

now - the starting time

stopHardwareClock

public void stopHardwareClock()

Description copied from class: DefaultClockControl

Default implementation is to ignore. Stop hardware fast clock. This is provided for the case where the hardware clock can be stopped and started.

Specified by:

stopHardwareClock in interface ClockControl

Overrides:

stopHardwareClock in class DefaultClockControl

initializeHardwareClock

public void initializeHardwareClock(double rate,
 Date now,
 boolean getTime)

Description copied from class: DefaultClockControl

Default implementation is to ignore this request. Initialize the hardware fast clock Note: When the hardware clock control receives this, it should initialize those clock settings that are available on the hardware clock. This method is used when the fast clock is started, and when time source, synchronize, or correct options are changed. If rate is 0.0, the hardware clock should be initialized "stopped", and the current rate saved for when the clock is restarted. If getTime is "true" the time from the hardware clock should be used in place of the supplied time if possible.

Specified by:

initializeHardwareClock in interface ClockControl

Overrides:

initializeHardwareClock in class DefaultClockControl

Parameters:

rate - the rate

now - the time

getTime - true if hardware clock should be used; false otherwise

requiresIntegerRate

public boolean requiresIntegerRate()

Prevent user entry of a fractional rate, since DCC-EX only supports integer rates

Specified by:

requiresIntegerRate in interface ClockControl

Overrides:

requiresIntegerRate in class DefaultClockControl

Returns:

true if integer rates only; false otherwise

message

public void message(DCCppReply msg)

Description copied from interface: DCCppListener

Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout.

Specified by:

message in interface DCCppListener

Parameters:

msg - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.

message

public void message(DCCppMessage msg)

Description copied from interface: DCCppListener

Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message sent to the layout. Normally, this function will do nothing.

Specified by:

message in interface DCCppListener

Parameters:

msg - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.

notifyTimeout

public void notifyTimeout(DCCppMessage msg)

Description copied from interface: DCCppListener

Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.

Specified by:

notifyTimeout in interface DCCppListener

Parameters:

msg - the message that timed out.