SCCD/python/sccd/statechart/static/globals.py

from typing import *
from sccd.util.namespace import *
from sccd.util.duration import *
from sccd.util.debug import *
from sccd.common.exceptions import *

# Global values for all statecharts in a class diagram.
class Globals:
  def __init__(self):
    # All the event names in the model
    # self.events = Namespace()
    # self.out_events = Namespace()

    self.inports = Namespace()
    self.outports = Namespace()

    # All the duration literals occuring in action code expressions in the class diagram.
    self.durations: List[SCDurationLiteral] = []

    # The smallest unit for all durations in the model.
    # Upon simulation, all timestamps are multiples of this value.
    # Calculated after all expressions have been parsed, based on all DurationLiterals.
    self.delta: Optional[Duration] = None

  # parameter delta: if set, this will be the model delta.
  # otherwise, model delta will be the GCD of all durations registered.
  # typically, a 'delta' of 100us to 1ms is desirable because this will also be the 'precision' of input event timestamps.
  def init_durations(self, delta: Optional[Duration] = None):
    gcd_delta = gcd(*(d.d for d in self.durations))

    # Ensure delta not too big
    if delta:
      if duration(0) < gcd_delta < delta:
        raise ModelStaticError("Model contains duration deltas (smallest = %s) not representable with delta of %s." % (str(self.delta), str(delta)))
      else:
        self.delta = delta
    else:
      self.delta = gcd_delta

    if self.delta != duration(0):
      # Secretly convert all durations to integers of the same unit...
      for d in self.durations:
        d.opt = d.d // self.delta
    else:
      for d in self.durations:
        d.opt = 0

  def assert_ready(self):
    assert self.delta is not None # init_durations() not yet called