AbstractClock (jadex-platform 3.0.0-RC32 API)

java.lang.Object
- jadex.platform.service.clock.AbstractClock

All Implemented Interfaces:

jadex.bridge.service.types.clock.IClock

Direct Known Subclasses:

ContinuousClock, SimulationEventClock, SimulationTickClock
```
public abstract class AbstractClock
extends java.lang.Object
implements jadex.bridge.service.types.clock.IClock
```
Abstract base class for all clocks.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`currenttime` The current time (last measurement).
`static long`	`DEFAULT_DELTA` The default delta (tick time).
`protected long`	`delta` The clock tick delta (relative to base time).
`protected java.util.List`	`listeners` The change listeners.
`protected java.lang.String`	`name` The clock name.
`protected long`	`starttime` The start time (model time).
`protected java.lang.String`	`state` The clock state.
`protected Timer`	`ticktimer` The tick timer.
`protected java.util.List`	`ticktimers` The tick timers.
`java.util.SortedSet`	`timers` The timers (entries ordered by timepoint).

Fields inherited from interface jadex.bridge.service.types.clock.IClock
EVENT_TYPE_NEW_DELTA, EVENT_TYPE_NEW_DILATION, EVENT_TYPE_NEXT_TIMEPOINT, EVENT_TYPE_RESET, EVENT_TYPE_STARTED, EVENT_TYPE_STOPPED, EVENT_TYPE_TIMER_ADDED, EVENT_TYPE_TIMER_REMOVED, STATE_RUNNING, STATE_SUSPENDED, TYPE_CONTINUOUS, TYPE_EVENT_DRIVEN, TYPE_SYSTEM, TYPE_TIME_DRIVEN

Constructor Summary

Constructors
Constructor and Description

AbstractClock(java.lang.String name, long starttime, long delta)
Create a new clock.

Constructors
Constructor and Description
`AbstractClock(java.lang.String name, long starttime, long delta)` Create a new clock.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`activateTickTimer()` Activate the tick timer.
`void`	`addChangeListener(jadex.commons.IChangeListener listener)` Add a change listener.
`void`	`addTickTimer(jadex.bridge.service.types.clock.ITimer timer)` Add a tick timer.
`void`	`addTimer(jadex.bridge.service.types.clock.ITimer timer)` Add a timer.
`protected void`	`copyFromClock(jadex.bridge.service.types.clock.IClock oldclock)` Transfer state from another clock to this clock.
`jadex.bridge.service.types.clock.ITimer`	`createTickTimer(jadex.bridge.service.types.clock.ITimedObject to)` Create a new tick timer.
`jadex.bridge.service.types.clock.ITimer`	`createTimer(long timespan, jadex.bridge.service.types.clock.ITimedObject to)` Create a new timer.
`void`	`dispose()` Called, when the clock is no longer used.
`long`	`getDelta()` Get the clock delta.
`java.lang.String`	`getName()` Get the current time.
`jadex.bridge.service.types.clock.ITimer`	`getNextTimer()` Get the next timer.
`long`	`getStarttime()` Get the clocks start time.
`java.lang.String`	`getState()` Get the clock state.
`double`	`getTick()` Get the current tick.
`jadex.bridge.service.types.clock.ITimer[]`	`getTickTimers()` Get all active tick timers.
`long`	`getTime()` Get the clocks name.
`jadex.bridge.service.types.clock.ITimer[]`	`getTimers()` Get all active timers.
`protected boolean`	`hasListeners()` Check if the clock has listeners.
`protected void`	`notifyListeners(jadex.commons.ChangeEvent ce)` Notify the listeners.
`void`	`removeChangeListener(jadex.commons.IChangeListener listener)` Remove a change listener.
`void`	`removeTickTimer(jadex.bridge.service.types.clock.ITimer timer)` Remove a tick timer.
`void`	`removeTimer(jadex.bridge.service.types.clock.ITimer timer)` Remove a timer.
`void`	`reset()` Reset the clock.
`void`	`setDelta(long delta)` Set the clock delta.
`void`	`setStarttime(long starttime)` Set the clocks start time.
`void`	`shutdown(jadex.commons.future.IResultListener listener)` Shutdown the service.
`void`	`start()` Start the clock.
`void`	`stop()` Stop the clock.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jadex.bridge.service.types.clock.IClock
getType

- Field Detail
  - DEFAULT_DELTA
```
public static final long DEFAULT_DELTA
```
    The default delta (tick time).
    
    See Also:
    
    Constant Field Values
  - name
```
protected java.lang.String name
```
    The clock name.
  - starttime
```
protected long starttime
```
    The start time (model time).
  - currenttime
```
protected long currenttime
```
    The current time (last measurement).
  - delta
```
protected long delta
```
    The clock tick delta (relative to base time).
  - state
```
protected java.lang.String state
```
    The clock state.
  - ticktimers
```
protected java.util.List ticktimers
```
    The tick timers.
  - timers
```
public java.util.SortedSet timers
```
    The timers (entries ordered by timepoint).
  - ticktimer
```
protected Timer ticktimer
```
    The tick timer.
  - listeners
```
protected java.util.List listeners
```
    The change listeners.
- Constructor Detail
  - AbstractClock
```
public AbstractClock(java.lang.String name,
                     long starttime,
                     long delta)
```
    Create a new clock.
- Method Detail
  - copyFromClock
```
protected void copyFromClock(jadex.bridge.service.types.clock.IClock oldclock)
```
    Transfer state from another clock to this clock.
  - dispose
```
public void dispose()
```
    Called, when the clock is no longer used.
    
    Specified by:
    
    dispose in interface jadex.bridge.service.types.clock.IClock
  - getName
```
public java.lang.String getName()
```
    Get the current time.
    
    Specified by:
    
    getName in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The current time.
  - getStarttime
```
public long getStarttime()
```
    Get the clocks start time.
    
    Specified by:
    
    getStarttime in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The start time.
  - setStarttime
```
public void setStarttime(long starttime)
```
    Set the clocks start time.
    
    Specified by:
    
    setStarttime in interface jadex.bridge.service.types.clock.IClock
  - getTime
```
public long getTime()
```
    Get the clocks name.
    
    Specified by:
    
    getTime in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The name.
  - getTick
```
public double getTick()
```
    Get the current tick.
    
    Specified by:
    
    getTick in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The current tick (can be in between ticks). Returns -1 if no tick size was specified (delta==0).
  - getDelta
```
public long getDelta()
```
    Get the clock delta.
    
    Specified by:
    
    getDelta in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The clock delta.
  - setDelta
```
public void setDelta(long delta)
```
    Set the clock delta. param delta The new clock delta.
    
    Specified by:
    
    setDelta in interface jadex.bridge.service.types.clock.IClock
  - getNextTimer
```
public jadex.bridge.service.types.clock.ITimer getNextTimer()
```
    Get the next timer.
    
    Specified by:
    
    getNextTimer in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The next timer.
  - getState
```
public java.lang.String getState()
```
    Get the clock state.
    
    Specified by:
    
    getState in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The clock state.
  - start
```
public void start()
```
    Start the clock.
    
    Specified by:
    
    start in interface jadex.bridge.service.types.clock.IClock
  - stop
```
public void stop()
```
    Stop the clock.
    
    Specified by:
    
    stop in interface jadex.bridge.service.types.clock.IClock
  - reset
```
public void reset()
```
    Reset the clock.
    
    Specified by:
    
    reset in interface jadex.bridge.service.types.clock.IClock
  - createTimer
```
public jadex.bridge.service.types.clock.ITimer createTimer(long timespan,
                                                           jadex.bridge.service.types.clock.ITimedObject to)
```
    Create a new timer.
    
    Specified by:
    
    createTimer in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    timespan - The timespan.
    
    to - The timed object.
  - createTickTimer
```
public jadex.bridge.service.types.clock.ITimer createTickTimer(jadex.bridge.service.types.clock.ITimedObject to)
```
    Create a new tick timer.
    
    Specified by:
    
    createTickTimer in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    to - The timed object.
    
    info - Optional info object.
  - getTimers
```
public jadex.bridge.service.types.clock.ITimer[] getTimers()
```
    Get all active timers.
    
    Specified by:
    
    getTimers in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The active timers.
  - getTickTimers
```
public jadex.bridge.service.types.clock.ITimer[] getTickTimers()
```
    Get all active tick timers.
    
    Specified by:
    
    getTickTimers in interface jadex.bridge.service.types.clock.IClock
    
    Returns:
    
    The active tick timers.
  - addTimer
```
public void addTimer(jadex.bridge.service.types.clock.ITimer timer)
```
    Add a timer.
    
    Specified by:
    
    addTimer in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    timer - The timer.
  - removeTimer
```
public void removeTimer(jadex.bridge.service.types.clock.ITimer timer)
```
    Remove a timer.
    
    Specified by:
    
    removeTimer in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    timer - The timer.
  - addTickTimer
```
public void addTickTimer(jadex.bridge.service.types.clock.ITimer timer)
```
    Add a tick timer.
    
    Specified by:
    
    addTickTimer in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    timer - The timer.
  - activateTickTimer
```
protected void activateTickTimer()
```
    Activate the tick timer.
  - removeTickTimer
```
public void removeTickTimer(jadex.bridge.service.types.clock.ITimer timer)
```
    Remove a tick timer.
    
    Specified by:
    
    removeTickTimer in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    timer - The timer.
  - addChangeListener
```
public void addChangeListener(jadex.commons.IChangeListener listener)
```
    Add a change listener.
    
    Specified by:
    
    addChangeListener in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    listener - The change listener.
  - removeChangeListener
```
public void removeChangeListener(jadex.commons.IChangeListener listener)
```
    Remove a change listener.
    
    Specified by:
    
    removeChangeListener in interface jadex.bridge.service.types.clock.IClock
    
    Parameters:
    
    listener - The change listener.
  - notifyListeners
```
protected void notifyListeners(jadex.commons.ChangeEvent ce)
```
    Notify the listeners.
  - hasListeners
```
protected boolean hasListeners()
```
    Check if the clock has listeners.
  - shutdown
```
public void shutdown(jadex.commons.future.IResultListener listener)
```
    Shutdown the service.
    
    Parameters:
    
    listener - The listener.

Class AbstractClock

Field Summary

Fields inherited from interface jadex.bridge.service.types.clock.IClock

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jadex.bridge.service.types.clock.IClock

Field Detail

DEFAULT_DELTA

name

starttime

currenttime

delta

state

ticktimers

timers

ticktimer

listeners

Constructor Detail

AbstractClock

Method Detail

copyFromClock

dispose

getName

getStarttime

setStarttime

getTime

getTick

getDelta

setDelta

getNextTimer

getState

start

stop

reset

createTimer

createTickTimer

getTimers

getTickTimers

addTimer

removeTimer

addTickTimer

activateTickTimer

removeTickTimer

addChangeListener

removeChangeListener

notifyListeners

hasListeners

shutdown