xref: /AOO41X/main/sccomp/source/solver/solver.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef SOLVER_HXX
29*cdf0e10cSrcweir #define SOLVER_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <com/sun/star/sheet/XSolver.hpp>
32*cdf0e10cSrcweir #include <com/sun/star/sheet/XSolverDescription.hpp>
33*cdf0e10cSrcweir #include <com/sun/star/lang/XServiceInfo.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
35*cdf0e10cSrcweir #include <cppuhelper/implbase3.hxx>
36*cdf0e10cSrcweir #include <comphelper/broadcasthelper.hxx>
37*cdf0e10cSrcweir #include <comphelper/propertycontainer.hxx>
38*cdf0e10cSrcweir #include <comphelper/proparrhlp.hxx>
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir typedef cppu::WeakImplHelper3<
41*cdf0e10cSrcweir                 com::sun::star::sheet::XSolver,
42*cdf0e10cSrcweir                 com::sun::star::sheet::XSolverDescription,
43*cdf0e10cSrcweir                 com::sun::star::lang::XServiceInfo >
44*cdf0e10cSrcweir         SolverComponent_Base;
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir class SolverComponent : public comphelper::OMutexAndBroadcastHelper,
47*cdf0e10cSrcweir                         public comphelper::OPropertyContainer,
48*cdf0e10cSrcweir                         public comphelper::OPropertyArrayUsageHelper< SolverComponent >,
49*cdf0e10cSrcweir                         public SolverComponent_Base
50*cdf0e10cSrcweir {
51*cdf0e10cSrcweir     // settings
52*cdf0e10cSrcweir     com::sun::star::uno::Reference< com::sun::star::sheet::XSpreadsheetDocument > mxDoc;
53*cdf0e10cSrcweir     com::sun::star::table::CellAddress                                            maObjective;
54*cdf0e10cSrcweir     com::sun::star::uno::Sequence< com::sun::star::table::CellAddress >           maVariables;
55*cdf0e10cSrcweir     com::sun::star::uno::Sequence< com::sun::star::sheet::SolverConstraint >      maConstraints;
56*cdf0e10cSrcweir     sal_Bool                                                                      mbMaximize;
57*cdf0e10cSrcweir     // set via XPropertySet
58*cdf0e10cSrcweir     sal_Bool                                                                      mbNonNegative;
59*cdf0e10cSrcweir     sal_Bool                                                                      mbInteger;
60*cdf0e10cSrcweir     sal_Int32                                                                     mnTimeout;
61*cdf0e10cSrcweir     sal_Int32                                                                     mnEpsilonLevel;
62*cdf0e10cSrcweir     sal_Bool                                                                      mbLimitBBDepth;
63*cdf0e10cSrcweir     // results
64*cdf0e10cSrcweir     sal_Bool                                                                      mbSuccess;
65*cdf0e10cSrcweir     double                                                                        mfResultValue;
66*cdf0e10cSrcweir     com::sun::star::uno::Sequence< double >                                       maSolution;
67*cdf0e10cSrcweir     rtl::OUString                                                                 maStatus;
68*cdf0e10cSrcweir 
69*cdf0e10cSrcweir public:
70*cdf0e10cSrcweir                             SolverComponent( const com::sun::star::uno::Reference<
71*cdf0e10cSrcweir                                     com::sun::star::uno::XComponentContext >& rxMSF );
72*cdf0e10cSrcweir     virtual                 ~SolverComponent();
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir     DECLARE_XINTERFACE()
75*cdf0e10cSrcweir     DECLARE_XTYPEPROVIDER()
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
78*cdf0e10cSrcweir                                 throw (::com::sun::star::uno::RuntimeException);
79*cdf0e10cSrcweir     virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();     // from OPropertySetHelper
80*cdf0e10cSrcweir     virtual ::cppu::IPropertyArrayHelper* createArrayHelper() const;    // from OPropertyArrayUsageHelper
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir                             // XSolver
83*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XSpreadsheetDocument > SAL_CALL getDocument()
84*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
85*cdf0e10cSrcweir     virtual void SAL_CALL   setDocument( const ::com::sun::star::uno::Reference<
86*cdf0e10cSrcweir                                     ::com::sun::star::sheet::XSpreadsheetDocument >& _document )
87*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
88*cdf0e10cSrcweir     virtual ::com::sun::star::table::CellAddress SAL_CALL getObjective() throw(::com::sun::star::uno::RuntimeException);
89*cdf0e10cSrcweir     virtual void SAL_CALL   setObjective( const ::com::sun::star::table::CellAddress& _objective )
90*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
91*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::table::CellAddress > SAL_CALL getVariables()
92*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
93*cdf0e10cSrcweir     virtual void SAL_CALL   setVariables( const ::com::sun::star::uno::Sequence<
94*cdf0e10cSrcweir                                     ::com::sun::star::table::CellAddress >& _variables )
95*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
96*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::sheet::SolverConstraint > SAL_CALL getConstraints()
97*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
98*cdf0e10cSrcweir     virtual void SAL_CALL   setConstraints( const ::com::sun::star::uno::Sequence<
99*cdf0e10cSrcweir                                     ::com::sun::star::sheet::SolverConstraint >& _constraints )
100*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
101*cdf0e10cSrcweir     virtual ::sal_Bool SAL_CALL getMaximize() throw(::com::sun::star::uno::RuntimeException);
102*cdf0e10cSrcweir     virtual void SAL_CALL   setMaximize( ::sal_Bool _maximize ) throw(::com::sun::star::uno::RuntimeException);
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir     virtual ::sal_Bool SAL_CALL getSuccess() throw(::com::sun::star::uno::RuntimeException);
105*cdf0e10cSrcweir     virtual double SAL_CALL getResultValue() throw(::com::sun::star::uno::RuntimeException);
106*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Sequence< double > SAL_CALL getSolution()
107*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
108*cdf0e10cSrcweir 
109*cdf0e10cSrcweir     virtual void SAL_CALL solve() throw(::com::sun::star::uno::RuntimeException);
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir                             // XSolverDescription
112*cdf0e10cSrcweir     virtual ::rtl::OUString SAL_CALL getComponentDescription() throw (::com::sun::star::uno::RuntimeException);
113*cdf0e10cSrcweir     virtual ::rtl::OUString SAL_CALL getStatusDescription() throw (::com::sun::star::uno::RuntimeException);
114*cdf0e10cSrcweir     virtual ::rtl::OUString SAL_CALL getPropertyDescription( const ::rtl::OUString& aPropertyName )
115*cdf0e10cSrcweir                                 throw (::com::sun::star::uno::RuntimeException);
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir                             // XServiceInfo
118*cdf0e10cSrcweir     virtual ::rtl::OUString SAL_CALL getImplementationName()
119*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
120*cdf0e10cSrcweir     virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
121*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
122*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames()
123*cdf0e10cSrcweir                                 throw(::com::sun::star::uno::RuntimeException);
124*cdf0e10cSrcweir };
125*cdf0e10cSrcweir 
126*cdf0e10cSrcweir #endif
127*cdf0e10cSrcweir 
128