IBM
Contents Index Previous Next



Notifications


The notifications inform the environment when something significantly happens. Notifications are only available as PostMaster messages.

To receive a notification one must subscribe on that particular notification (or on all notifications). This is accomplished either statically, by an entry in an additional configuration file, or dynamically by the services Add Tool and Add Tool Subscription.

Overview of Available Notifications

Tool notifications

Message Description
SESTARTNOTIFY

When a tool is started.

SESTOPNOTIFY

When a tool is stopped.

Diagram notifications

Message Description
SELOADNOTIFY

When a diagram is loaded.

SEUNLOADNOTIFY

When a diagram is unloaded.

SEDIRTYNOTIFY

When a diagram becomes modified.

SESAVENOTIFY

When a diagram is saved.

SESDLENEWNOTIFY

When an SDL diagram is created.

SEMSCENEWNOTIFY

When an MSC diagram is created.

SEOMENEWNOTIFY

When an OM diagram is created.

SETENEWNOTIFY

When a text diagram is created.

Start Notify

Description

This message is broadcast when a new tool is started. That is, when it connects to the PostMaster. It is sent automatically by the SPInit function.

Tools Issuing the Notification
The started tool
Notification
SESTARTNOTIFY

Parameter Type Description
toolType

integer

The kind of tool that was started.

argv0

string

The filename (with a complete path) of the started tool as obtained by reading argv[0].

Stop Notify

Description

This message is broadcast when the tool disconnects from the PostMaster and terminates.

Tools Issuing the Notification
The tool which stops
Notification
SESTOPNOTIFY

Parameter Type Description
toolType

integer

The kind of tool that stopped.

Load Notify

Description

Broadcast when the diagram is loaded in an editor.

Tools Issuing the Notification
SET_SDLE
SET_MSCE
SET_OME
SET_TE
Notification
SELOADNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the loaded diagram.

fileName

string

Name of the loaded file.

diagramType

integer

Diagram type of the loaded diagram.

diagramName

string

Diagram name of the loaded diagram.

Unload Notify

Description

Broadcast when the diagram is unloaded in the editor. No assumptions could be made whether or not the diagram was saved. The buffer id of the unloaded diagram is then not longer valid and cannot be used anymore.

Tools Issuing the Notification
SET_SDLE
SET_MSCE
SET_OME
SET_TE
Notification
SEUNLOADNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the unloaded diagram.

Dirty Notify

Description

Broadcast when a diagram becomes dirty, i.e. when the user has modified the diagram.

Tools Issuing the Notification
SET_SDLE
SET_MSCE
SET_OME
SET_TE
Notification
SEDIRTYNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the diagram that became dirty.

Save Notify

Description

The message is broadcast when a diagram is saved.

Tools Issuing the Notification
SET_SDLE
SET_MSCE
SET_OME
SET_TE
Notification
SESAVENOTIFY

Parameter Type Description
bufId

integer

Buffer id of the saved diagram.

fileName

string

The filename in which the diagram was saved.

SDL New Notify

Description

Broadcast when a diagram is created in the SDL Editor. In this case a Load Notify is not broadcast.

Tools Issuing the Notification
SET_SDLE
Notification
SESDLENEWNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the new diagram.

virtuality

string

Kind of virtuality

diagramType

integer

Type of diagram.

diagramName

string

Name of the diagram.

qualifier

string

A qualifier for the new diagram. The qualifier is not a full qualifier, since it does not include the diagram path to the root diagram.

MSC New Notify

Description

Broadcast when a diagram is created in the MSC Editor. In this case a Load Notify is not broadcast.

Tools Issuing the Notification
SET_MSCE
Notification
SEMSCENEWNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the new diagram.

diagramName

string

Name of the new diagram.

OM New Notify

Description

Broadcast when a diagram is created in the OM Editor. In this case a Load Notify is not broadcast.

Tools Issuing the Notification
SET_OME
Notification
SEOMENEWNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the new diagram.

diagramName

string

Name of the new diagram.

TE New Notify

Description

Broadcast when a diagram is created in the Text Editor. In this case a Load Notify is not broadcast.

Tools Issuing the Notification
SET_TE
Notification
SETENEWNOTIFY

Parameter Type Description
bufId

integer

Buffer id of the new diagram.

diagramName

string

Name of the new diagram.


http://www.ibm.com/rational
Contents Index Previous Next