Utility Functions : List of Utility Functions : stm_plot_with_break

stm_plot_with_break
Function Type
int
Description
Breaks a sequence diagram across multiple pages.
Syntax
stm_plot_with_break (id, plot_file, width, height,
with_labels, with_names, with_notes,
with_hyperlink, plot_type, date_position,
title_position, title, do_rotate, with_file_header,
actual_height, with_breakpages, pages_in_x,
pages_in_y, page_index_in_x, page_index_in_y)
Arguments
Input/Output
The ID number of the Rational Statemate chart to be plotted.
The name of the file destination to which the plot is written. The operating system path name conventions are followed. You can specify a full path name to any directory for which you have write access.
If you specify a simple file name, the plot is written to your workarea. If you do not specify a value (‘’), the plot is included as part of the output segment file.
If you specify a plot size (width and height parameters) that is larger than the paper size defined for the specific printer, the plot simply uses the maximum allowable height and width defined for that printer.
Determines whether labels are plotted (TRUE) or not (FALSE).
Determines whether names are plotted (TRUE) or not (FALSE).
Specifies whether to generate hyperlinks for lifelines and referenced sequence diagrams (TRUE).
Specifies the plot type. This can be a supported formatting language if the plot is to be handled by a formatting processing system that has its own graphics language.
To configure a new plotter or printer, select Utilities > Output Devices from the main Rational Statemate window.
Plots created using Word format in the Output Device dialog box are HPGL files. To import these files into Word, rename them as .HGL or .PLT files.
This is an integer parameter of type stm_plt_position that indicates where to place the plot date. The possible values are as follows:
stm_plt_none - The date is not included.
stm_plt_top - The date is placed at the top of the plot.
stm_plt_bottom - The date is placed at the bottom of the plot.
This is an integer parameter of type stm_plt_position that indicates where to place the plot title. The possible values are as follows:
stm_plt_none - The title is not included.
stm_plt_top - The title is placed at the top of the plot.
stm_plt_bottom - The title is placed at the bottom of the plot.
Determines whether the orientation of the plot is landscape (TRUE) or portrait (FALSE).
Indicates whether a header is added to the file (TRUE). Use this option if you do not want the plot as part of the document (FALSE).
Specifies whether to break the SD across multiple pages (TRUE).
Specifies how many pages the tool attempted to break the SD into along the x-axis.
Note that if pages_in_x==0 and pages_in_y==0, the tool calculates a break pages scheme and assigns these variables so they can be read by the user after the call.
Specifies how many pages the tool attempted to break the SD into along the y-axis.
Plots the ith page in the x-axis.
Plots the ith page in the y-axis.

 

Status Codes
Notes
Function parameters are as follows:

boolean with_hyperlink (IN) /* generate hyperlinks */

boolean with_breakpages (IN) /* enable break pages */

integer pages_in_x (OUT) /* try to break to # of pages in x axis */

integer pages_in_y (OUT) /* try to break to # of pages in y axis */

Note:
If pages_in_x == 0 and pages_in_y==0, the tool calculates a break pages scheme and assigns these variables so they can be read by the user after the call.

integer page_index_in_x (IN) /*plot the ith page in x axis */

integer page_index_in_y (IN) /*plot the ith page in y axis */

Call the function STM_PLOT_SET_DATA() before plotting a sequence diagram using STM_PLOT_WITH_BREAK. Call the function STM_PLOT_RESET_DATA() after finishing the sequence diagram multiple pages plot.