LibreOffice: com/sun/star/sheet/XSolver.idl Source File

LibreOffice LibreOffice 7.3 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#ifndef __com_sun_star_sheet_XSolver_idl__
21#define __com_sun_star_sheet_XSolver_idl__
22
23#include <com/sun/star/sheet/XSpreadsheetDocument.idl>
24#include <com/sun/star/sheet/SolverConstraint.idl>
25
26
27module com { module sun { module star { module sheet {
28
29
32 interface XSolver: com::sun::star::uno::XInterface
33{
35 [attribute] XSpreadsheetDocument Document;
36
38 [attribute] com::sun::star::table::CellAddress Objective;
39
41 [attribute] sequence< com::sun::star::table::CellAddress > Variables;
42
44 [attribute] sequence< SolverConstraint > Constraints;
45
47 [attribute] boolean Maximize;
48
50 void solve();
51
53 [attribute, readonly] boolean Success;
54
56 [attribute, readonly] double ResultValue;
57
61 [attribute, readonly] sequence< double > Solution;
62};
63
64
65}; }; }; };
66
67#endif
68
69/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SolverConstraint.idl
XSpreadsheetDocument.idl
com::sun::star::sheet::XSolver
allows to call a solver for a model that is defined by spreadsheet cells.
Definition: XSolver.idl:33
com::sun::star::sheet::XSolver::Document
XSpreadsheetDocument Document
The spreadsheet document that contains the cells.
Definition: XSolver.idl:35
com::sun::star::sheet::XSolver::ResultValue
double ResultValue
contains the objective value for the solution, if a solution was found.
Definition: XSolver.idl:56
com::sun::star::sheet::XSolver::Constraints
sequence< SolverConstraint > Constraints
The constraints of the model.
Definition: XSolver.idl:44
com::sun::star::sheet::XSolver::Solution
sequence< double > Solution
contains the solution's value for each of the variables, if a solution was found.
Definition: XSolver.idl:61
com::sun::star::sheet::XSolver::Success
boolean Success
contains TRUE if a solution was found.
Definition: XSolver.idl:53
com::sun::star::sheet::XSolver::Objective
com::sun::star::table::CellAddress Objective
The address of the cell that contains the objective value.
Definition: XSolver.idl:38
com::sun::star::sheet::XSolver::Variables
sequence< com::sun::star::table::CellAddress > Variables
The addresses of the cells that contain the variables.
Definition: XSolver.idl:41
com::sun::star::sheet::XSolver::Maximize
boolean Maximize
selects if the objective value is maximized or minimized.
Definition: XSolver.idl:47
com::sun::star::sheet::XSolver::solve
void solve()
executes the calculation and tries to find a solution.
com::sun::star::sheet::XSpreadsheetDocument
provides access to a collection of spreadsheets.
Definition: XSpreadsheetDocument.idl:35
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Ambiguous.idl:22
com::sun::star::table::CellAddress
contains a cell address within a spreadsheet document.
Definition: CellAddress.idl:30