xref: /trunk/main/offapi/com/sun/star/sheet/XSolver.idl (revision d1766043) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XSolver_idl__
25#define __com_sun_star_sheet_XSolver_idl__
26
27#ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__
28#include <com/sun/star/sheet/XSpreadsheetDocument.idl>
29#endif
30
31#ifndef __com_sun_star_sheet_SolverConstraint_idl__
32#include <com/sun/star/sheet/SolverConstraint.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** allows to call a solver for a model that is defined by spreadsheet cells.
42 */
43interface XSolver: com::sun::star::uno::XInterface
44{
45    /// The spreadsheet document that contains the cells.
46    [attribute] XSpreadsheetDocument Document;
47
48    /// The address of the cell that contains the objective value.
49    [attribute] com::sun::star::table::CellAddress Objective;
50
51    /// The addresses of the cells that contain the variables.
52    [attribute] sequence< com::sun::star::table::CellAddress > Variables;
53
54    /// The constraints of the model.
55    [attribute] sequence< SolverConstraint > Constraints;
56
57    /// selects if the objective value is maximized or minimized.
58    [attribute] boolean Maximize;
59
60    /// executes the calculation and tries to find a solution.
61    void solve();
62
63    /// contains <TRUE/> if a solution was found.
64    [attribute, readonly] boolean Success;
65
66    /// contains the objective value for the solution, if a solution was found.
67    [attribute, readonly] double ResultValue;
68
69    /** contains the solution's value for each of the variables,
70        if a solution was found.
71     */
72    [attribute, readonly] sequence< double > Solution;
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80
81