diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XSolver.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XSolver.idl | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XSolver.idl b/offapi/com/sun/star/sheet/XSolver.idl new file mode 100644 index 000000000..29b9ba011 --- /dev/null +++ b/offapi/com/sun/star/sheet/XSolver.idl @@ -0,0 +1,69 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_sheet_XSolver_idl__ +#define __com_sun_star_sheet_XSolver_idl__ + +#include <com/sun/star/sheet/XSpreadsheetDocument.idl> +#include <com/sun/star/sheet/SolverConstraint.idl> + + +module com { module sun { module star { module sheet { + + +/** allows to call a solver for a model that is defined by spreadsheet cells. + */ +interface XSolver: com::sun::star::uno::XInterface +{ + /// The spreadsheet document that contains the cells. + [attribute] XSpreadsheetDocument Document; + + /// The address of the cell that contains the objective value. + [attribute] com::sun::star::table::CellAddress Objective; + + /// The addresses of the cells that contain the variables. + [attribute] sequence< com::sun::star::table::CellAddress > Variables; + + /// The constraints of the model. + [attribute] sequence< SolverConstraint > Constraints; + + /// selects if the objective value is maximized or minimized. + [attribute] boolean Maximize; + + /// executes the calculation and tries to find a solution. + void solve(); + + /// contains `TRUE` if a solution was found. + [attribute, readonly] boolean Success; + + /// contains the objective value for the solution, if a solution was found. + [attribute, readonly] double ResultValue; + + /** contains the solution's value for each of the variables, + if a solution was found. + */ + [attribute, readonly] sequence< double > Solution; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |