![]() |
![]() |
![]() |
![]() |
![]() |
Tool Services
Configuration Services
Start Tool
Description
This service will start the specified tool. On UNIX, start means that a new UNIX process is "fork'ed" and "exec'ed". In Windows, start means that the applications is started using the Windows API function CreateProcess.
The Service adds "-post" to the argv[1] variable.
The parameters are recognized by the started tool in the argv[] variable starting from index 2.
The started tool inherits the environment used by the PostMaster.
The service behaves somewhat differently from other services since it is performed both in the PostMaster and in the PostMaster library in the started tool. The service is initiated in the PostMaster creating the new tool, but the service is recognized to be completed when the started tool calls the PostMaster function SPInit. This call causes a SESTARTNOTIFY message to be sent. This message is recognized by the PostMaster which upon reception of the SESTARTNOTIFY also sends a SESTARTREPLY to the issues of the start service.
The service is also different in its nature since it will cause a time-out to expire if the started tool does not call the SPInit function within a certain time limit.
The started tool must have an entry in the PostMaster configuration and the associated file containing the tool to start must exist.
The service will return to the caller:
- When the SESTARTREPLY message is received by the caller.
- If the tool is only available in one instance and is already instantiated. In this case the process id of the already instantiated tool is returned.
- If the tool cannot be started or if the tool is not recognized by the PostMaster within a time-out. (The started tool calls SPInit.)
The following MSC diagram shows the protocol when a tool is started normally (the Organizer starts the editor).
The SESYNCCONNECT and the SESYNCCONNECTREPLY messages are not present in the Windows implementation.
Tools Supporting the Service
SET_POSTService Request
SESTART
Service Reply
SESTARTREPLY
status integer pId integerA PId identifying the tool type of which the corresponding type is started.
Errors
No such toolMax instances of toolAlready startedFile not found+ Operating System file access and process creation error messagesEmitted Notifications
SESTARTNOTIFYBroadcast by the started application when calling SPInit.
Stop Tool
Description
The tool disconnects from the Postmaster and then terminates.
Tools Supporting the Service
All toolsService Request
SESTOP
force boolIf false, the tool is allowed to reject the request. If true, the tool is expected to terminate
Service Reply
SESTOPREPLYErrors
Get Tool Type
Description
Returns the process type for a given process id.
Tools Supporting the Service
SET_POSTService Request
SEGETTOOLTYPE
pId integerA PId identifying the tool type of which the corresponding type is wanted.
Service Reply
SEGETTOOLTYPEREPLY
Errors
Get Tool Pid
Description
Returns the process id for the requested tool type. If multiple instances of the tool type exist, all PId values are returned.
Tools Supporting the Service
SET_POSTService Request
SEGETTOOLPID
toolType integerAn identifier for the tool type of which the corresponding PIds) are wanted.
Service Reply
SEGETTOOLPIDREPLY
status integer noOfPid integerNumber of PId values corresponding to the toolType. If the requested tool type was not found in the configuration, noOfPid is set to 0.
pId integerErrors
Add Tool
Description
Dynamically adds a tool type to the PostMaster configuration.
Tools Supporting the Service
SET_POSTService Request
SEADDTOOL
Service Reply
SEADDTOOLREPLY
status integer exist boolReturns false if the tool was inserted, true if it already existed.
Errors
Operation failedAdd Tool Subscription
Description
Dynamically adds a message to a tool's subscription list.
Tools Supporting the Service
SET_POSTService Request
SEADDTOOLSUBSCRIPTION
tooltype integerThe tool type to which a message subscription should be added.
message integerService Reply
SEADDTOOLSUBSCRIPTIONREPLY
status integer exist boolReturns false if the message was inserted, true if it already existed.
Errors
No such toolOperation failedSystem File Services
List System Files
Description
Lists the files currently held in the Diagram Structure chapter in the Organizer. The files will be returned in the order they are found in the Organizer (i.e. top-down, left-right).
Tools Supporting the Service
SET_ORGANIZERService Request
SELISTSYSTEMFILESService Reply
SELISTSYSTEMFILESREPLY
status integer noOfFiles integer file(s) stringA list of files, with a complete directory path. Each file specification is ended by a newline.
Errors
New System
Description
Clear the Organizer content and create a new system. Corresponds to the Organizer menu choice New.
Tools Supporting the Service
SET_ORGANIZERService Request
SENEWSYSTEM
forceQuit boolIf true, quit modified diagrams. If false and there were one or more modified diagrams, the service is denied.
Service Reply
SENEWSYSTEMREPLYErrors
Service request denied. No license available.Open System
Description
Opens a system file and displays the file contents in the Organizer. Corresponds to the Organizer menu command Open.
Tools Supporting the Service
SET_ORGANIZERService Request
SEOPENSYSTEM
filename string forceQuit boolIf true, quit modified diagrams. If false and modified diagram(s) exist(s), the service is denied.
Service Reply
SEOPENREPLY
status integer toolType integerThe type of tool. If the requested PId is not found, toolType 0 is returned.
Errors
Service request denied. No license availableCannot open, system modifiedError opening system A message box displays the errorSave System
Description
Corresponds to the Organizer menu command Save. Unconnected diagrams are saved in default file names; for more information, see Save in file.
Tools Supporting the Service
SET_ORGANIZERService Request
SESAVEALL
systemStructureOnly boolService Reply
SESAVEALLREPLYErrors
Service request denied. No license availableError save all A message box displays the errorAdd Existing
Description
Adds an existing document to the Organizer and optionally displays it in an editor. The type of document to be added and its corresponding editor depends on the extension of the given filename. This is the same mechanism as in the GUI-based equivalent. Corresponds to the Organizer menu choice Add Existing.
Tools Supporting the Service
SET_ORGANIZERService Request
SEADDEXISTING
Service Reply
SEADDEXISTINGREPLYErrors
Link File Services
Add Local Link File
Description
Prepares a personal link file for a user. Any changes in endpoint and link information after this service is called are saved into this file. The master link file can be read only for the user at this time.
Tools Supporting the Service
SET_ORGANIZERService Request
SEADDLOCALLINKFILEService Reply
SEADDLOCALLINKFILEREPLYErrors
Merge Local Link File
Description
Merges the changes saved into the personal link file into the master link file. After a successful merge, the local link file information is cleared.
Tools Supporting the Service
SET_ORGANIZERService Request
SEMERGELOCALLINKFILEService Reply
SEMERGELOCALLINKFILEREPLYErrors
TTCN Suite Services
Convert to GR
Description
Converts a MP file to TTCN-GR. One document file is generated in the specified destination directory. The document filename is generated by the TTCN Suite. The name of the destination directory is given. The parameter ignore page number indicates that any included page numbers in the MP file will be ignored.
The generated names are displayed in the Organizer log. For more information, see Importing a TTCN-MP Document.
Tools Supporting the Service
IET_BASEService Request
IEBXCONVERTTOGR
filename QString destination QString ignore page number boolService Reply
IEBXCONVERTTOGRREPLY
status integer itexfile QStringErrors
The MP file does not existIllegal MP fileThe file has no read permissionUnable to generate document files in the destinationLoad Document
Description
Given a source file path this function load the document. Then this document may be shown in the TTCN Browser using "Show" service. The source file may have MP format or TTCN GR format.
Note
Tools Supporting the Service
IET_BASEService Request
SELOADService Reply
Errors
No such file or directorySyntax errorShow Document
Description
Show the given document in the TTCN Browser.
Tools Supporting the Service
IET_BASEService Request
SESHOWService Reply
SESHOWREPLYErrors
Invalid buffer identifierOpened Documents
Description
Retrieves information about open documents known to TTCN Suite. The EBNF follows:
DocInfoList ::= empty | DocInfoList `<NewLine>'
DocInfoDocInfo ::= documentidentifier `:' buffid `:' itexfile `:' backupfileTools Supporting the Service
IET_BASEService Request
IEBXOPENEDDOCUMENTSService Reply
IEBXOPENEDDOCUMENTSREPLY
status integer infolist EBNFThe list of open documents identifiers, buffer identifiers and database file.
Errors
-Fetch Buffer Identifier Given the Database
Description
Given a database, this function fetches the document buffer identifier if the document is open.
Tools Supporting the Service
IET_BASEService Request
IEBXGETBUFFIDFROMPATHService Reply
IEBXGETBUFFIDFROMPATHREPLYErrors
Unable to find databaseFetch Buffer Identifier Given MP File Path
Description
Given a MP file path this function fetches the document buffer identifier if there is any database generated from this MP and the document in the database is open.
Tools Supporting the Service
IET_BASEService Request
IEBXGETBUFFIDFROMMPPATHService Reply
IEBXGETBUFFIDFROMMPPATHREPLYErrors
Unable to find databaseConvert to MP
Description
Generates a MP file for the given system node. This converts the entire document source (all TTCN objects) and does not consider the selection. The document must be connected but not necessarily open.
For more information, see Exporting a TTCN Document to TTCN-MP.
Tools Supporting the Service
IET_BASEService Request
IEBXCONVERTTOMP
buffid integer standard flag boolIndicates if the MP shall be TTCN standard. (True if standard MP is required.)
filename QStringService Reply
IEBXCONVERTTOMPREPLYErrors
Invalid buffer identifierThe document is not connectedUnable to write fileConvert Selection to MP
Description
Generates a MP file for the given system node. It converts only the selected parts of the document which means that the document needs both to be connected and open.
For more information, see Exporting a TTCN Document to TTCN-MP.
Tools Supporting the Service
IET_BASEService Request
IEBXCONVERTSELTOMP
buffid integer standard flag boolIndicates if the MP shall be TTCN standard. (True if standard MP is required.)
filename QStringService Reply
IEBXCONVERTSELTOMPREPLYErrors
Invalid buffer identifierThe document is not connectedThe document is not openUnable to write fileMerge Document
Description
This function is used to merge one document into another document. Both the source and the destination documents must be available to the TTCN Suite environment, i.e. both documents must be loaded. Furthermore a selection must exists in the source document.
For more information, see Merging TTCN Documents.
Tools Supporting the Service
IET_BASEService Request
IEBXMERGEDOCUMENT
srcbuffid integer destbuffid integerService Reply
IEBXMERGEDOCUMENTREPLYErrors
Unable to merge documentsAnalyze Document
Description
Analyze the given system node.
For more information, see Analyzing TTCN Documents (on UNIX), or Analyzing TTCN Documents (in Windows).
Tools Supporting the Service
IET_BASEService Request
IEBXANALYZE
buffid integer forced analysis bool verbose bool errorlimit integerService Reply
IEBXANALYZEREPLYErrors
Invalid buffer identifierThe document is not connectedClose Document
Description
This function closes the document and all open tables in it.
Tools Supporting the Service
IET_BASEService Request
IEBXCLOSEDOCUMENTService Reply
IEBXCLOSEDOCUMENTREPLYErrors
Invalid buffer identifierUnable to close documentSave Document
Description
Given the buffer identifier of the document the corresponding system node is saved in the given filename.
Tools Supporting the Service
IET_BASEService Request
IEBXSAVE
buffid integer filename QStringService Reply
IEBXSAVEREPLYErrors
No such toolInvalid buffer identifier
Couldn't write fileSelector
Description
Given restrictions and a database this function selects all objects which fulfill the restrictions. For more information, see Using More Complex Selections.
Note
Tools Supporting the Service
IET_BASEService Request
IEBXSELECTOR
Service Reply
IEBXSELECTORREPLYErrors
No such toolInvalid buffer identifierSelectAll
Description
Select all objects in the document.
Tools Supporting the Service
IET_BASEService Request
IEBXSELECTALLService Reply
IEBXSELECTALLREPLYErrors
Invalid buffer identifierDeselectAll
Description
Remove all selections in the document.
Tools Supporting the Service
IET_BASEService Request
IEBXDESELECTALLService Reply
IEBXDESELECTALLREPLYErrors
Invalid buffer identifierIsSelected
Description
This function checks if there is any object selected in the document.
Tools Supporting the Service
IET_BASEService Request
IEBXISSELECTEDService Reply
IEBXISSELECTEDREPLY
status integer selectstate boolErrors
Invalid buffer identifierGet Modify Time
Description
This function fetches the modify time of a document.
Tools Supporting the Service
IET_BASEService Request
IEBXGETDOCUMENTMODIFYTIMEService Reply
IEBXGETDOCUMENTMODIFYTIMEREPLY
status integer modifytime QStringErrors
Invalid buffer identifierGet Path
Description
Given a document buffer identifier this function fetches the corresponding database path.
Tools Supporting the Service
IET_BASEService Request
IEBXGETPATHService Reply
IEBXGETPATHREPLY
status integer itexfile QStringErrors
Invalid buffer identifierGet MP Path
Description
Given a document bufferid this function fetches the corresponding MP file path.
Tools Supporting the Service
IET_BASEService Request
IEBXGETMPPATHService Reply
IEBXGETMPPATHREPLYErrors
Invalid buffer identifierFind Table
Description
Given the buffer identifier of the selected document and a table identifier, TTCN Suite searches for the table. The found table is displayed in the Table Editor.
Tools Supporting the Service
IET_BASEService Request
IEBXFINDTABLE
buffid integer tableid QStringService Reply
IEBXFINDTABLEREPLYErrors
Invalid buffer identifierUnconnected documentClose Table
Description
Tools Supporting the Service
IET_BASEService Request
IEBXCLOSETABLE
buffid integer tableident QStringService Reply
IEBXCLOSETABLEREPLYErrors
Invalid buffer identifierNo such objectGet Table State
Description
This function returns the status of a given table. The status a table indicates if the table is open or close.
Tools Supporting the Service
IET_BASEService Request
IEBXGETTABLESTATE
buffid integer tableident QStringService Reply
IEBXGETTABLESTATEREPLY
status integer tablestate QStringErrors
Invalid buffer identifierNo such objectGet Row Number
Description
Given the name of a row this function returns the number (position) of it in the table. The row can be a row in a single or multiple table.
Tools Supporting the Service
IET_BASEService Request
IEBXGETROWNUMBER
buffid integer tableident QString rowname identifierService Reply
IEBXGETROWNUMBERREPLY
status integer rownumber integerErrors
Invalid buffer identifierNo such objectNo such rowSelect Row
Description
This function modifies the selection status of a given row in a table.
Tools Supporting the Service
IET_BASEService Request
IEBXSELECTROW
buffid integer tableident QString rownumber integer selectstate boolService Reply
IEBXSELECTROWREPLY
status integer exist boolReturns false if the message was inserted, true if it already existed.
Errors
Invalid buffer identifierNo such objectNo such rownumberClear Selection
Description
This function removes all row selections in a table.
Tools Supporting the Service
IET_BASEService Request
IEBXCLEARSELECTION
buffid integer tableident QStringService Reply
IEBXCLEARSELECTIONREPLYErrors
Invalid buffer identifierNo such objectRows Selected
Description
Given the buffer identifier and the table identifier, this function returns the numbers of the selected rows in a table (the first row has number 1).
Tools Supporting the Service
IET_BASEService Request
IEBXROWSSELECTED
buffid integer tableident QStringService Reply
IEBXROWSSELECTEDREPLY
status integer nonezero* integerA list of selected row numbers. The list is empty if no row is selected.
Errors
Invalid buffer identifierNo such objectMenu Manipulation Services
Introduction
All graphical tools in the SDL Suite support customizable menus. These user-defined menus will be appended to the menu bar of the tool. The exact location will be defined by the tool, depending on the abilities of the graphical framework the tool is built upon.
The intention is to have an external tool to configure a tool in order to provide the necessary UI. SDL Suite and TTCN Suite could also take advantage of these extendable menus.
The following operations are available through a set of well defined PostMaster messages:
Each menu choice can be associated to any of the following:
Add Menu
Description
Adds a new menu to the menu bar.
Tools Supporting the Service
SET_ORGANIZERSET_SDLESET_MSCESET_OMESET_TESET_SIMULATOR_UI 1SET_FILEVIEWERSET_COVERAGEVIEWERSET_XREFVIEWERSET_TYPEVIEWERSET_TREEVIEWERSET_PREFERENCESSET_HELPVIEWERService Request
SEMENUADDService Reply
SEMENUADDREPLYErrors
Delete Menu
Description
Removes the menu and its menu choices from the menu bar.
Tools Supporting the Service
SET_ORGANIZERSET_SDLESET_MSCESET_OMESET_TESET_SIMULATOR_UI 2SET_FILEVIEWERSET_COVERAGEVIEWERSET_XREFVIEWERSET_TYPEVIEWERSET_TREEVIEWERSET_PREFERENCESSET_HELPVIEWERService Request
SEMENUDELETEService Reply
SEMENUDELETEREPLYErrors
Clear Menu
Description
Clears the menu bar from a menu item.
Tools Supporting the Service
SET_ORGANIZERSET_SDLESET_MSCESET_OMESET_TESET_SIMULATOR_UI 3SET_FILEVIEWERSET_COVERAGEVIEWERSET_XREFVIEWERSET_TYPEVIEWERSET_TREEVIEWERSET_PREFERENCESSET_HELPVIEWERService Request
SEMENUCLEARService Reply
SEMENUCLEARREPLYErrors
Add Item to Menu
Description
Adds a menu choice to the specified menu. The menu choice could either perform an OS command or issue a PostMaster notification when selected. The OS command to perform or the message to broadcast could be sensitive on a selected symbol.
The description of the service parameters below is generic to all tools supporting the service. Some tools have special interpretations of some parameters. Some tools also allow format codes to be used in the command string or as message parameter, providing additional context sensitive information. Both these tool-specific issues are described separately in the following sections:
Tools Supporting the Service
SET_ORGANIZERSET_SDLESET_MSCESET_OMESET_TESET_SIMULATOR_UI 4SET_FILEVIEWERSET_COVERAGEVIEWERSET_XREFVIEWERSET_TYPEVIEWERSET_TREEVIEWERSET_PREFERENCESSET_HELPVIEWERService Request
SEMENUADDITEM
message integer params stringInterpreted as the parameters to the PostMaster message. Tool-specific context sensitive format codes are evaluated; see the separate tool descriptions later.
Service Reply
SEMENUADDITEMREPLYErrors
Add Item to Menu - Organizer
Description
Identical to the description of Add Item to Menu, except that the semantics of the parameters and supported format codes for the service differ.
Tools Supporting the Service
SET_ORGANIZERService Request
SEMENUADDITEMFormat Codes
The following format codes are recognized. There are format modifiers for some of the basic formats:
- B - the base filename
- D - the directory part of the full filename
- R - the filename, relative to the source directory
Parameters
Apart from providing a set of format codes, the Organizer gives special interpretation to the lastAction and scope parameters.
Add Item to Menu - Text Editor
Description
Identical to the description of Add Item to Menu, except that the semantics of the parameters and supported format codes for the service differ.
Tools Supporting the Service
SET_TEService Request
SEMENUADDITEMFormat Codes
The following format codes are recognized.
Add Item to Menu - Graphical Editors
Description
Identical to the description of Add Item to Menu, except that the semantic of the parameters and supported format codes for the service differ.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEMENUADDITEMFormat Codes
The following format codes are recognized.
Parameters
Apart from providing a set of format codes, the graphical editors give special interpretation to the lastAction, ProprietaryKey and AttributeKey parameters.
ProprietaryKey integerThe keys ProprietaryKey and AttributeKey are used to determine whether or not a menu choice should be available (i.e. dimmed or not). See Editor - Object Services for more information.
AttributeKey integer scope integer ALWAYS (0) ONE_SELECTED_OBJECT1 (1) MATCHING_KEYS (2) MATCHING_KEYS_ONE_SELEC TED_OBJECT (3)a.
1 Each tool should define and adopt conventions for when exactly one object only is considered as selected. For instance, selecting a task symbol in an SDL Editor also selects the from and to lines. However, attaching information to these lines does not fill any meaningful purpose; the SDL Editor considers the situation as if one object only (i.e. the task symbol) was selected.
Logging Services
Start MSC Log
Description
Starts the logging of messages sent by tools connected to the PostMaster. The format used by the log is event-oriented MSC/PR.
Tools Supporting the Service
SET_POSTService Request
SESTARTTRACE
Service Reply
SESTARTTRACEREPLYErrors
Stop MSC Log
Description
Stops the logging of messages sent by PostMaster tools.
Tools Supporting the Service
SET_POSTService Request
SESTOPTRACEService Reply
SESTOPTRACEREPLYErrors
SDT Reference Services
Show Source
Description
Selects the SDT reference in an editor. A reference could be:
- An SDL reference.
- An MSC reference.
- An OM reference.
- A text reference
- The reference is shown in a text editor. The text editor is chosen by the preference SDT*TextEditor.
For a complete description of the format of an SDT reference, please see SDT References.
Tools Supporting the Service
SET_ORGANIZERService Request
SESHOWREFService Reply
SESHOWREFREPLYErrors
SDT Reference ErrorsEmitted Notifications
SELOADNOTIFY SESDLELOADNOTIFY SEOMELOADNOTIFY SESTARTNOTIFYObtain GR Reference
Description
Returns the SDT references for the current selection(s) in the editors.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEOBTAINGRREFService Reply
SEOBTAINGRREFREPLY
status integer NoOfRef integer ref* stringErrors
SDT Reference ErrorsIllegal use of qualifierIllegal reference typeEditor - Diagram Services
The Buffer Concept
The editor defines the concept buffer, which basically identifies a diagram currently loaded in the editor. Each buffer is identified with a buffer id which is unique within one session of the editor as long as the editor is not stopped)
A buffer id is returned when an existing diagram is successfully loaded in an editor or a new diagram is created and implicitly loaded in the editor. Then, most services manipulating diagrams in editors, refer to the buffer containing the diagram via the buffer id.
Load Diagram
Description
Loads a diagram or text document specified by filename in an editor buffer. If the diagram was already loaded, the existing buffer id will be returned.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMESET_TEService Request
SELOAD
filename stringThe diagram file to load specified with the full directory path.
Service Reply
SELOADREPLY
status integer bufId integer type integer name stringErrors
Can not read file <filename> <error message>SDLE is busy, syntax error in text (SDLE only)Emitted Notifications
SELOADNOTIFY SESDLELOADNOTIFY SEOMELOADNOTIFYUnload Diagram
Description
Unloads a diagram from an editor.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMESET_TEService Request
SEUNLOAD
bufId integer forceUnload boolIf true, the editor will force a modified diagram to be unloaded. If false, the editor will not unload the diagram if it is modified.
Service Reply
SEUNLOADREPLYErrors
Invalid diagram buffer idDiagram is changed If force Unload is falseSDLE is busy, syntax error in text (SDLE only)Emitted Notifications
Show Diagram
Description
The service will raise a window in the editor showing the specified buffer.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMESET_TEService Request
SESHOW
Service Reply
SESHOWREPLYErrors
Invalid diagram buffer idUnable to open page (SDLE/OME only)SDLE is busy, syntax error in text (SDLE only)Emitted Notifications
Save Diagram
Description
The service will save the diagram in the specified file. If not a valid filename or if there is no permission to save the file, an error will be returned. When saved, the editor buffer is marked as not edited.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMESET_TEService Request
SESAVEService Reply
SESAVEREPLYErrors
Invalid diagram buffer IdDiagram is new. Filename is missing.Cannot save file <filename> <error message>SDLE is busy, syntax error in text (SDLE only)Emitted Notifications
Create SDL Diagram
Description
Creates an empty SDL diagram in a new buffer. The diagram gets an unconnected status. Corresponds to SDL Editor command New.
Tools Supporting the Service
SET_SDLEService Request
SESDLECREATEDIAGRAM
Service Reply
SESDLECREATEDIAGRAMREPLYErrors
SDLE is busy, syntax error in textEmitted Notifications
SESDLECREATENOTIFY SEPAGENOTIFYCreate MSC Diagram
Description
Creates an empty MSC diagram in new buffer. Corresponds to MSC Editor command New.
Tools Supporting the Service
SET_MSCEService Request
SEMSCECREATEDIAGRAM
diagramType integerDiagram type. Defined in sdtsym.h. The value MSCDIAGRAM (16) should be used.
name string qualifier stringService Reply
SEMSCECREATEDIAGRAMREPLYErrors
Emitted Notifications
Create OM Diagram
Description
Creates an empty OM diagram in new buffer. Corresponds to OM Editor command New.
Tools Supporting the Service
SET_OMEService Request
SEOMECREATEDIAGRAM
Service Reply
SEOMECREATEDIAGRAMREPLYErrors
Emitted Notifications
Create Text Diagram
Description
Creates an empty text diagram in new buffer. Corresponds to Text Editor command New.
Tools Supporting the Service
SET_TEService Request
SETECREATEDIAGRAM
diagramType integer name stringService Reply
SETECREATEREPLYErrors
Emitted Notifications
Editor - Object Services
Select Object
Description
The Select Object service will highlight an object in a diagram. Note that this command does not show the buffer and the selected object in a window. The difference between this service and the Obtain GR Reference service is that the Select Object service does not require the diagram to be saved on a file.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SESELECTOBJECT
bufId integerBuffer referencing the diagram in which an object should be shown.
objectid integer row integer column integer keepSelections boolService Reply
SESELECTOBJECTREPLYErrors
Invalid diagram buffer idInvalid object idSDLE is busy, syntax error in text (SDLE only)Show Object
Description
The Show Object service will make sure that the specified object is visible in a window. This means that it will display the buffer in a window and if necessary scroll into the position where the object is. Often used in combination with Select Object.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SESHOWOBJECT
bufId integerBuffer referencing the diagram in which an object should be shown.
objectId integerService Reply
SESHOWOBJECTREPLYErrors
Invalid diagram buffer idInvalid object idSDLE is busy, syntax error in text (SDLE only)Insert SDL Object
Description
Adds an object to the SDL diagram.
Tools Supporting the Service
SET_SDLEService Request
SESDLEINSERTOBJECT
Service Reply
SESDLEINSERTOBJECTREPLYErrors
Invalid diagram buffer idInvalid object idA reference symbol containing text\cannot be inserted in diagram <diagram>Object type <objectType> is not allowed\in diagram <diagram>Unable to open pageThe page is too small to insert the objectSDLE is busy, syntax error in textInsert MSC Object
Description
The Insert Object service will create a new object in the diagram identified by the parameter and return an object identification (an integer) to the client. It will not display the new object.
For a full specification of how to specify the object to insert, the specification of Message Sequence Charts Z.120 should be consulted or the document "MSC Trace and Log Format 2.0 Specification" available from IBM Rational.
Tools Supporting the Service
SET_MSCEService Request
SEINSERTOBJECT
Service Reply
SEINSERTOBJECTREPLY
status integer objectId integerErrors
Invalid diagram buffer idErrors from parsing objectDescriptionRemove Object
Description
The Remove Object service will delete an object in a diagram.
Tools Supporting the Service
SET_MSCEService Request
SEREMOVEOBJECT
bufId integerBuffer referencing the diagram in which an object should be removed.
objectId integerService Reply
SEREMOVEOBJECTREPLYErrors
Invalid diagram buffer idInvalid object idObject can not be removed (MSCE only)Get Object Text
Description
The service will extract all texts for a given object.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEGETOBJECTTEXTService Reply
SEGETOBJECTTEXTREPLY
status integer objectType integerThe type of the object. Definitions of possible object types are found in sdtsym.h.
textnumber integer texts stringlistErrors
Invalid diagram buffer idNo page found with this object idNo object with this id foundEditor - Object Attribute Services
Introduction
It is possible to extend the data associated to an object managed by the SDL Suite with the user's own data. How this is done is described in Figure 161.
The object can have any number of attributes associated to it, not necessarily 2 as illustrated. The number of extended data attributes is arbitrary.
An object is potentially any item that is handled as a source component by the SDL Suite, or any of the sub-components of which it consists. Objects are thus:
- SDL diagram
- MSC diagram
- OM, SC, HMSC diagram
- SDL Page
- OM, SC, HMSC page
- SDL symbol
- MSC symbol
- OM, SC, HMSC symbol
The purpose of the extended data attribute is:
- To allow the user to add his own-defined data to diagrams managed by the SDL Suite.
- In addition, data extensions can by connected to operations to be performed on that data. Operations are performed through PostMaster messages or Operating System commands.
Extended Data Attribute
An extended data attribute defines a number of fields. Below is a few of them further elaborated.
- ProprietaryKey
- AttributeKey
- data_length
- data_interpretation and data
- In the SDL Suite, data is always interpreted as raw data. The SDL Suite have no knowledge about the format and meaning of the data. Raw data may consist of information produced by an external tool. Its format is not known by the SDL Suite. Thus, operation of any sort applied on that data, cannot be performed.
- comment_length
- comment
Display Key
Description
Request to display, i.e. select, all symbols referred by SDTRef, that have at least one associated attribute that matches the keys ProprietaryKey and AttributeKey.
SDTRef is typically a diagram, but could also be a page or a specific symbol. The symbols that match the criteria will be marked as selected in the drawing area. Other symbols will be de-selected.
- If SDTRef is empty, display all symbols is all diagrams that are read by the tool, and that match the keys
- If SDTRef denotes a diagram, display all symbols in the diagram that match the keys
- If SDTRef denotes a page, display all symbols in the page that match the keys
- If SDTRef denotes a symbol, display the symbol if it matches the keys.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEDISPLAYKEY
ProprietaryKey integer AttributeKey integer SDTRef stringService Reply
SEDISPLAYKEYREPLYErrors
SDT Reference ErrorsList Key
Description
Request to list all objects referred by SDTRef, that have at least one associated attribute that matches the keys ProprietaryKey and AttributeKey.
SDTRef is typically a diagram, but could also be a page or a specific symbol. The response is a count and a list of SDTRef to all objects that match the keys.
- If SDTRef is NULL, list all symbols is all diagrams that are read by the tool, and that match the keys.
- If SDTRef denotes a diagram, return SDTRef to all objects in the diagram that match the keys.
- If SDTRef denotes a page, return SDTRef to objects in the page that match the keys.
- If SDTRef denotes an object, return the SDTRef to the object if it matches the keys.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SELISTKEY
ProprietaryKey integer AttributeKey integer SDTRef stringService Reply
SELISTKEYREPLY
status integer NoOfKeys integer SDTRef* stringErrors
SDT Reference ErrorsCreate Attribute
Description
Request add a new attribute to the symbol that matches the SDT reference SDTRef.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SECREATEATTRIBUTE
Service Reply
SECREATEATTRIBUTEREPLYErrors
SDT Reference ErrorsError in matchUpdate Attribute
Description
Request to update the attribute that matches the search criteria (SDTRef, ProprietaryKey, AttributeKey). If an attribute matches the search keys, then the entire attribute's contents will be updated (replaced) with new contents.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEUPDATEATTRIBUTE
Service Reply
SEUPDATEATTRIBUTEREPLYErrors
SDT Reference ErrorsError in matchRead Attribute
Description
Request to read the attribute(s) that match(es) the keys and the diagram identified by SDTRef. The SDTRef reference should contain a page attribute.
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEREADATTRIBUTE
ProprietaryKey integer AttributeKey integer SDTRef stringService Reply
SEREADATTRIBUTEREPLY
status integer DataInterpret integer comment string MenuChoice string dataLen integer data ByteStringErrors
SDT Reference ErrorsError in matchDelete Attribute
Description
Request to delete the attribute that matches the search criteria (SDTRef, ProprietaryKey, AttributeKey).
Tools Supporting the Service
SET_SDLESET_MSCESET_OMEService Request
SEDELETEATTRIBUTE
ProprietaryKey integer AttributeKey integer SDTRef stringService Reply
SEDELETEATTRIBUTEREPLYErrors
SDT Reference ErrorsMore than one object match the searchNo object match the searchInformation Server Services
Load Definition File
Description
Loads a file containing external signal definitions into the Information Server. The contents of such a file are then made available via the Signal Dictionary functionality found in the SDL Editor.
The Information Server could read any ASCII file, but for efficient usage, the format of the files should contain one signal definition per line.
Tools Supporting the Service
SET_INFOSERVERService Request
SELOADDEFINITIONMAP
fileName string tag integerService Reply
SELOADDEFINITIONMAPREPLYErrors
File already addedFile was not added beforeSDL Editor Services
GRPR
Description
Generate PR for a given binary file. Optionally, GR references and CIF comments could be generated.
If the file is already being edited the PR generated will be from the internal version in the SDL Editor and not from the data in the file.
If the diagram is not being edited it will be unloaded after the PR generation.
Tools Supporting the Service
SET_SDLEService Request
SEGRPRP
fileName string fileName string append bool generateGRRef boolIf true, the generated PR will also contain graphical references, that are used in the Analyzer to backtrace errors.
generateCIF boolService Reply
SEGRPRREPLYErrors
Invalid file nameSDLE is busy, syntax error in text (SDLE only)Tidy Up
Description
The Tidy Up service will perform a tidy up on a specified diagram. The functionality is identical to the Tidy Up command available in the SDL Editor.
Tools Supporting the Service
SET_SDLEService Request
SETIDYUPService Reply
SETIDYUPREPLYErrors
Invalid diagram buffer idSC Editor Services
Get Diagram Info
Description
Get information about the symbols and lines of a SC diagram. The format of the returned infoList is:
Symbols: <noOfSymbols>
<type> <id> <superstateId> <noOfTexts> <text1> ...
...Lines: <noOfLines>
<type> <fromSymbolId> <toSymbolId> <noOfTexts> <text1> ...
...Where:<type> ::= An integer denoting the type of symbol or lineTypes can be found in sdtsym.h<id> ::= An integer identifying a symbolTools Supporting the Service
SET_OMEService Request
SEGETDIAGRAMINFOService Reply
SEGETDIAGRAMINFOREPLY
status integer infoList stringListErrors
Invalid diagram buffer idInvalid diagram typeMSC Editor Services
MSC GRPR
Description
Generate PR for a given MSC binary file. Optionally, GR references can be generated.
If the file is already being edited, the generated PR will be from the internal version in the MSC Editor and not from the data in the file.
If the diagram is not being edited it will be unloaded after the PR generation.
Tools Supporting the Service
SET_MSCEService Request
SEMSCGRPR
Service Reply
SEMSCGRPRREPLY
errors integer warnings integer errorLog stringMSC Generate cui script
Description
Generate cui script for a given MSC diagram.
If the file is already being edited, the generated script will be from the internal version in the MSC Editor and not from the data in the file.
If the diagram is not being edited it will be unloaded after the script generation.
The input script will be generated as a .cui file with the same name as the input MSC diagram. The .cui file will be located in the same directory as your input MSC.
Tools Supporting the Service
SET_MSCEService Request
SEGENERATEINPUTSCRIPTService Reply
SEGENERATEINPUTSCRIPTREPLYHMSC Editor Services
HMSC GRPR
Description
Generate PR for a given HMSC binary file. Optionally, GR references can be generated.
If the file is already being edited, the generated PR will be from the internal version in the HMSC Editor and not from the data in the file.
If the diagram is not being edited it will be unloaded after the PR generation.
Tools Supporting the Service
SET_OMEService Request
SEHMSCGRPR
Service Reply
SEHMSCGRPRREPLY
errors integer warnings integer errorLog stringCIF Services
The CIF services enables the user to create diagrams where the graphical objects and texts could be positioned in a controlled manner.
These services enables the user to build converters to SDL Suite diagram formats.
The diagram types which are supported are:
where the services are supported by the SDL Editor, and
where the services are supported by the OM Editor.
Create SDL Diagram
Description
Creates an empty SDL diagram in a new buffer. Corresponds to the SDL Editor command New. The defaults applied to the created page are defined for the Create SDL Page service.
The texts for the package reference and the headings will be shown on every page in the diagram. The package reference symbol and the heading symbols will be automatically created, but their size can be changed by using the Insert SDL Object service for these symbols, (see Object Specific Parameters).
The kernel heading will be parsed to extract the necessary attributes like the virtuality, diagram type and diagram name. If this parsing fails the service will return an error.
The splitting of the SDL heading into a kernel heading and an additional heading is done according to the rules in section 2.2.5 `Partitioning of diagrams' in Z.100 with some necessary exceptions. Normally the kernel heading contains the heading up to, and including the diagram name,
<kernel heading> ::= [<virtuality>] <diagram kind> {<diagram name> | <diagram identifier>}The following exceptions to this rule apply:
For a type based system diagram the kernel heading contains the complete definition except for the ending <end> clause.
<kernel heading> ::= <typebased system heading>For a process diagram the <number of process instance> might be included in the kernel heading.
For a procedure diagram the kernel heading is
<kernel heading> ::= <procedure preamble> procedure {<procedure name> | <procedure identifier>}Tools Supporting the Service
SET_SDLEService Request
SESDLECIFCREATEDIAGRAM
Service Reply
SESDLECIFCREATEDIAGRAMREPLYErrors
The pagename is emptyIllegal diagram kernel headingEmitted Notifications
Create SDL Page
Description
The Create Page service will create a new page in an existing diagram. The new page will be inserted as the last page in the diagram. The created page will have a frame symbol with margins to the page border as defined by the actual preference file. The kernel heading, additional heading and page number symbols exists and are placed automatically relative to the frame symbol. The package reference symbol exists, automatically placed, if the page type is a system page or a package page. The frame symbol can be changed to another position by using the Insert SDL Object service.
If a page already exists with the given page name, the service will be ignored and the return status is OK. This can be used for convenience to always send Create Page for all pages including the one already sent in the Create SDL Diagram.
The grid values should be multiples of 5 mm. If the values are zero or less than zero this means that the preferences values are used for the grid values.
A page can be set to be autonumbered. When this is used a page name must be given as well. For consecutive autonumbered pages these names must be "1", "2", "3" and so on. It will be checked that the given page name is the same as the generated page name. If not an error will be returned.
If the ShowMeFirst attribute is set for a new page it will override an already existing ShowMeFirst page.
Tools Supporting the Service
SET_SDLEService Request
SESDLECIFCREATEPAGE
Service Reply
SESDLECIFCREATEPAGEREPLYErrors
Invalid diagram buffer idThe pagename is emptyCommand canceled in add pageFor autonumbered pages, the given pagename "2" must be the same as the generated page name "1"Emitted Notifications
Insert SDL Object
Description
The Insert Object service will insert an object in a specified position at a specific page. The return value is the object id for the inserted object. Lines connected to the inserted symbol should refer to the objectId returned by this service.
The following checks are applied on parameters:
- If a line is inserted the symbols connecting the line must already have been inserted.
- For lines it is an error if there are less than two breakpoints.
- The object type must be a known symbol or line.
The following is a non-exhaustive list of restrictions, applied inside SDLE when manipulating with symbols, that are not checked by this service:
- Ratio for process symbols, should be 1:2 (height vs. width).
- Positions outside the page area.
- Text syntax for reference symbols.
- Illegal texts on flowlines.
- Sizes less than minimum allowed.
- That lines are connected to symbols with the correct syntax.
- That line endpoints fall on enclosing rectangle of the symbol it is connected to.
- Symbols placed on pages where they should not appear, e.g. a task on a system page.
- Overlapping symbols
Tools Supporting the Service
SET_SDLEService Request
SESDLECIFINSERTOBJECT
Service Reply
SESDLECIFINSERTOBJECTREPLY
status integer objectId integerErrors
Invalid diagram buffer idInvalid pagenameInvalid fromSymbol id for a line:Invalid toSymbol id for a line:Invalid fromSymbol. The fromSymbol is a line:Invalid toSymbol. The toSymbol is a line:Number of points in line < 2 :Invalid objectId for ConnectionPoint line:Invalid object type:Object Specific Parameters
For each object type the needed parameters are listed. All coordinates are given in 1/10 mm units in the coordinate system with the upper left corner of the page as origo and the y-coordinate having the positive direction going downwards.
A given coordinate will be adjusted to fall on a grid. For symbols this grid is given by a grid net of 5 x 5 mm. For line breakpoints and text positions the grid net is 2.5 x 2.5 mm.
The Pagenumber symbol (objectType number 53) has no extra specific parameters. When inserted there will not be a new symbol created as the pagenumber symbol is always created when the page is created. The text for the pagenumber symbol is generated automatically. The only use of inserting this symbol is to force an update of the page by having the updateFlag set to true.
- Process Interaction diagram symbols
Start(1), ProcedureStart(2), MacroInlet(3), Stop(4), ProcedureReturn(5), MacroOutlet(6), State(7), InputRight(8), InputLeft(9), PriorityInputRight(10), PriorityInputLeft(11), ContinuousSignal(12), EnablingCondition(13), Task(14), OutputRight(15), OutputLeft(16), PriorityOutputRight(17), PriorityOutputLeft(18), ProcedureCall(19), InConnector(20), CreateRequest(21), Decision(22), TransitionOption(23), MacroCall(24), OutConnector(25), Save(26)
left integer top integer width integer height integer text stringThe text in the symbol. The text is automatically aligned according to the built-in routines in SDLE
- Block Interaction diagram symbols
Procedure(27), Service(41), Process(42), Block(43), BlockSubstructure(45), ChannelSubstructure(46), SystemType(47), BlockType(48), ServiceType(49), ProcessType(50), Operator(56).
- There is no check that the text will fall inside the symbol boundary.
left integer top integer width integer height integer text sString
- An automatically sized TextSymbol shall have the width and height set to zero. If values are given this means that the symbol will be clipped using the given sizing values.
left integerThe x coordinate for the left side (Comment, TextExtension) or the right side (CommentLeft, TextExtensionLeft)
top integer text string
- For a CommentLeft or TextExtensionLeft the position gives the right top corner of the symbol. The size is automatically adjusted.
left integer top integer width integer height integer
- A default FrameSymbol will always exist on a created page. This service will replace the existing Frame with a new frame symbol at the given position with the new size. The existing heading symbols, package reference symbol and the pagenumber symbol will be automatically adjusted.
- For automatically sized symbols the values for the width and the height should be zero. If values different from zero are given this means that the symbol will be clipped.
- Note that it might be necessary to insert this symbol for every page. This is so because these symbols might have a unique size for every page. If the symbols are not clipped there is no need to insert the symbol as they will be automatically generated as an unclipped symbol.
- The size of the kernel heading cannot be changed.
- It is checked that symbols exist having the given fromID and toID. The text and text position shall only exist if the textExists flag is true. Flowlines after Decision, TransitionOption and MacroCall should always have text. There will be numPoints x and y-values at the end of the message. Line coordinates are adjusted to the nearest grid point but it will not be checked whether line endpoints are placed on the symbol boundaries, as they are expected to be.
- It is checked that symbols exists having the given fromID and toID. There will be numPoints x and y-values at the end of the message. Text position and line coordinates are adjusted to the nearest grid point but it will not be checked whether line endpoints are placed on the symbol boundary (the rectangle enclosing the symbol), as they are expected to be. Extra line segments needed for e.g. a signal route entering a service will be automatically generated.
- It is checked that symbols exists having the given fromID and toID. There will be numPoints x and y-values at the end of the message. Text position and line coordinates are adjusted to the nearest grid point but it will not be checked whether line endpoints are placed on the symbol boundary (the rectangle enclosing the symbol), as they are expected to be. The arrow position are automatically adjusted to be placed at the line as close as possible to the given arrow point. The angle of the arrow is automatically calculated. For a non delaying channel the arrow position is ignored and it will be automatically placed at the last breakpoint.
- It is checked that symbols exists having the given fromID and toID. There will be numPoints x and y-values at the end of the message. Line coordinates are adjusted to the nearest grid point but it will not be checked whether line endpoints are placed on the symbol boundary, as they are expected to be. For a ChannelSubstructureLine the starting is adjusted to be placed on the channel.
- The length of the gate is automatically calculated, so also the arrow position. The point will be adjusted such that it is guaranteed to stay on the Frame boundary. If the frame symbol is inserted after a gate, the gate might be positioned outside the frame. The correct positions will be fixed in the update that must be performed before saving the page.
objectID integerThe objectId for the symbol where the ConnectionPoint exists. Zero means ENV.
X integer Y integer name string XnamePosition integer YnamePosition integer
- A ConnectionPoint is used for gate names on the Frame symbol (ENV), channel names in block diagrams for graphical connect statements and for gate names inside block/process/service instances of block/process/service types. The objectID must be a valid symbol. The coordinate is adjusted such that the point will fall on the symbol boundary. If the frame symbol is inserted after a connection point residing on the frame, it might be positioned outside the frame. The correct positions will be fixed in the update that must be performed before saving the page.
Create OM Diagram
Description
Creates an empty OM diagram in a new buffer. Corresponds to the OM Editor command New. The defaults applied to the created page are defined for the Create OM Page service.
Tools Supporting the Service
SET_OMEService Request
SEOMECIFCREATEDIAGRAM
name string pageName string pageWidth integer pageHeight integer gridWidth integer gridHeight integer autonumbered bool showMeFirst bool scale integerService Reply
SEOMECIFCREATEDIAGRAMREPLYErrors
The pagename is emptyEmitted Notifications
Create OM Page
Description
The Create Page service will create a new page in an existing diagram. The new page will be inserted as the last page in the diagram. The heading and page number symbols exists and are placed automatically relative to the frame symbol. The frame symbol can not be changed to another position.
If a page already exists with the given page name, the service will be ignored and the return status is OK. This can be used for convenience to always send Create Page for all pages including the one already sent in the Create OM Diagram service.
The grid values should be multiples of 5 mm. If the values are zero or less than zero this means that the preferences values are used for the grid values.
A page can be set to be autonumbered. When this is used a page name must be given as well. For consecutive autonumbered pages these names must be "1", "2", "3" and so on. It is considered an error if the given page name not is the same as the generated page name when this flag is set.
If the ShowMeFirst attribute is set for a new page it will override an already existing ShowMeFirst page.
Tools Supporting the Service
SET_OMEService Request
SEOMECIFCREATEPAGE
Service Reply
SEOMECIFCREATEPAGEREPLYErrors
Invalid diagram buffer idThe pagename is emptyFor an autonumbered page the given name must be the same as the generated pagename: "<gen.pagename>"Emitted Notifications
Insert OM Object
Description
The Insert Object service will insert an object in a specified position at a specific page. The return value is the object id for the inserted object. Lines connected to the inserted symbol should refer to the objectId returned by this service.
The following parameter checks are performed:
- If a line is inserted the symbols connecting the line must already have been inserted.
- For lines it is an error if there are less than two breakpoints.
- The object type must be a known symbol or line.
The following is a non-exhaustive list of restrictions, applied inside OME when manipulating with symbols, that are not checked by this service:
- Positions outside the page area.
- Text syntax for class and instance symbols. However, when an object is inserted with the updateFlag set there will be a syntactic check and all eventual syntax errors will be marked in the normal way.
- That lines are connected to symbols with the correct syntax.
- That line endpoints fall on or inside the enclosing rectangle of the symbol it is connected to.
- Overlapping symbols
Tools Supporting the Service
SET_OMEService Request
SEOMECIFINSERTOBJECT
Service Reply
SEOMECIFINSERTOBJECTREPLY
status integer objectId integerErrors
Invalid diagram buffer idInvalid pagenameInvalid fromSymbol id for a line:Invalid toSymbol id for a line:Invalid fromSymbol. The fromSymbol is a line:Invalid toSymbol. The toSymbol is a line:Number of points in line < 2 :Invalid objectId for ConnectionPoint line:Invalid object type:Object Specific Parameters
For each object type the needed parameters are listed below. All coordinates are given in 1/10 mm units in the coordinate system with the upper left corner of the page as origo and the y-coordinate having the positive direction going downwards.
A given coordinate will be adjusted to fall on a grid. For symbols this grid is given by a grid net of 5 x 5 mm. For line breakpoints and text positions the grid net is 2.5 x 2.5 mm.
The Pagenumber symbol (objectType number 53) have no extra specific parameters. When inserted there will not be a new symbol created as the pagenumber symbol is always created when the page is created. The text for the pagenumber symbol is generated automatically. The only use of inserting this symbol is to force an update of the page by having the updateFlag set to true
left integer top integer nameText string attributeText string operationText string stereotypeText string propertiesText string collapsed bool
left integer top integer nameText string attributeText string stereotypeText string propertiesText string collapsed bool
left integer top integer text string collapsed bool
- It is checked that symbols exists having the given fromID and toID. There will be numPoints x and y-values at the end of the message. Text position and line coordinates are adjusted to the nearest grid point but it will not be checked whether line endpoints are placed on the symbol boundary (the rectangle enclosing the symbol), as they are expected to be. Extra line segments needed for e.g. a signal route entering a service will be automatically generated.
- It is checked that symbols exists having the given fromID and toID. There will be numPoints x and y-values at the end of the message. Text position and line coordinates are adjusted to the nearest grid point.
fromID integer toID integer numPoints integerThe number of breakpoints for the line. Always 2 since no breakpoints are allowed on this line.
x integer y integerIt is checked that symbols exists having the given fromID and toID. Observe that the fromID must denote an association or aggregation line. Note that numPoints always must be 2, and consequently there will be two x and y coordinates.
Text Editor Services
Show Position
Description
The Show Position service makes sure that a certain character specified by line and column is visible in a text editor window:
- If no window is displaying the document identified by bufferId, the buffer is displayed in a window according to the user's window reuse policy.
- A window is brought to the front.
- The text in the window is re-centered so that the indicated character is displayed.
Note that the actual display position after re-centering is undefined if the line and/or column values do not make sense.
Tools Supporting the Service
SET_TEService Request
SETESHOWPOSITION
bufid integer line integer column integerService Reply
SETESHOWPOSITIONREPLYErrors
Buffer id does not existSelect Text
Description
The Select Text service selects a range of text in a window displaying a given text buffer.
- If no window is displaying the document identified by bufferId, the buffer is displayed in a window according to the user's window reuse policy.
- A window is brought to the front.
- The text in the window is re-centered so that the indicated character is displayed.
Note that the actual selection is undefined if one or more of the line and/or column values do not make sense.
Tools Supporting the Service
SET_TEService Request
SETESELECTTEXT
bufid integer line1 integer column1 integer line2 integer column2 integerService Reply
SETESELECTTEXTREPLYErrors
Buffer id does not exist1In Windows, the SDL Simulator/Explorer UI's can not read menu-definition files.
2In Windows, the SDL Simulator/Explorer UI's can not read menu-definition files.
3In Windows, the SDL Simulator/Explorer UI's can not read menu-definition files.
4In Windows, the SDL Simulator/Explorer UI's can not read menu-definition files.
http://www.ibm.com/rational |
![]() |
![]() |
![]() |
![]() |