LibreOffice
LibreOffice 6.4 SDK API Reference
Public Types | Public Member Functions | Public Attributes | List of all members
XSolver Interface Reference

allows to call a solver for a model that is defined by spreadsheet cells. More...

import"XSolver.idl";

Inheritance diagram for XSolver:
XInterface Solver

Public Types

typedef sequence< com::sun::star::table::CellAddressVariables
 The addresses of the cells that contain the variables. More...
 
typedef sequence< SolverConstraintConstraints
 The constraints of the model. More...
 
typedef sequence< double > Solution
 contains the solution's value for each of the variables, if a solution was found. More...
 

Public Member Functions

void solve ()
 executes the calculation and tries to find a solution. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Public Attributes

XSpreadsheetDocument Document
 The spreadsheet document that contains the cells. More...
 
com::sun::star::table::CellAddress Objective
 The address of the cell that contains the objective value. More...
 
boolean Maximize
 selects if the objective value is maximized or minimized. More...
 
boolean Success
 contains TRUE if a solution was found. More...
 
double ResultValue
 contains the objective value for the solution, if a solution was found. More...
 

Detailed Description

allows to call a solver for a model that is defined by spreadsheet cells.

Member Typedef Documentation

◆ Constraints

sequence< SolverConstraint > Constraints
attribute

The constraints of the model.

◆ Solution

sequence< double > Solution
attributereadonly

contains the solution's value for each of the variables, if a solution was found.

◆ Variables

The addresses of the cells that contain the variables.

Member Function Documentation

◆ solve()

void solve ( )

executes the calculation and tries to find a solution.

Member Data Documentation

◆ Document

XSpreadsheetDocument Document
attribute

The spreadsheet document that contains the cells.

◆ Maximize

boolean Maximize
attribute

selects if the objective value is maximized or minimized.

◆ Objective

The address of the cell that contains the objective value.

◆ ResultValue

double ResultValue
attributereadonly

contains the objective value for the solution, if a solution was found.

◆ Success

boolean Success
attributereadonly

contains TRUE if a solution was found.


The documentation for this interface was generated from the following file: