Package svs_simulation :: Package simtime :: Module timelib :: Class SimClock
[show private | hide private]
[frames | no frames]

Class SimClock


Provides time playback in simulation.
Method Summary
  __init__(self, startTime, endTime, timeStep, timeStepDuration, looping)
  decode(self, data)
Applies encoded data to self.
  encode(self)
Returns encoded representation of self.
  reset(self)
Resets playback time to start.
  setup(self, startTime, endTime, timeStep, timeStepDuration, looping)
Initialises basic clock properties.
  start(self, timeStep)
Starts playback.
  stop(self)
Stops playback.
  tick(self)
Increments SimClock.currentTime by SimClock.timeStep.
  update(self, realTime)
Updates clock in relation to real time.

Method Details

decode(self, data)

Applies encoded data to self.

encode(self)

Returns encoded representation of self.

@rtype:dict

reset(self)

Resets playback time to start.

setup(self, startTime=<svs_simulation.simtime.timelib.SimTime instance at 0x307..., endTime=<svs_simulation.simtime.timelib.SimTime instance at 0x307..., timeStep=<svs_simulation.simtime.timelib.SimTime instance at 0x307..., timeStepDuration=1.0, looping=False)

Initialises basic clock properties.

start(self, timeStep=None)

Starts playback. If time step is specified uses this instead of default value (l{time_const.DEFAULT_TIMESTEP}).

stop(self)

Stops playback.

tick(self)

Increments SimClock.currentTime by SimClock.timeStep.

update(self, realTime)

Updates clock in relation to real time.

This is called by an external event loop.

Generated by Epydoc 2.1 on Thu Oct 20 15:30:28 2005 http://epydoc.sf.net