LibreOffice
LibreOffice 25.2 SDK API Reference
XSolverSettings.idl
Go to the documentation of this file.
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 */
10
11
12module com { module sun { module star { module sheet {
13
14
20{
24 [attribute] byte ObjectiveType;
25
28 [attribute] any ObjectiveCell;
29
36 [attribute] any GoalValue;
37
40 [attribute] string Engine;
41
44 [attribute, readonly] sequence<string> AvailableEngines;
45
48 [attribute] sequence<any> VariableCells;
49
52 [attribute] sequence<ModelConstraint> Constraints;
53
56 [attribute, readonly] long ConstraintCount;
57
62 [attribute] sequence<com::sun::star::beans::PropertyValue> EngineOptions;
63
68 [attribute, readonly] byte Status;
69
72 [attribute, readonly] string ErrorMessage;
73
76 [attribute] boolean SuppressDialog;
77
80 void reset();
81
86 void solve();
87
91 void saveToFile();
92};
93
94
95}; }; }; };
96
97/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Provides access to the solver settings stored in a specific Calc sheet.
Definition: XSolverSettings.idl:20
byte ObjectiveType
Determines the model objective function type Possible values defined in css::sheet::SolverObjectiveTy...
Definition: XSolverSettings.idl:24
sequence< ModelConstraint > Constraints
Constraints of the solver model.
Definition: XSolverSettings.idl:52
long ConstraintCount
Returns the number of constraints in the solver model.
Definition: XSolverSettings.idl:56
any GoalValue
Value or cell address used in the "Value of" field.
Definition: XSolverSettings.idl:36
boolean SuppressDialog
Set this attribute to True to suppress dialogs shown the method "solve()".
Definition: XSolverSettings.idl:76
string Engine
Set the solver engine using its implementation name.
Definition: XSolverSettings.idl:40
byte Status
Last reported solver status.
Definition: XSolverSettings.idl:68
string ErrorMessage
Stores the last error message reported after calling the "solve()" method.
Definition: XSolverSettings.idl:72
sequence< any > VariableCells
Variable cells in the model, represented as a sequence of cell ranges.
Definition: XSolverSettings.idl:48
sequence< com::sun::star::beans::PropertyValue > EngineOptions
Solver engine options expressed as a sequence of property values.
Definition: XSolverSettings.idl:62
any ObjectiveCell
Cell pointing to the objective function of the model.
Definition: XSolverSettings.idl:28
sequence< string > AvailableEngines
Returns a sequence of strings containing all available solver implementation names.
Definition: XSolverSettings.idl:44
void reset()
Resets the solver model to its defaults settings.
void saveToFile()
Save the solver model to the file.
void solve()
Run the solver model Check the values of the Status and ErrorMessage attributes to know what happened...
base interface of all UNO interfaces
Definition: XInterface.idl:46
Definition: Ambiguous.idl:20