desmoj.core.simulator

Class SimClock

java.lang.Object

java.util.Observable

desmoj.core.simulator.SimClock

public class SimClock
extends java.util.Observable

The simulation clock shows the actual simulation time. The actual simulation time can be polled by any object but can only be set by the scheduler responsible for the actual model. The simulation clock is extending class java.util.Observable thus representing the 'observable' part in a 'observer'-design pattern as described in [Gamm95] page 107. This enables observers to register themselves at the simulation clock to be notified whenever the simulation time changes. This can be easily used to provide fully automatic statistical counters. Each time the simulation time changes, a counter registered at the simulation clock is notofied and can poll the value it is observing (most likely from a special ValueSupplier object). This way, no explicit calls for the counter to update its observed value are needed. Note that on the other hand this might reduce performance in comparison to explicit update call since the value under observation might not change each time the simulation time is changed.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler, modified by Soenke Claassen, modified by Felix Klueckmann Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also:

Observable

Constructor Summary

Constructors

Constructor and Description
SimClock(java.lang.String name) Constructs a simulation clock with no parameters given.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the clock's name as string.
TimeInstant	getTime() Returns the actual simulation time.
java.lang.String	toString() Returns the clock's name as string.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimClock

public SimClock(java.lang.String name)

Constructs a simulation clock with no parameters given. By default the actual simulation time is set to zero.

Parameters:

name - String : The name of the simulation clock

Method Detail

getName

public java.lang.String getName()

Returns the clock's name as string. This method has become necessary since the simulation clock does not extend class NamedObjectImp.

Returns:

java.lang.String : The clock's name

getTime

public TimeInstant getTime()

Returns the actual simulation time.

Returns:

TimeInstant : The actual simulation time

toString

public java.lang.String toString()

Returns the clock's name as string. This method has become necessary since the simulation clock does not extend class NamedObjectImp.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String : The clock's name