Skip to content

Class: SystemStatePropertiesΒΆ

Properties for SYSTEM features storing application state

URI: debrief:class/SystemStateProperties

 classDiagram
    class SystemStateProperties
    click SystemStateProperties href "../../classes/SystemStateProperties/"
      SystemStateProperties : active_storyboard_id

      SystemStateProperties : current_time

      SystemStateProperties : display_mode





        SystemStateProperties --> "0..1" DisplayModeEnum : display_mode
        click DisplayModeEnum href "../../enums/DisplayModeEnum/"



      SystemStateProperties : end_time

      SystemStateProperties : filter_end_time

      SystemStateProperties : filter_start_time

      SystemStateProperties : kind





        SystemStateProperties --> "1" FeatureKindEnum : kind
        click FeatureKindEnum href "../../enums/FeatureKindEnum/"



      SystemStateProperties : playback_rate

      SystemStateProperties : provenance





        SystemStateProperties --> "*" LogEntry : provenance
        click LogEntry href "../../classes/LogEntry/"



      SystemStateProperties : rotation

      SystemStateProperties : selected_ids

      SystemStateProperties : selected_primary

      SystemStateProperties : start_time

      SystemStateProperties : state_type





        SystemStateProperties --> "1" SystemStateTypeEnum : state_type
        click SystemStateTypeEnum href "../../enums/SystemStateTypeEnum/"



      SystemStateProperties : step_size





        SystemStateProperties --> "0..1" TimeStep : step_size
        click TimeStep href "../../classes/TimeStep/"



      SystemStateProperties : viewport





        SystemStateProperties --> "0..1" ViewportPolygon : viewport
        click ViewportPolygon href "../../classes/ViewportPolygon/"

SlotsΒΆ

Name Cardinality and Range Description Inheritance
kind 1
FeatureKindEnum		 Feature type discriminator direct
state_type 1
SystemStateTypeEnum		 Discriminator for state variant (temporal, spatial, selection, active_storybo... direct
start_time 0..1
datetime		 Analytical window start (ISO8601) - for temporal state direct
end_time 0..1
datetime		 Analytical window end (ISO8601) - for temporal state direct
current_time 0..1
datetime		 Playhead position at save (ISO-8601) direct
filter_start_time 0..1
datetime		 Visible-window filter start (ISO-8601) direct
filter_end_time 0..1
datetime		 Visible-window filter end (ISO-8601) direct
display_mode 0..1
DisplayModeEnum		 Track visualization mode for this plot direct
step_size 0..1
TimeStep		 Playback step granularity for this plot direct
playback_rate 0..1
Float		 Playback speed multiplier for this plot (0 direct
viewport 0..1
ViewportPolygon		 Saved map viewport (ViewportPolygon) direct
rotation 0..1
Float		 Map rotation in degrees (0-360) direct
selected_ids *
String		 Array of selected feature IDs - for selection state direct
selected_primary 0..1
String		 Primary selection path for properties display direct
active_storyboard_id 0..1
String		 Storyboard properties direct
provenance *
LogEntry		 PROV-aligned provenance records (append-only log of tool operations) direct

UsagesΒΆ

used by used in type used
SystemState properties range SystemStateProperties

RulesΒΆ

ΒΆ

| Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------|| slot_conditions |{'state_type': {'equals_string': 'temporal'}} |{'start_time': {'required': True}, 'end_time': {'required': True}} | |

ΒΆ

| Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------|| slot_conditions |{'state_type': {'equals_string': 'spatial'}} |{'viewport': {'required': True}} | |

ΒΆ

| Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------|| slot_conditions |{'state_type': {'equals_string': 'selection'}} |{'selected_ids': {'required': True}} | |

ΒΆ

| Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------|| slot_conditions |{'state_type': {'equals_string': 'active_storyboard'}} |{'active_storyboard_id': {'required': True}} | |

Identifier and Mapping InformationΒΆ

Schema SourceΒΆ

  • from schema: https://debrief.info/schemas/debrief

MappingsΒΆ

Mapping Type Mapped Value
self debrief:SystemStateProperties
native debrief:SystemStateProperties

LinkML SourceΒΆ

DirectΒΆ

name: SystemStateProperties
description: Properties for SYSTEM features storing application state
from_schema: https://debrief.info/schemas/debrief
attributes:
  kind:
    name: kind
    description: Feature type discriminator
    from_schema: https://debrief.info/schemas/geojson
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    - StoryboardProperties
    - SceneProperties
    - MCPSelectionRequirement
    range: FeatureKindEnum
    required: true
    equals_string: SYSTEM
  state_type:
    name: state_type
    description: Discriminator for state variant (temporal, spatial, selection, active_storyboard)
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: SystemStateTypeEnum
    required: true
  start_time:
    name: start_time
    description: Analytical window start (ISO8601) - for temporal state
    from_schema: https://debrief.info/schemas/geojson
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - SystemStateProperties
    range: datetime
  end_time:
    name: end_time
    description: Analytical window end (ISO8601) - for temporal state
    from_schema: https://debrief.info/schemas/geojson
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - SystemStateProperties
    range: datetime
  current_time:
    name: current_time
    description: Playhead position at save (ISO-8601). When present, must lie within
      [start_time, end_time] (enforced by the load validator, not the schema).
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: datetime
  filter_start_time:
    name: filter_start_time
    description: Visible-window filter start (ISO-8601). Absent = unbounded start.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: datetime
  filter_end_time:
    name: filter_end_time
    description: Visible-window filter end (ISO-8601). Absent = unbounded end.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: datetime
  display_mode:
    name: display_mode
    description: Track visualization mode for this plot.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    - SceneProperties
    range: DisplayModeEnum
  step_size:
    name: step_size
    description: Playback step granularity for this plot.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: TimeStep
  playback_rate:
    name: playback_rate
    description: Playback speed multiplier for this plot (0.1-100).
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: float
    minimum_value: 0.1
    maximum_value: 100.0
  viewport:
    name: viewport
    description: Saved map viewport (ViewportPolygon). Identity-mapped to SpatialSlice.viewport.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    - SpatialSlice
    - SceneProperties
    range: ViewportPolygon
  rotation:
    name: rotation
    description: Map rotation in degrees (0-360).
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    - SpatialSlice
    range: float
    minimum_value: 0
    maximum_value: 360
  selected_ids:
    name: selected_ids
    description: Array of selected feature IDs - for selection state
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: string
    multivalued: true
  selected_primary:
    name: selected_primary
    description: Primary selection path for properties display.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: string
  active_storyboard_id:
    name: active_storyboard_id
    description: Storyboard properties.id the analyst last pinned for this plot (#237)
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    domain_of:
    - SystemStateProperties
    range: string
  provenance:
    name: provenance
    description: PROV-aligned provenance records (append-only log of tool operations)
    from_schema: https://debrief.info/schemas/geojson
    domain_of:
    - BaseFeatureProperties
    - SystemStateProperties
    - SystemRecordProperties
    range: LogEntry
    multivalued: true
    inlined: true
    inlined_as_list: true
rules:
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: temporal
  postconditions:
    slot_conditions:
      start_time:
        name: start_time
        required: true
      end_time:
        name: end_time
        required: true
  description: temporal variant requires start_time and end_time
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: spatial
  postconditions:
    slot_conditions:
      viewport:
        name: viewport
        required: true
  description: spatial variant requires viewport
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: selection
  postconditions:
    slot_conditions:
      selected_ids:
        name: selected_ids
        required: true
  description: selection variant requires selected_ids
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: active_storyboard
  postconditions:
    slot_conditions:
      active_storyboard_id:
        name: active_storyboard_id
        required: true
  description: active_storyboard variant requires active_storyboard_id

InducedΒΆ

name: SystemStateProperties
description: Properties for SYSTEM features storing application state
from_schema: https://debrief.info/schemas/debrief
attributes:
  kind:
    name: kind
    description: Feature type discriminator
    from_schema: https://debrief.info/schemas/geojson
    alias: kind
    owner: SystemStateProperties
    domain_of:
    - BaseFeatureProperties
    - TrackProperties
    - ReferenceLocationProperties
    - SystemStateProperties
    - MultiPointFeatureProperties
    - MultiPolygonFeatureProperties
    - NarrativeEntryProperties
    - CircleAnnotationProperties
    - RectangleAnnotationProperties
    - LineAnnotationProperties
    - TextAnnotationProperties
    - VectorAnnotationProperties
    - PolyAnnotationProperties
    - SelectionRequirement
    - SystemRecordProperties
    - StoryboardProperties
    - SceneProperties
    - MCPSelectionRequirement
    range: FeatureKindEnum
    required: true
    equals_string: SYSTEM
  state_type:
    name: state_type
    description: Discriminator for state variant (temporal, spatial, selection, active_storyboard)
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: state_type
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: SystemStateTypeEnum
    required: true
  start_time:
    name: start_time
    description: Analytical window start (ISO8601) - for temporal state
    from_schema: https://debrief.info/schemas/geojson
    alias: start_time
    owner: SystemStateProperties
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - SystemStateProperties
    range: datetime
  end_time:
    name: end_time
    description: Analytical window end (ISO8601) - for temporal state
    from_schema: https://debrief.info/schemas/geojson
    alias: end_time
    owner: SystemStateProperties
    domain_of:
    - SegmentMetadata
    - TrackProperties
    - SystemStateProperties
    range: datetime
  current_time:
    name: current_time
    description: Playhead position at save (ISO-8601). When present, must lie within
      [start_time, end_time] (enforced by the load validator, not the schema).
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: current_time
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: datetime
  filter_start_time:
    name: filter_start_time
    description: Visible-window filter start (ISO-8601). Absent = unbounded start.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: filter_start_time
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: datetime
  filter_end_time:
    name: filter_end_time
    description: Visible-window filter end (ISO-8601). Absent = unbounded end.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: filter_end_time
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: datetime
  display_mode:
    name: display_mode
    description: Track visualization mode for this plot.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: display_mode
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    - SceneProperties
    range: DisplayModeEnum
  step_size:
    name: step_size
    description: Playback step granularity for this plot.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: step_size
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: TimeStep
  playback_rate:
    name: playback_rate
    description: Playback speed multiplier for this plot (0.1-100).
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: playback_rate
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: float
    minimum_value: 0.1
    maximum_value: 100.0
  viewport:
    name: viewport
    description: Saved map viewport (ViewportPolygon). Identity-mapped to SpatialSlice.viewport.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: viewport
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    - SpatialSlice
    - SceneProperties
    range: ViewportPolygon
  rotation:
    name: rotation
    description: Map rotation in degrees (0-360).
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: rotation
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    - SpatialSlice
    range: float
    minimum_value: 0
    maximum_value: 360
  selected_ids:
    name: selected_ids
    description: Array of selected feature IDs - for selection state
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: selected_ids
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: string
    multivalued: true
  selected_primary:
    name: selected_primary
    description: Primary selection path for properties display.
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: selected_primary
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: string
  active_storyboard_id:
    name: active_storyboard_id
    description: Storyboard properties.id the analyst last pinned for this plot (#237)
    from_schema: https://debrief.info/schemas/geojson
    rank: 1000
    alias: active_storyboard_id
    owner: SystemStateProperties
    domain_of:
    - SystemStateProperties
    range: string
  provenance:
    name: provenance
    description: PROV-aligned provenance records (append-only log of tool operations)
    from_schema: https://debrief.info/schemas/geojson
    alias: provenance
    owner: SystemStateProperties
    domain_of:
    - BaseFeatureProperties
    - SystemStateProperties
    - SystemRecordProperties
    range: LogEntry
    multivalued: true
    inlined: true
    inlined_as_list: true
rules:
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: temporal
  postconditions:
    slot_conditions:
      start_time:
        name: start_time
        required: true
      end_time:
        name: end_time
        required: true
  description: temporal variant requires start_time and end_time
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: spatial
  postconditions:
    slot_conditions:
      viewport:
        name: viewport
        required: true
  description: spatial variant requires viewport
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: selection
  postconditions:
    slot_conditions:
      selected_ids:
        name: selected_ids
        required: true
  description: selection variant requires selected_ids
- preconditions:
    slot_conditions:
      state_type:
        name: state_type
        equals_string: active_storyboard
  postconditions:
    slot_conditions:
      active_storyboard_id:
        name: active_storyboard_id
        required: true
  description: active_storyboard variant requires active_storyboard_id