offapi/com/sun/star/sheet/XSolver.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSolver.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XSolver_idl__
  32 #define __com_sun_star_sheet_XSolver_idl__
  33
  34 #ifndef __com_sun_star_sheet_XSpreadsheetDocument_idl__
  35 #include <com/sun/star/sheet/XSpreadsheetDocument.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_SolverConstraint_idl__
  39 #include <com/sun/star/sheet/SolverConstraint.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** allows to call a solver for a model that is defined by spreadsheet cells.
  49  */
  50 interface XSolver: com::sun::star::uno::XInterface
  51 {
  52     /// The spreadsheet document that contains the cells.
  53     [attribute] XSpreadsheetDocument Document;
  54
  55     /// The address of the cell that contains the objective value.
  56     [attribute] com::sun::star::table::CellAddress Objective;
  57
  58     /// The addresses of the cells that contain the variables.
  59     [attribute] sequence< com::sun::star::table::CellAddress > Variables;
  60
  61     /// The constraints of the model.
  62     [attribute] sequence< SolverConstraint > Constraints;
  63
  64     /// selects if the objective value is maximized or minimized.
  65     [attribute] boolean Maximize;
  66
  67     /// executes the calculation and tries to find a solution.
  68     void solve();
  69
  70     /// contains <TRUE/> if a solution was found.
  71     [attribute, readonly] boolean Success;
  72
  73     /// contains the objective value for the solution, if a solution was found.
  74     [attribute, readonly] double ResultValue;
  75
  76     /** contains the solution's value for each of the variables,
  77         if a solution was found.
  78      */
  79     [attribute, readonly] sequence< double > Solution;
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif
  87