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 21module com { module sun { module star { module sheet { 22 23 24/** allows to call a solver for a model that is defined by spreadsheet cells. 25 */ 26interface XSolver: com::sun::star::uno::XInterface 27{ 28 /// The spreadsheet document that contains the cells. 29 [attribute] XSpreadsheetDocument Document; 30 31 /// The address of the cell that contains the objective value. 32 [attribute] com::sun::star::table::CellAddress Objective; 33 34 /// The addresses of the cells that contain the variables. 35 [attribute] sequence< com::sun::star::table::CellAddress > Variables; 36 37 /// The constraints of the model. 38 [attribute] sequence< SolverConstraint > Constraints; 39 40 /// selects if the objective value is maximized or minimized. 41 [attribute] boolean Maximize; 42 43 /// executes the calculation and tries to find a solution. 44 void solve(); 45 46 /// contains `TRUE` if a solution was found. 47 [attribute, readonly] boolean Success; 48 49 /// contains the objective value for the solution, if a solution was found. 50 [attribute, readonly] double ResultValue; 51 52 /** contains the solution's value for each of the variables, 53 if a solution was found. 54 */ 55 [attribute, readonly] sequence< double > Solution; 56}; 57 58 59}; }; }; }; 60 61/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ 62