Package jmri.jmrix.srcp

Class SRCPClockControl

java.lang.Object

jmri.implementation.DefaultClockControl

jmri.jmrix.srcp.SRCPClockControl

All Implemented Interfaces:

ClockControl

public class SRCPClockControl
extends DefaultClockControl

Class providing SRCP Clock Control to the SRCP client.

See Also:

• SRCP TIME documentation

Field Summary

Fields

Modifier and Type	Field	Description
(package private) SRCPBusConnectionMemo	_memo
(package private) SRCPTrafficController	_tc

Constructor Summary

Constructors

Constructor	Description
SRCPClockControl(SRCPBusConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
String	getHardwareClockName()	Get name of hardware clock
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)	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.
void	setRate(double newRate)	Get and set the rate of the fast clock Note: The rate is an integer that multiplies the wall clock For example, a rate of 4 specifies that the fast clock runs 4 times faster than the wall clock.
void	setTime(Date now)	Set and get the fast clock time For the default implementation,set time is ignored and getTime returns the time of the internal clock; Date format sent as yyyyDDD HH mm ss , YearJulDay Hour Minute Seconds
void	startHardwareClock(Date now)	Start and stop hardware fast clock Many hardware fast clocks continue to run indefinitely.
void	stopHardwareClock()	Default implementation is to ignore.

Methods inherited from class jmri.implementation.DefaultClockControl

canCorrectHardwareClock, canSet12Or24HourClock, getStatus, requiresIntegerRate

Methods inherited from class java.lang.Object

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

Field Details

_memo

SRCPBusConnectionMemo _memo

_tc

SRCPTrafficController _tc

Constructor Details

SRCPClockControl

public SRCPClockControl(SRCPBusConnectionMemo memo)

Method Details

getHardwareClockName

public String getHardwareClockName()

Get name of hardware clock

Specified by:

getHardwareClockName in interface ClockControl

Overrides:

getHardwareClockName in class DefaultClockControl

Returns:

the name

setRate

public void setRate(double newRate)

Get and set the rate of the fast clock Note: The rate is an integer that multiplies the wall clock For example, a rate of 4 specifies that the fast clock runs 4 times faster than the wall clock. For the default implementation, setRate is ignored, and getRate returns the rate of the internal clock;

Specified by:

setRate in interface ClockControl

Overrides:

setRate in class DefaultClockControl

Parameters:

newRate - the new rate

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)

Set and get the fast clock time For the default implementation,set time is ignored and getTime returns the time of the internal clock; Date format sent as yyyyDDD HH mm ss , YearJulDay Hour Minute Seconds

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)

Start and stop hardware fast clock Many 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)

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. Default implementation is to ignore this request.

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