1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_report_Calculation_idl__
24#define __com_sun_star_report_Calculation_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module report {
30
31//=============================================================================
32
33/** Specifies how to calculate a value.
34    @see XFormattedField
35 */
36published constants Calculation
37{
38    //-------------------------------------------------------------------------
39
40    /** returns the average of a field.
41     */
42    const short NONE = 0;
43
44    /** returns the average of a field.
45     */
46    const short AVERAGE = 1;
47
48    /** returns the correlation of two fields.
49     */
50    const short CORRELATION = 2;
51
52    /** counts the number of values, from the field.
53    */
54    const short COUNT = 3;
55
56    /** returns the measure of the linear relation between paired variables.
57    */
58    const short COVARIANCE = 4;
59
60    /** returns the number of none repeating values, from the field.
61    */
62    const short DISTINCTCOUNT = 5;
63
64    /** returns the largest value from the field.
65    */
66    const short MAXIMUM = 6;
67
68    /** returns the middle value in a sequence of numeric values.
69    */
70    const short MEDIAN = 7;
71
72    /** returns the smallest value from the field.
73    */
74    const short MINIMUM = 8;
75
76    /** returns the most frequently returning value from the field.
77    */
78    const short MODE = 9;
79
80    /** returns the Nth largest value from the field.
81    */
82    const short NTHLARGEST = 10;
83
84    /** returns the Nth most commonly occurring value from the field.
85    */
86    const short NTHMOSTFREQUENT = 11;
87
88    /** returns the Nth smallest value from the field.
89    */
90    const short NTHSMALLEST = 12;
91
92    /** returns as a percentage of the grand total summary.
93    */
94    const short PERCENTAGE = 13;
95
96    /** returns the value for a specified percentile in a Number or Currency field.
97    */
98    const short PERCENTILE = 14;
99
100    /** returns how much each value in the field deviate from the mean or average value for that field.
101    */
102    const short POPSTANDARDDEVIATION = 15;
103
104    /** returns the square of the standard deviation.
105    */
106    const short POPVARIANCE = 16;
107
108    /** returns the sample standard deviation for the field.
109    */
110    const short SAMPLESTANDARDDEVIATION = 17;
111
112    /** returns the sample variance for the field.
113    */
114    const short SAMPLEVARIANCE = 18;
115
116    /** returns the total of all the values for the field.
117    */
118    const short SUM = 19;
119
120    /** returns the weighted average for the field.
121    */
122    const short WEIGHTEDAVG = 20;
123};
124
125//=============================================================================
126
127}; }; }; };
128
129/*=============================================================================
130
131=============================================================================*/
132#endif
133