LibreOffice: com/sun/star/sheet/XSolverSettings.idl Source File

LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
19 interface XSolverSettings: com::sun::star::uno::XInterface
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: */
com::sun::star::sheet::XSolverSettings
Provides access to the solver settings stored in a specific Calc sheet.
Definition XSolverSettings.idl:20
com::sun::star::sheet::XSolverSettings::ObjectiveType
byte ObjectiveType
Determines the model objective function type Possible values defined in css::sheet::SolverObjectiveTy...
Definition XSolverSettings.idl:24
com::sun::star::sheet::XSolverSettings::Constraints
sequence< ModelConstraint > Constraints
Constraints of the solver model.
Definition XSolverSettings.idl:52
com::sun::star::sheet::XSolverSettings::ConstraintCount
long ConstraintCount
Returns the number of constraints in the solver model.
Definition XSolverSettings.idl:56
com::sun::star::sheet::XSolverSettings::GoalValue
any GoalValue
Value or cell address used in the "Value of" field.
Definition XSolverSettings.idl:36
com::sun::star::sheet::XSolverSettings::SuppressDialog
boolean SuppressDialog
Set this attribute to True to suppress dialogs shown the method "solve()".
Definition XSolverSettings.idl:76
com::sun::star::sheet::XSolverSettings::Engine
string Engine
Set the solver engine using its implementation name.
Definition XSolverSettings.idl:40
com::sun::star::sheet::XSolverSettings::Status
byte Status
Last reported solver status.
Definition XSolverSettings.idl:68
com::sun::star::sheet::XSolverSettings::ErrorMessage
string ErrorMessage
Stores the last error message reported after calling the "solve()" method.
Definition XSolverSettings.idl:72
com::sun::star::sheet::XSolverSettings::VariableCells
sequence< any > VariableCells
Variable cells in the model, represented as a sequence of cell ranges.
Definition XSolverSettings.idl:48
com::sun::star::sheet::XSolverSettings::EngineOptions
sequence< com::sun::star::beans::PropertyValue > EngineOptions
Solver engine options expressed as a sequence of property values.
Definition XSolverSettings.idl:62
com::sun::star::sheet::XSolverSettings::ObjectiveCell
any ObjectiveCell
Cell pointing to the objective function of the model.
Definition XSolverSettings.idl:28
com::sun::star::sheet::XSolverSettings::AvailableEngines
sequence< string > AvailableEngines
Returns a sequence of strings containing all available solver implementation names.
Definition XSolverSettings.idl:44
com::sun::star::sheet::XSolverSettings::reset
void reset()
Resets the solver model to its defaults settings.
com::sun::star::sheet::XSolverSettings::saveToFile
void saveToFile()
Save the solver model to the file.
com::sun::star::sheet::XSolverSettings::solve
void solve()
Run the solver model Check the values of the Status and ErrorMessage attributes to know what happened...
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com
Definition Ambiguous.idl:20