LibreOffice
LibreOffice 24.2 SDK API Reference
XSolver.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 
21 module com { module sun { module star { module sheet {
22 
23 
27 {
30 
33 
35  [attribute] sequence< com::sun::star::table::CellAddress > Variables;
36 
38  [attribute] sequence< SolverConstraint > Constraints;
39 
41  [attribute] boolean Maximize;
42 
44  void solve();
45 
47  [attribute, readonly] boolean Success;
48 
50  [attribute, readonly] double ResultValue;
51 
55  [attribute, readonly] sequence< double > Solution;
56 };
57 
58 
59 }; }; }; };
60 
61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean Success
contains TRUE if a solution was found.
Definition: XSolver.idl:47
Definition: Ambiguous.idl:20
sequence< SolverConstraint > Constraints
The constraints of the model.
Definition: XSolver.idl:38
allows to call a solver for a model that is defined by spreadsheet cells.
Definition: XSolver.idl:26
XSpreadsheetDocument Document
The spreadsheet document that contains the cells.
Definition: XSolver.idl:29
boolean Maximize
selects if the objective value is maximized or minimized.
Definition: XSolver.idl:41
contains a cell address within a spreadsheet document.
Definition: CellAddress.idl:26
provides access to a collection of spreadsheets.
Definition: XSpreadsheetDocument.idl:28
sequence< com::sun::star::table::CellAddress > Variables
The addresses of the cells that contain the variables.
Definition: XSolver.idl:35
base interface of all UNO interfaces
Definition: XInterface.idl:45
double ResultValue
contains the objective value for the solution, if a solution was found.
Definition: XSolver.idl:50
com::sun::star::table::CellAddress Objective
The address of the cell that contains the objective value.
Definition: XSolver.idl:32
sequence< double > Solution
contains the solution&#39;s value for each of the variables, if a solution was found. ...
Definition: XSolver.idl:55