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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
//! The parameter element definition.
// Copyright (c) 2021 ShiftLeft Software
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use rust_decimal::prelude::*;
use super::ElemSymbol;
pub struct ElemParameter {
/// Name of the parameter.
name: String,
/// Label of the parameter.
label: String,
/// Description of the parameter (i.e., help).
description: String,
/// Parameter symbol.
symbol: ElemSymbol,
}
/// The parameter element implementation.
impl ElemParameter {
/// Create a new parameter element.
///
/// # Arguments
///
/// * `name_param` - Parameter name.
/// * `label_param` - Parameter label.
/// * `desc_param` - Parameter description.
///
/// # Return
///
/// * See description.
pub fn new(name_param: &str, label_param: &str, desc_param: &str) -> ElemParameter {
ElemParameter {
name: String::from(name_param),
label: String::from(label_param),
description: String::from(desc_param),
symbol: ElemSymbol::new(),
}
}
/// Compare this parameter to the parameter parameter.
///
/// # Arguments
///
/// * `parameter` - Parameter to compare.
///
/// # Return
///
/// * True if equal, otherwise false.
pub fn equal(&self, parameter: &ElemParameter) -> bool {
if self.name != parameter.name() {
return false;
}
true
}
/// Get the parameter name.
///
/// # Return
///
/// * See description.
pub fn name(&self) -> &str {
self.name.as_str()
}
/// Get the parameter label.
///
/// # Return
///
/// * See description.
pub fn label(&self) -> &str {
self.label.as_str()
}
/// Get the parameter description.
///
/// # Return
///
/// * See description.
pub fn description(&self) -> &str {
self.description.as_str()
}
/// Get the parameter type.
///
/// # Return
///
/// * See description.
pub fn param_type(&self) -> crate::TokenType {
self.symbol.sym_type()
}
/// Get the parameter integer.
///
/// # Return
///
/// * See description.
pub fn param_integeri(&self) -> i32 {
self.symbol.sym_integeri()
}
/// Get the parameter integer.
///
/// # Return
///
/// * See description.
pub fn param_integer(&self) -> usize {
self.symbol.sym_integer()
}
/// Get the parameter decimal.
///
/// # Return
///
/// * See description.
pub fn param_decimal(&self) -> Decimal {
self.symbol.sym_decimal()
}
/// Get the parameter string.
///
/// # Return
///
/// * See description.
pub fn param_string(&self) -> &str {
self.symbol.sym_string()
}
/// Set the parameter name.
///
/// # Arguments
///
/// * `name_param` - See description.
pub fn set_name(&mut self, name_param: &str) {
self.name = String::from(name_param);
}
/// Set the parameter label.
///
/// # Arguments
///
/// * `label_param` - See description.
pub fn set_label(&mut self, label_param: &str) {
self.label = String::from(label_param);
}
/// Set the parameter description.
///
/// # Arguments
///
/// * `desc_param` - See description.
pub fn set_description(&mut self, desc_param: &str) {
self.description = String::from(desc_param);
}
/// Set the parameter type.
///
/// # Arguments
///
/// * `type_param` - See description.
pub fn set_type(&mut self, type_param: crate::TokenType) {
self.symbol.set_type(type_param);
}
/// Set the parameter integer.
///
/// # Arguments
///
/// * `integer_param` - See description.
pub fn set_integeri(&mut self, integer_param: i32) {
self.symbol.set_integeri(integer_param);
}
/// Set the parameter integer.
///
/// # Arguments
///
/// * `integer_param` - See description.
pub fn set_integer(&mut self, integer_param: usize) {
self.symbol.set_integer(integer_param);
}
/// Set the parameter decimal.
///
/// # Arguments
///
/// * `float_param` - See description.
pub fn set_decimal(&mut self, float_param: Decimal) {
self.symbol.set_decimal(float_param);
}
/// Set the parameter string.
///
/// # Arguments
///
/// * `string_param` - See description.
pub fn set_string(&mut self, string_param: &str) {
self.symbol.set_string(string_param);
}
}