Procedure GMP::ProgressWindow::DisplayLine(lineNo, title, value, Category)

GMP::ProgressWindow::DisplayLine

The procedure GMP::ProgressWindow::DisplayLine writes one line with progress information in the Progress Window. The lineNo argument gives the number of the line in which the information has to be shown. The title contains a string that will be displayed on the left side of the line; the value will be displayed on the right side.

GMP::ProgressWindow::DisplayLine(
     lineNo,           ! (input) a line number
     title,            ! (input) a title
     value,            ! (input) a value
     [Category]        ! (optional) a progress category
     )

Arguments

lineNo

The number of the line in which the information has to be shown. Its value should be a number between 1 and the maximum number of lines available in the Progress Window (currently 6).

title

The string that will be displayed on the left side of the line.

value

The value that will be displayed on the right side of the line.

Category

An element in the set AllProgressCategories.

Return Value

The procedure returns 1 on success, or 0 otherwise.

Note

• If the Category argument is used then the element should be created with the function GMP::SolverSession::CreateProgressCategory.

• To freeze (lock) a line the procedure GMP::ProgressWindow::FreezeLine should be called. To unfreeze it thereafter the procedure GMP::ProgressWindow::UnfreezeLine should be called.

See also

The routines GMP::ProgressWindow::DisplaySolverStatus, GMP::ProgressWindow::DisplayProgramStatus, GMP::ProgressWindow::DisplaySolver, GMP::ProgressWindow::FreezeLine, GMP::ProgressWindow::UnfreezeLine and GMP::SolverSession::CreateProgressCategory.