Package jmri.jmrix.loconet

Class LnClockControl

java.lang.Object

jmri.implementation.DefaultClockControl

jmri.jmrix.loconet.LnClockControl

All Implemented Interfaces:

EventListener, ClockControl, SlotListener

public class LnClockControl
extends DefaultClockControl
implements SlotListener

Implementation of the Hardware Fast Clock for LocoNet.

This module is based on a GUI module developed by Bob Jacobsen and Alex Shepherd to correct the LocoNet fast clock rate and synchronize it with the internal JMRI fast clock Timebase. The methods that actually send, correct, or receive information from the LocoNet hardware are repackaged versions of their code.

The LocoNet Fast Clock is controlled by the user via the Fast Clock Setup GUI that is accessed from the JMRI Tools menu.

For this implementation, "synchronize" implies "correct", since the two clocks run at a different rate.

Some of the message formats used in this class are Copyright Digitrax, Inc. and used with permission as part of the JMRI project. That permission does not extend to uses in other software products. If you wish to use this code, algorithm or these message formats outside of JMRI, please contact Digitrax Inc for separate permission.

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Timebase	clock
(package private) static final double	CORRECTION
(package private) PropertyChangeListener	minuteChangeListener
(package private) static final long	MSECPERHOUR
(package private) static final long	MSECPERMINUTE
(package private) final LnPowerManager	pm
(package private) final SlotManager	sm
(package private) final LnTrafficController	tc

Constructor Summary

Constructors

Constructor	Description
LnClockControl(LocoNetSystemConnectionMemo scm)	Create a ClockControl object for a LocoNet clock.
LnClockControl(SlotManager sm, LnTrafficController tc, LnPowerManager pm)	Create a ClockControl object for a LocoNet clock.

Method Summary

Modifier and Type	Method	Description
boolean	canCorrectHardwareClock()	Returns true if hardware clock accuracy can be corrected using the computer clock.
void	dispose()
String	getHardwareClockName()	Accessor routines
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	initiateRead()	Requests read of the LocoNet fast clock
void	newMinute()	Corrects the LocoNet Fast Clock
void	notifyChangedSlot(LocoNetSlot s)	Handle changed slot contents, due to clock changes.
boolean	requiresIntegerRate()	Default implementation returns false.
void	setRate(double newRate)	For the default implementation, setRate is ignored.
void	setTime(Date now)	For the default implementation, set time is ignored.
void	startHardwareClock(Date now)	Default implementation is to call SetTime to now.
void	stopHardwareClock()	Default implementation is to ignore.

Methods inherited from class jmri.implementation.DefaultClockControl

canSet12Or24HourClock, getStatus

Methods inherited from class java.lang.Object

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

Field Details

sm

final SlotManager sm

tc

final LnTrafficController tc

pm

final LnPowerManager pm

clock

Timebase clock

minuteChangeListener

PropertyChangeListener minuteChangeListener

MSECPERHOUR

static final long MSECPERHOUR

See Also:

• Constant Field Values

MSECPERMINUTE

static final long MSECPERMINUTE

See Also:

• Constant Field Values

CORRECTION

static final double CORRECTION

See Also:

• Constant Field Values

Constructor Details

LnClockControl

public LnClockControl(LocoNetSystemConnectionMemo scm)

Create a ClockControl object for a LocoNet clock.

Parameters:

scm - the LocoNet System Connection Memo to associate with this Clock Control object

LnClockControl

public LnClockControl(SlotManager sm,
 LnTrafficController tc,
 LnPowerManager pm)

Create a ClockControl object for a LocoNet clock.

Parameters:

sm - the Slot Manager associated with this object

tc - the Traffic Controller associated with this object

pm - the PowerManager associated with this object

Method Details

getHardwareClockName

public String getHardwareClockName()

Accessor routines

Specified by:

getHardwareClockName in interface ClockControl

Overrides:

getHardwareClockName in class DefaultClockControl

Returns:

the associated name

canCorrectHardwareClock

public boolean canCorrectHardwareClock()

Description copied from class: DefaultClockControl

Returns true if hardware clock accuracy can be corrected using the computer clock.

Hardware implementations should override this and return true if they can correct their hardware clock. Returns true if hardware clock accuracy can be corrected using the computer clock.

Specified by:

canCorrectHardwareClock in interface ClockControl

Overrides:

canCorrectHardwareClock in class DefaultClockControl

Returns:

true if correctable; false otherwise

setRate

public void setRate(double newRate)

Description copied from class: DefaultClockControl

For the default implementation, setRate is ignored. Set the rate of the Fast Clock.

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

Specified by:

setRate in interface ClockControl

Overrides:

setRate in class DefaultClockControl

Parameters:

newRate - the new rate

requiresIntegerRate

public boolean requiresIntegerRate()

Description copied from class: DefaultClockControl

Default implementation returns false.

If an integer rate is required by the hardware, this method should be overridden. Returns true if hardware clock requires an integer rate.

Specified by:

requiresIntegerRate in interface ClockControl

Overrides:

requiresIntegerRate in class DefaultClockControl

Returns:

true if integer rates only; false otherwise

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 now)

Description copied from class: DefaultClockControl

For the default implementation, set time is ignored. Set the fast clock time.

Specified by:

setTime in interface ClockControl

Overrides:

setTime in class DefaultClockControl

Parameters:

now - the new time

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)

Description copied from class: DefaultClockControl

Default implementation is to call SetTime to now. Start hardware fast clock Some hardware fast clocks continue to run indefinitely. This is provided for the case where the hardware clock can be stopped and started.

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

initiateRead

public void initiateRead()

Requests read of the LocoNet fast clock

newMinute

public void newMinute()

Corrects the LocoNet Fast Clock

notifyChangedSlot

public void notifyChangedSlot(LocoNetSlot s)

Handle changed slot contents, due to clock changes. Can get here three ways: 1) clock slot as a result of action by a throttle and 2) clock slot responding to a read from this module 3) a slot not involving the clock changing.

Specified by:

notifyChangedSlot in interface SlotListener

Parameters:

s - the LocoNetSlot object which has been changed

dispose

public void dispose()