Broadcast Tuple Reference: Difference between revisions

From Planimate Knowledge Base
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:
__TOC__  
__TOC__  


=== Summary of item attributes set by broadcasts ===
== Table Cell Click (TableClick)  ==


== Table Cell Click (TableClick) ==
Information about clicks and some keypresses on table cells  
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:
This is sent by a broadcast chosen by the modeller. These item attributes will be set:  


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


<br>
== Table Scroll Change (TableScroll)  ==


== Table Scroll Change (TableScroll) ==
Notification of a change in a table view's scroll  
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:
This is sent by a broadcast chosen by the modeller. These item attributes will be set:  


*_rowscroll
*_rowscroll  
*_colscroll
*_colscroll


<br>


== Train Graph Click (TrainClick) ==
== 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:
Information about clicks in train graphs


*_command
This is sent by a broadcast chosen by the modeller. These item attributes will be set:
*_row1
 
*_row2
*_command  
*_time
*_row1  
*_row2  
*_time  
*_y
*_y


<br>
== Gantt Graph Click (GanttClick)  ==


== Gantt Graph Click (GanttClick) ==
Information about clicks in gantt graphs  
Information about clicks in gantt graphs


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


*_command
*_command  
*_row1
*_row1  
*_row2
*_row2  
*_time
*_time  
*_y
*_y


<br>
== Log Driven Graph Click (GraphClick)  ==


== Log Driven Graph Click (GraphClick) ==
Information about clicks in log driven graphs  
Information about clicks in log driven graphs


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


*_command
*_command  
*_time
*_time  
*_y
*_y  
*_buttons
*_buttons


<br>


== Grid View Click (GridClick) ==
== 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:
Information about clicks in grid views


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


<br>


== Column Overlay Graph Click (OvGraphClick) ==
== 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:
Information about clicks in column overlay graphs


*_command
This is sent by a broadcast chosen by the modeller. These item attributes will be set:
*_row
 
*_col
*_command  
*_x
*_row  
*_col  
*_x  
*_y
*_y


<br>
== Page Printed Broadcast (PagePrint)  ==


== Page Printed Broadcast (PagePrint) ==
Notification that a page was printed so another can be scheduled  
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:
This is sent when the engine generates broadcasts _Page Printed. These item attributes will be set:  


*_page
*_page  
*_panel
*_panel


<br>


== Attribute View Click (AttributeEdit) ==
== 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:
Notification that an attribute has been edited


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


<br>


== Table Sorted By User (TableSort) ==
== 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:
Notification that a table has been sorted


*_sort1
This is sent by a broadcast chosen by the modeller. These item attributes will be set:
*_sort2
 
*_sort3
*_sort1  
*_sort4
*_sort2  
*_sort5
*_sort3  
*_sort6
*_sort4  
*_sort7
*_sort5  
*_sort6  
*_sort7  
*_sort8
*_sort8


<br>


== Spatial Link Click (LinkClick) ==
== 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:
Information about clicks on a spatial link


*_from
This is sent when the engine generates broadcasts _Link Clicked. These item attributes will be set:
*_to
 
*_x
*_from  
*_y
*_to  
*_ratio
*_x  
*_y  
*_ratio  
*_buttons
*_buttons


<br>


== Click or Hover (Click) ==
== 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:
Information about clicks or drags on a portal


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


<br>


== Table Data Modified (TableCalc) ==
== 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:
Notification that a cell in a table has been modified by calculations


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


<br>


== Paint Object State Change (PaintState) ==
== 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:
Notification that a paint object has changed state


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


<br>
== Time scroller position/resize (Scroller)  ==


== Time scroller position/resize (Scroller) ==
Information about drags on a graph time 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:
This is sent by a broadcast chosen by the modeller. These item attributes will be set:  


*_pos
*_pos  
*_width
*_width


<br>
== Modeller defined menubar for model users (UserMenu)  ==


== Modeller defined menubar for model users (UserMenu) ==
Information about selections from a user defined menu bar  
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:
This is sent when the engine generates broadcasts _Menu Command. These item attributes will be set:  


*_command
*_command


<br>


== Click on paint object (ButtonClick) ==
== 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:
Information about clicks on user paint objects


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


<br>


== Change In Attribute (ChangeEvent) ==
== 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:
Notification of changing of a watched attribute


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


<br>


== Pipe Source Or Target Limit (PipeEvent) ==
== 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:
Notification that a pipe has hit a limit condition


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


<br>


== Dragging in a panel's background (PanelDrag) ==
== 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:
Information about drags on a panel's background


*_panel
This is sent when the engine generates broadcasts _Panel Drag. These item attributes will be set:
*_command
 
*_dx
*_panel  
*_dy
*_command  
*_keys
*_dx  
*_dy  
*_keys  
*_buttons
*_buttons


<br>


== Track Section Click (TrackClick) ==
== 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:
Information about clicks on a track section


*_section
This is sent when the engine generates broadcasts _Track Clicked. These item attributes will be set:
*_from
 
*_to
*_section  
*_x
*_from  
*_y
*_to  
*_ratio
*_x  
*_y  
*_ratio  
*_buttons
*_buttons


<br>
== Table Column Filter Change (TableFilter)  ==


== Table Column Filter Change (TableFilter) ==
Notification that a change was made to a column filter  
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:
This is sent by a broadcast chosen by the modeller. These item attributes will be set:  


*_dataid
*_dataid  
*_view_col
*_view_col  
*_col
*_col


<br>


== Key Pressed (KeyPress) ==
== 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:
Notification that a key was pressed


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


<br>


== Table Column Width Change (ColumnWidth) ==
== 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:
Notification that a change was made to a column's width


*_dataid
This is sent by a broadcast chosen by the modeller. These item attributes will be set:
*_view_col
 
*_col
*_dataid  
*_view_col  
*_col  
*_width
*_width


<br>


== Panel resized by user (PanelResize) ==
== 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:
Notification that a dynamically sized panel has been resized by the user


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

Revision as of 12:24, 3 March 2009

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. 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


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


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


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


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


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


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