office-gobmx/chart2/source/inc/RegressionCurveHelper.hxx
Vladimir Glazounov c4c5beeca2 INTEGRATION: CWS chart2mst3 (1.5.4); FILE MERGED
2006/06/07 14:52:05 bm 1.5.4.9: #124497# +getMeanValueLine
2006/03/29 22:24:44 iha 1.5.4.8: restructure legend entry creation + legend entries in data labels
2006/02/28 12:36:17 bm 1.5.4.7: +isMeanValueLine
2005/10/07 11:45:20 bm 1.5.4.6: RESYNC: (1.5-1.6); FILE MERGED
2005/05/09 09:51:05 bm 1.5.4.5: moved parts of API to data namespace
2005/04/11 10:08:37 iha 1.5.4.4: add methods addRegressionCurve() removeAllExceptMeanValueLine() and getFirstCurveNotMeanValueLine()
2004/04/28 11:51:26 bm 1.5.4.3: superfluous class name in method declaration
2004/04/14 09:40:01 iha 1.5.4.2: domain-x -> values-x
2004/02/13 16:51:24 bm 1.5.4.1: join from changes on branch bm_post_chart01
2007-05-22 17:21:33 +00:00

212 lines
8.3 KiB
C++

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: RegressionCurveHelper.hxx,v $
*
* $Revision: 1.8 $
*
* last change: $Author: vg $ $Date: 2007-05-22 18:21:33 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef CHART2_REGRESSIONCURVEHELPER_HXX
#define CHART2_REGRESSIONCURVEHELPER_HXX
#ifndef _COM_SUN_STAR_CHART2_XREGRESSIONCURVE_HPP_
#include <com/sun/star/chart2/XRegressionCurve.hpp>
#endif
#ifndef _COM_SUN_STAR_CHART2_XREGRESSIONCURVECALCULATOR_HPP_
#include <com/sun/star/chart2/XRegressionCurveCalculator.hpp>
#endif
#ifndef _COM_SUN_STAR_CHART2_XREGRESSIONCURVECONTAINER_HPP_
#include <com/sun/star/chart2/XRegressionCurveContainer.hpp>
#endif
#ifndef _COM_SUN_STAR_CHART2_DATA_XDATASOURCE_HPP_
#include <com/sun/star/chart2/data/XDataSource.hpp>
#endif
#ifndef _COM_SUN_STAR_CHART2_XDATASERIES_HPP_
#include <com/sun/star/chart2/XDataSeries.hpp>
#endif
#ifndef _COM_SUN_STAR_UNO_XCOMPONENTCONTEXT_HPP_
#include <com/sun/star/uno/XComponentContext.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XMODEL_HPP_
#include <com/sun/star/frame/XModel.hpp>
#endif
namespace chart
{
class RegressionCurveHelper
{
public:
/// returns a model mean-value line
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurve >
createMeanValueLine(
const ::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > & xContext );
/// returns a model regression curve
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurve >
createRegressionCurveByServiceName(
const ::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > & xContext,
::rtl::OUString aServiceName );
// ------------------------------------------------------------
static bool hasMeanValueLine(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt );
static bool isMeanValueLine(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurve > & xRegCurve );
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurve >
getMeanValueLine(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt );
/** creates a mean-value line and adds it to the container.
@param xSeriesProp
If set, this property-set will be used to apply a line color
*/
static void addMeanValueLine(
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt,
const ::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > & xContext,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet > & xSeriesProp );
static void removeMeanValueLine(
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt );
enum tRegressionType
{
REGRESSION_TYPE_NONE,
REGRESSION_TYPE_LINEAR,
REGRESSION_TYPE_LOG,
REGRESSION_TYPE_EXP,
REGRESSION_TYPE_POWER
};
/** Returns the first regression curve found that is not of type
mean-value line
*/
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurve >
getFirstCurveNotMeanValueLine(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt );
/** Returns the type of the first regression curve found that is not of type
mean-value line
*/
static tRegressionType getFirstRegressTypeNotMeanValueLine(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt );
/** xPropertySource is taken as source to copy all properties from if not null
*/
static void addRegressionCurve( tRegressionType eType,
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt,
const ::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > & xContext,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet >& xPropertySource );
static bool removeAllExceptMeanValueLine(
::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveContainer > & xRegCnt );
// ------------------------------------------------------------
/// returns a calculator object for mean-value lines (used by the view)
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveCalculator >
createMeanValueLineCalculator();
/// returns a calculator object for regression curves (used by the view)
static ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveCalculator >
createRegressionCurveCalculatorByServiceName(
::rtl::OUString aServiceName );
/** recalculates the regression parameters according to the data given in
the data source.
A sequence having the role "values-x" will be used as x-values for the
calculation if found. Otherwise a sequence (1, 2, 3, ...) of category
indexes will be used for the recalculateRegression() method of the
regression curve.
The first sequence having the role "values-y" will be used as y-values
for the recalculateRegression() method of the regression curve.
@param bUseXValuesIfAvailable
If false, the sequence (1, 2, 3, ...) will always be used, even if
there is a data-sequence with role "values-x"
*/
static void initializeCurveCalculator(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveCalculator > & xOutCurveCalculator,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::data::XDataSource > & xSource,
bool bUseXValuesIfAvailable = true );
/** Same method as above, but uses the given XModel to determine the
parameter bUseXValuesIfAvailable in the above function. It is also
necessary that the data::XDataSource is an XDataSeries, thus this parameter
also changed.
*/
static void initializeCurveCalculator(
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurveCalculator > & xOutCurveCalculator,
const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XDataSeries > & xSeries,
const ::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel > & xModel );
static ::rtl::OUString getUINameForRegressionCurve( const ::com::sun::star::uno::Reference<
::com::sun::star::chart2::XRegressionCurve >& xCurve );
private:
// not implemented
RegressionCurveHelper();
};
} // namespace chart
// CHART2_REGRESSIONCURVEHELPER_HXX
#endif