-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAreaCalculatorDoc.xml
More file actions
146 lines (145 loc) · 6.24 KB
/
AreaCalculatorDoc.xml
File metadata and controls
146 lines (145 loc) · 6.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?xml version="1.0"?>
<doc>
<assembly>
<name>AreaCalculator</name>
</assembly>
<members>
<member name="T:AreaCalculator.AreaCalculator">
<summary>
Represents area calculator class.
</summary>
</member>
<member name="P:AreaCalculator.AreaCalculator.Constants">
<summary>
All constant names, available for use.
</summary>
</member>
<member name="P:AreaCalculator.AreaCalculator.MathFuncs">
<summary>
All math functions names, available for use.
Also available:
+, -, *, /
amp;amp; ||, !
>, &&, <, >=, <=
==, !=
<conditiongt;?<iftrue>:<iffalse>
</summary>
</member>
<member name="P:AreaCalculator.AreaCalculator.FormulaNames">
<summary>
All formulas names, available for execution.
</summary>
</member>
<member name="M:AreaCalculator.AreaCalculator.#ctor">
<summary>
Initializes new instance of AreaCalculator class.
</summary>
</member>
<member name="M:AreaCalculator.AreaCalculator.AddFormula(System.String,System.String)">
<summary>
Add and compile new formula. formulaName must be unique.
</summary>
<param name="formulaName">
Unique string to store formula.
</param>
<param name="formula">
Formula for calculation.
May use:
1) Math functions, can be obtained by <c>MathFuncs</c> property. f.e.: SQRT()
2) Constants, in curly brackets, can be obtained by <c>Constants</c> property. f.e.: {PI}
3) Variables - one letter, in square brackets. f.e.: [x]
Also, you can combine several formulas into one by separating them with a comma.
The results of the calculation will be returned in the corresponding elements of the output array.
</param>
<exception cref="T:System.ArgumentNullException">If formulaName is null or formula is null</exception>
<exception cref="T:System.ArgumentException">If formulaName is already used.</exception>
<exception cref="T:AreaCalculator.FormulaCompilationException">If formula is incorrect.</exception>
<exception cref="T:AreaCalculator.FormulaWithoutVariablesException">If variables not found in formula.</exception>
</member>
<member name="M:AreaCalculator.AreaCalculator.AddFormula(System.String,AreaCalculator.ICalculateArea)">
<summary>
Adds new an implementing ICalculateArea class interface.
</summary>
<param name="formulaName">
Unique string to store formula.
</param>
<param name="calculator">
An implementing ICalculateArea class interface.
</param>
<exception cref="T:System.ArgumentNullException">
If formula name is null
If calculator is null
</exception>
<exception cref="T:AreaCalculator.ClassNoContainsFormulaFieldsException">
If calculator doesnt contain public fields with FormulaFieldAttribute
</exception>
</member>
<member name="M:AreaCalculator.AreaCalculator.GetFormulaVariables(System.String)">
<summary>
</summary>
<param name="formulaName">
Formula name from Formulas list.
The list can be obtained by <c>FormulaNames</c> property.
</param>
<returns>
List of variables, used in formula.
</returns>
<exception cref="T:System.ArgumentNullException">If formulaName is null</exception>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">If formulaName is not exists in formulas list</exception>
</member>
<member name="M:AreaCalculator.AreaCalculator.Calculate(System.String,System.Double[])">
<summary>
Calculates the given formula.
</summary>
<param name="formulaName">
Formula name from Formulas list.
The list can be obtained by <c>FormulaNames</c> property.
</param>
<param name="args">
Variables values, placed alphabetically in array.
For example: formula is <c>[b]+[c]+[a]</c>
values is b=2 a=1 c=3
args array must be formed: <c>[1,2,3]</c>
</param>
<returns>
Array of results corresponding to the formula.
</returns>
<exception cref="T:System.ArgumentNullException">If formulaName is null or args is null</exception>
<exception cref="T:System.ArgumentException">If args length doesn't match variables count in formula</exception>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">If formulaName is not exists in formulas list</exception>
</member>
<member name="T:AreaCalculator.FormulaFieldAttribute">
<summary>
Indicates a field with a variable in an implementing ICalculateArea class
</summary>
</member>
<member name="T:AreaCalculator.ICalculateArea">
<summary>
Area calculator interface
</summary>
</member>
<member name="M:AreaCalculator.ICalculateArea.CalculateArea(System.Double[])">
<summary>
Area calculator method
</summary>
<param name="args"></param>
<returns></returns>
</member>
<member name="T:AreaCalculator.QuadAreaCalculator">
<summary>
Implements ICalculate interface to calculate a quad area.
</summary>
</member>
<member name="M:AreaCalculator.QuadAreaCalculator.CalculateArea(System.Double[])">
<summary>
ICalculate implementation
</summary>
<param name="args">
double[2] as input
</param>
<returns>
double[1]{quadArea}
</returns>
</member>
</members>
</doc>