Broadcast Tuple Reference

From Planimate Knowledge Base
Jump to: navigation, search

This is a summary of the Item attributes that will be set by Planimate when broadcasts are sent to broadcast entries by the engine. These broadcasts usually occur because the modeller has selected an option on an object, for example selecting the "Send Table Click" option in a table view and specified a broadcast name to use. Other broadcasts are automatically sent by the engine and just require a receiving broadcast entry, configured to "listen" to the correct broadcast name. These are indicated below.

It is up to the modeller to ensure that the item class involved has the correctly named attribute, otherwise the attribute will be skipped (but an item will still be generated).

Each collection of attributes is referred to as a Tuple.

The attribute names all start with underscore to set them apart from attributes that the modeller uses for general modelling, hence names starting with underscore should be avoided unless specifically being used to receive the tuples defined here.

The format of an attribute should usually be a value. Times are best formatted as time/calendar values. _pipeid and _paintid are Model Objects labels and Paint Objects labels respectively. _panel is a Model Panels label.

The remainder of this page is created automatically by Planimate 8.99.0. Please do not edit it.

Table Cell Click (TableClick)

Information about clicks and some keypresses on table cells

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _view_row
  • _view_col
  • _from_row
  • _from_col
  • _to_row
  • _to_col
  • _previous
  • _current
  • _row
  • _col
  • _contextclick
  • _buttons
  • _key
  • _dataid
  • _beforeedit


Table Scroll Change (TableScroll)

Notification of a change in a table view's scroll

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _rowscroll
  • _colscroll


Train Graph Click (TrainClick)

Information about clicks in train graphs

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _command
  • _row1
  • _row2
  • _time
  • _y


Gantt Graph Click (GanttClick)

Information about clicks in gantt graphs

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _command
  • _row1
  • _row2
  • _time
  • _y
  • _drag_type
  • _buttons


Log Driven Graph Click (GraphClick)

Information about clicks in log driven graphs

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _command
  • _time
  • _y
  • _buttons


Grid View Click (GridClick)

Information about clicks in grid views

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _row
  • _col


Column Overlay Graph Click (OvGraphClick)

Information about clicks in column overlay graphs

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _command
  • _row
  • _col
  • _x
  • _y


Page Printed Broadcast (PagePrint)

Notification that a page was printed so another can be scheduled

This is sent when the engine generates broadcasts _Page Printed. These item attributes will be set:

  • _page
  • _panel


Attribute View Click (AttributeEdit)

Notification that an attribute has been edited

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _previous
  • _current


Table Sorted By User (TableSort)

Notification that a table has been sorted

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _sort1
  • _sort2
  • _sort3
  • _sort4
  • _sort5
  • _sort6
  • _sort7
  • _sort8


Spatial Link Click (LinkClick)

Information about clicks on a spatial link

This is sent when the engine generates broadcasts _Link Clicked. These item attributes will be set:

  • _from
  • _to
  • _x
  • _y
  • _ratio
  • _buttons
  • _bendpoint
  • _bendtablerow
  • _dragged
  • _road


Click or Hover (Click)

Information about clicks or drags on a portal

This is sent when the engine generates broadcasts _Portal Moved; _Portal Clicked; _Portal Hover. These item attributes will be set:

  • _x
  • _y
  • _panel
  • _buttons
  • _location


Table Data Modified (TableCalc)

Notification that a cell in a table has been modified by calculations

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _row
  • _col


Paint Object State Change (PaintState)

Notification that a paint object has changed state

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _state
  • _paintid
  • _hovered


Time scroller position/resize (Scroller)

Information about drags on a graph time scroller

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _pos
  • _width


Modeller defined menubar for model users (UserMenu)

Information about selections from a user defined menu bar

This is sent when the engine generates broadcasts _Menu Command. These item attributes will be set:

  • _command


Click on paint object (ButtonClick)

Information about clicks on user paint objects

This is sent when the engine generates broadcasts _Paint Objects;_Model Panels. These item attributes will be set:

  • _panel
  • _paintid
  • _location


Change In Attribute (ChangeEvent)

Notification of changing of a watched attribute

This is sent when the engine generates broadcasts _Change Tracking. These item attributes will be set:

  • _logtime
  • _logvalue
  • _logid


Pipe Source Or Target Limit (PipeEvent)

Notification that a pipe has hit a limit condition

This is sent when the engine generates broadcasts _Pipe Event. These item attributes will be set:

  • _pipeid
  • _pipeflags
  • _pipetablerow
  • _pipechanged


Dragging in a panel's background (PanelDrag)

Information about drags on a panel's background

This is sent when the engine generates broadcasts _Panel Drag. These item attributes will be set:

  • _panel
  • _command
  • _dx
  • _dy
  • _keys
  • _buttons
  • _location
  • _delta


Track Section Click (TrackClick)

Information about clicks on a track section

This is sent when the engine generates broadcasts _Track Clicked. These item attributes will be set:

  • _section
  • _from
  • _to
  • _x
  • _y
  • _ratio
  • _buttons


Table Column Filter Change (TableFilter)

Notification that a change was made to a column filter

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _dataid
  • _view_col
  • _col


Key Pressed (KeyPress)

Notification that a key was pressed

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _panel
  • _keycode


Table Column Width Change (ColumnWidth)

Notification that a change was made to a column's width

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _dataid
  • _view_col
  • _col
  • _width


Panel resized by user (PanelResize)

Notification that a dynamically sized panel has been resized by the user

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _panel
  • _width
  • _height


Scroll wheel event (Scroll)

Notification of scroll wheel being turned

This is sent when the engine generates broadcasts _Panel Scroll. These item attributes will be set:

  • _panel
  • _scroll


Follow Animating Item (FollowItem)

Update BC for active follow item position

This is sent when the engine generates broadcasts _Follow Item. These item attributes will be set:

  • _panel
  • _location
  • _id
  • _x
  • _y


User click on item (ItemClick)

User clicked on an item

This is sent when the engine generates broadcasts _Item Click. These item attributes will be set:

  • _id
  • _x
  • _y
  • _location
  • _object
  • _buttons


Hovering Over Cells (TableHover)

Tracks mouse hovers over cells, entire rows/columns

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _row
  • _col


Tail of train leaving a section/road (TailExitTrack)

Train with trail moves to point where tail clears a track road

This is sent when the engine generates broadcasts _TrainTailExitTrk. These item attributes will be set:

  • _id
  • _section
  • _road
  • _taildata1
  • _taildata2
  • _taildata3
  • _taildata4


Tail of train leaving a multi-server (TailExitServer)

Train with trail moves to point where tail clears a multi-server

This is sent when the engine generates broadcasts _TrainTailExitSvr. These item attributes will be set:

  • _id
  • _object
  • _taildata1
  • _taildata2
  • _taildata3
  • _taildata4


Pipe Click (PipeClick)

Information about clicks on a pipe

This is sent when the engine generates broadcasts _Pipe Clicked. These item attributes will be set:

  • _from
  • _to
  • _x
  • _y
  • _ratio
  • _buttons


Object Change (ObjChange)

Change in object's occupancy or state

This is sent when the engine generates broadcasts _ObjectChange. These item attributes will be set:

  • _location
  • _state
  • _occupancy
  • _incount
  • _outcount


Hover over graph (GraphHover)

Hovering over graph

This is sent when the engine generates broadcasts _GraphHover. These item attributes will be set:

  • _x
  • _y
  • _datax
  • _datay
  • _datay2


After Paste (Pasted)

User pasted into table

This is sent by a broadcast chosen by the modeller. These item attributes will be set:

  • _dataid
  • _panel
  • _errorcount