diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XSolver.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XSolver.idl | 84 |
1 files changed, 84 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 000000000000..aaf54ddb7586 --- /dev/null +++ b/offapi/com/sun/star/sheet/XSolver.idl @@ -0,0 +1,84 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_XSolver_idl__ +#define __com_sun_star_sheet_XSolver_idl__ + +#ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__ +#include <com/sun/star/sheet/XSpreadsheetDocument.idl> +#endif + +#ifndef __com_sun_star_sheet_SolverConstraint_idl__ +#include <com/sun/star/sheet/SolverConstraint.idl> +#endif + +//============================================================================= + +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 + |