Issue subsystem general description

From Developer Documents
Revision as of 14:39, 11 March 2012 by Antti Villberg (talk | contribs) (Created page with "== Issue subsystem == An issue describes a condition in a model. Issues are categorized by severity in the following way * Fatal issues describe severe errors which for example...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Issue subsystem

An issue describes a condition in a model. Issues are categorized by severity in the following way

  • Fatal issues describe severe errors which for example prevent simulation
  • Error issues describe clear errors, which require user attention
  • Warning issues are indications that something may be wrong
  • Note issues are reminders about important things
  • Info issues are pieces of information linked to objects

Issues are somewhat related to events. The main difference between issues and events is that while events happen at a particular time, issues are conditions with a lifecycle. The different issue states are

  • Active, which means that the condition is true
  • Resolved, which means that the condition is no longer true

Issues are identified by the following data

  • A type resource
  • A main context resource
  • A list of secondary context resources

§ All issues are required to be part of a model (by ConsistsOf). § All issues are managed by an issue source

Issue sources are divided into the following categories

  • Batch issue sources, which can compute on demand a set of issues

from given context

  • Continuous issue sources, which can track the set of issues from given context

All issues declare the following properties needed to e.g. display the issue in the Issue View.

  • Description, which is a one-line text about the issue
  • Resource, which is a textual representation of the main context resource
  • Path, which us a textual representetion of the location of the main

context resource