bbvcommon 6.268.0.20100803
Sign up to get free protection for your applications and to get access to all the features.
- data/lib/NET35/bbv.Common.AsyncModule.dll +0 -0
- data/lib/NET35/bbv.Common.AsyncModule.xml +893 -0
- data/lib/NET35/bbv.Common.Data.XML +245 -0
- data/lib/NET35/bbv.Common.Data.dll +0 -0
- data/lib/NET35/bbv.Common.Diagnostics.XML +102 -0
- data/lib/NET35/bbv.Common.Diagnostics.dll +0 -0
- data/lib/NET35/bbv.Common.EvaluationEngine.dll +0 -0
- data/lib/NET35/bbv.Common.EventBroker.XML +3100 -0
- data/lib/NET35/bbv.Common.EventBroker.dll +0 -0
- data/lib/NET35/bbv.Common.Formatters.dll +0 -0
- data/lib/NET35/bbv.Common.Formatters.xml +74 -0
- data/lib/NET35/bbv.Common.IO.dll +0 -0
- data/lib/NET35/bbv.Common.IO.xml +1354 -0
- data/lib/NET35/bbv.Common.RuleEngine.dll +0 -0
- data/lib/NET35/bbv.Common.RuleEngine.xml +659 -0
- data/lib/NET35/bbv.Common.Security.XML +339 -0
- data/lib/NET35/bbv.Common.Security.dll +0 -0
- data/lib/NET35/bbv.Common.StateMachine.XML +2559 -0
- data/lib/NET35/bbv.Common.StateMachine.dll +0 -0
- data/lib/NET35/bbv.Common.TestUtilities.dll +0 -0
- data/lib/NET35/bbv.Common.TestUtilities.xml +696 -0
- data/lib/NET35/bbv.Common.Threading.XML +401 -0
- data/lib/NET35/bbv.Common.Threading.dll +0 -0
- data/lib/NET35/bbv.Common.Windows.dll +0 -0
- data/lib/NET35/bbv.Common.Windows.xml +114 -0
- data/lib/NET35/bbv.Common.XML +831 -0
- data/lib/NET35/bbv.Common.dll +0 -0
- metadata +118 -0
@@ -0,0 +1,339 @@
|
|
1
|
+
<?xml version="1.0"?>
|
2
|
+
<doc>
|
3
|
+
<assembly>
|
4
|
+
<name>bbv.Common.Security</name>
|
5
|
+
</assembly>
|
6
|
+
<members>
|
7
|
+
<member name="T:bbv.Common.Security.FileHasher">
|
8
|
+
<summary>
|
9
|
+
Implements <see cref="T:bbv.Common.Security.IFileHasher"/>to provide functionality to read and write hash codes for files
|
10
|
+
</summary>
|
11
|
+
</member>
|
12
|
+
<member name="T:bbv.Common.Security.IFileHasher">
|
13
|
+
<summary>
|
14
|
+
Provides functionality to read and write hash codes for files
|
15
|
+
</summary>
|
16
|
+
</member>
|
17
|
+
<member name="M:bbv.Common.Security.IFileHasher.WriteSha1HashFile(System.String)">
|
18
|
+
<summary>
|
19
|
+
Writes a file containing the sha1 hash value of the file given. The file is named <paramref name="filePath"/>.sha1
|
20
|
+
</summary>
|
21
|
+
<param name="filePath">The file path.</param>
|
22
|
+
</member>
|
23
|
+
<member name="M:bbv.Common.Security.IFileHasher.ReadSha1HashFile(System.String)">
|
24
|
+
<summary>
|
25
|
+
Reads the sha1 hash value from the file named <paramref name="filePath"/>.sha1
|
26
|
+
</summary>
|
27
|
+
<param name="filePath">The file path of the origin file, not the hash file.</param>
|
28
|
+
<returns>The sha1 hash value from the file given</returns>
|
29
|
+
</member>
|
30
|
+
<member name="M:bbv.Common.Security.IFileHasher.CalculateSha1HashValue(System.String)">
|
31
|
+
<summary>
|
32
|
+
Calculates the sha1 hash value for the file path given
|
33
|
+
</summary>
|
34
|
+
<param name="filePath">The file path.</param>
|
35
|
+
<returns>The sha1 hash value for the file path given</returns>
|
36
|
+
</member>
|
37
|
+
<member name="F:bbv.Common.Security.FileHasher.Sha1Extension">
|
38
|
+
<summary>
|
39
|
+
The file extension for sha1 hash files
|
40
|
+
</summary>
|
41
|
+
</member>
|
42
|
+
<member name="F:bbv.Common.Security.FileHasher.hashService">
|
43
|
+
<summary>
|
44
|
+
The hash algorithm to calculate hash values
|
45
|
+
</summary>
|
46
|
+
</member>
|
47
|
+
<member name="M:bbv.Common.Security.FileHasher.#ctor">
|
48
|
+
<summary>
|
49
|
+
Initializes a new instance of the <see cref="T:bbv.Common.Security.FileHasher"/> class.
|
50
|
+
</summary>
|
51
|
+
</member>
|
52
|
+
<member name="M:bbv.Common.Security.FileHasher.WriteSha1HashFile(System.String)">
|
53
|
+
<summary>
|
54
|
+
Writes a file containing the sha1 hash code of the file given. The file is named <paramref name="filePath"/>.sha1
|
55
|
+
</summary>
|
56
|
+
<param name="filePath">The file path.</param>
|
57
|
+
</member>
|
58
|
+
<member name="M:bbv.Common.Security.FileHasher.ReadSha1HashFile(System.String)">
|
59
|
+
<summary>
|
60
|
+
Reads the sha1 hash value from the file named <paramref name="filePath"/>.sha1
|
61
|
+
</summary>
|
62
|
+
<param name="filePath">The file path of the origin file, not the hash file.</param>
|
63
|
+
<returns>The sha1 hash value from the file given</returns>
|
64
|
+
</member>
|
65
|
+
<member name="M:bbv.Common.Security.FileHasher.CalculateSha1HashValue(System.String)">
|
66
|
+
<summary>
|
67
|
+
Calculates the sha1 hash value for the file path given
|
68
|
+
</summary>
|
69
|
+
<param name="filePath">The file path.</param>
|
70
|
+
<returns>The sha1 hash value for the file path given</returns>
|
71
|
+
</member>
|
72
|
+
<member name="M:bbv.Common.Security.FileHasher.GetSha1FilePath(System.String)">
|
73
|
+
<summary>
|
74
|
+
Gets the file path of the sha1 hash file for a given origin file path
|
75
|
+
</summary>
|
76
|
+
<param name="filePath">The origin file path.</param>
|
77
|
+
<returns>The file path of the sha1 hash file</returns>
|
78
|
+
</member>
|
79
|
+
<member name="T:bbv.Common.Security.IHashService">
|
80
|
+
<summary>
|
81
|
+
Contains methods for hash generating from strings or from the specified input data.
|
82
|
+
</summary>
|
83
|
+
</member>
|
84
|
+
<member name="M:bbv.Common.Security.IHashService.GetHashFromString(System.String)">
|
85
|
+
<summary>
|
86
|
+
Computes the hash value from a text.
|
87
|
+
</summary>
|
88
|
+
<param name="text">The text, null is equal to an empty string.</param>
|
89
|
+
<returns>Hash as a hex-string.</returns>
|
90
|
+
</member>
|
91
|
+
<member name="M:bbv.Common.Security.IHashService.GetHashFromReader(bbv.Common.IO.ITextReader)">
|
92
|
+
<summary>
|
93
|
+
Computes the hash value from the input data.
|
94
|
+
</summary>
|
95
|
+
<param name="reader">The reader for the input data.</param>
|
96
|
+
<returns>Hash as a hex-string.</returns>
|
97
|
+
</member>
|
98
|
+
<member name="M:bbv.Common.Security.IHashService.WriteHashFromString(System.String,bbv.Common.IO.ITextWriter)">
|
99
|
+
<summary>
|
100
|
+
Writes the computed hash value to the sepcified output.
|
101
|
+
</summary>
|
102
|
+
<param name="text">The text, null is equal to an empty string.</param>
|
103
|
+
<param name="writer">The textwriter for the output.</param>
|
104
|
+
</member>
|
105
|
+
<member name="M:bbv.Common.Security.IHashService.WriteHash(bbv.Common.IO.ITextReader,bbv.Common.IO.ITextWriter)">
|
106
|
+
<summary>
|
107
|
+
Writes the computed hash value to the specified output.
|
108
|
+
</summary>
|
109
|
+
<param name="reader">The reader for the input data.</param>
|
110
|
+
<param name="writer">The textwriter for the output.</param>
|
111
|
+
</member>
|
112
|
+
<member name="M:bbv.Common.Security.IHashService.CompareWithHash(System.String,System.String)">
|
113
|
+
<summary>
|
114
|
+
Compares the computed hash value with the hash value.
|
115
|
+
</summary>
|
116
|
+
<param name="text">The text for computing the hash value.</param>
|
117
|
+
<param name="hash">The hash value.</param>
|
118
|
+
<returns>true if the computed hash is equal to the other.</returns>
|
119
|
+
</member>
|
120
|
+
<member name="M:bbv.Common.Security.IHashService.CompareWithHash(System.String,bbv.Common.IO.ITextReader)">
|
121
|
+
<summary>
|
122
|
+
Compares the computed hash value with the hash value from the input data.
|
123
|
+
</summary>
|
124
|
+
<param name="text">The text for computing the hash.</param>
|
125
|
+
<param name="reader">The textreader for the hash value.</param>
|
126
|
+
<returns>true if the hash from the textreader is equal to the computed hash.</returns>
|
127
|
+
</member>
|
128
|
+
<member name="M:bbv.Common.Security.IHashService.CompareWithHash(bbv.Common.IO.ITextReader,bbv.Common.IO.ITextReader)">
|
129
|
+
<summary>
|
130
|
+
Compares the computed hash value with the hash value from the input data.
|
131
|
+
</summary>
|
132
|
+
<param name="reader">The textreader for computing the hash.</param>
|
133
|
+
<param name="hashReader">The textreader for the hash value.</param>
|
134
|
+
<returns>true if the hash from the textreader is equal to the computed hash.</returns>
|
135
|
+
</member>
|
136
|
+
<member name="M:bbv.Common.Security.IHashService.CompareWithHash(bbv.Common.IO.ITextReader,System.String)">
|
137
|
+
<summary>
|
138
|
+
Compares the computed hash value with the hash value from the input data.
|
139
|
+
</summary>
|
140
|
+
<param name="reader">The textreader for computing the hash.</param>
|
141
|
+
<param name="hash">The hash value.</param>
|
142
|
+
<returns>true if the computed hash from the textreader is equal to the other hash.</returns>
|
143
|
+
</member>
|
144
|
+
<member name="T:bbv.Common.Security.IHashAlgorithm">
|
145
|
+
<summary>
|
146
|
+
Contains methods to compute a hash value from the specified input data.
|
147
|
+
</summary>
|
148
|
+
</member>
|
149
|
+
<member name="M:bbv.Common.Security.IHashAlgorithm.ComputeHash(System.String)">
|
150
|
+
<summary>
|
151
|
+
Computes the hash value for the specified string.
|
152
|
+
</summary>
|
153
|
+
<param name="text">The text for the input data.</param>
|
154
|
+
<returns>Hash value as a string.</returns>
|
155
|
+
</member>
|
156
|
+
<member name="M:bbv.Common.Security.IHashAlgorithm.ComputeHashFromStream(System.IO.Stream)">
|
157
|
+
<summary>
|
158
|
+
Computes the hash for the specified Stream.
|
159
|
+
</summary>
|
160
|
+
<param name="stream">The stream for the input data.</param>
|
161
|
+
<returns>Hash value as a string.</returns>
|
162
|
+
</member>
|
163
|
+
<member name="P:bbv.Common.Security.IHashAlgorithm.Format">
|
164
|
+
<summary>
|
165
|
+
Gets or sets the format of the hash value.
|
166
|
+
</summary>
|
167
|
+
<value>The format, {0:x2}.</value>
|
168
|
+
</member>
|
169
|
+
<member name="T:bbv.Common.Security.HashService">
|
170
|
+
<summary>
|
171
|
+
Contains methods for hash generating from strings or from the specified input data.
|
172
|
+
</summary>
|
173
|
+
</member>
|
174
|
+
<member name="M:bbv.Common.Security.HashService.#ctor(bbv.Common.Security.IHashAlgorithm)">
|
175
|
+
<summary>
|
176
|
+
Initializes a new instance of the <see cref="T:bbv.Common.Security.HashService"/> class with an Hashalgorithm.
|
177
|
+
</summary>
|
178
|
+
<param name="algorithm">The hashalgorithm.</param>
|
179
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="algorithm"/>is null</exception>
|
180
|
+
</member>
|
181
|
+
<member name="M:bbv.Common.Security.HashService.GetHashFromString(System.String)">
|
182
|
+
<summary>
|
183
|
+
Computes the hash value from a text.
|
184
|
+
</summary>
|
185
|
+
<param name="text">The text, null is equal as an empty string.</param>
|
186
|
+
<returns>Hash as a hex-string.</returns>
|
187
|
+
</member>
|
188
|
+
<member name="M:bbv.Common.Security.HashService.GetHashFromReader(bbv.Common.IO.ITextReader)">
|
189
|
+
<summary>
|
190
|
+
Computes the hash value from the content of a file.
|
191
|
+
</summary>
|
192
|
+
<param name="reader">The reader for the input data.</param>
|
193
|
+
<returns>Hash as a hex-string.</returns>
|
194
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="reader"/>is null</exception>
|
195
|
+
</member>
|
196
|
+
<member name="M:bbv.Common.Security.HashService.WriteHashFromString(System.String,bbv.Common.IO.ITextWriter)">
|
197
|
+
<summary>
|
198
|
+
Writes the hash file (hash.extension) from a text.
|
199
|
+
</summary>
|
200
|
+
<param name="text">The text, null is equal as an empty string.</param>
|
201
|
+
<param name="writer">The textwriter for the output.</param>
|
202
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="writer"/>is null</exception>
|
203
|
+
</member>
|
204
|
+
<member name="M:bbv.Common.Security.HashService.WriteHash(bbv.Common.IO.ITextReader,bbv.Common.IO.ITextWriter)">
|
205
|
+
<summary>
|
206
|
+
Writes the hash value file (filename.extension) from the content of a File.
|
207
|
+
</summary>
|
208
|
+
<param name="reader">The reader for the input data.</param>
|
209
|
+
<param name="writer">The textwriter for the output.</param>
|
210
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="reader"/>is null</exception>
|
211
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="writer"/>is null</exception>
|
212
|
+
</member>
|
213
|
+
<member name="M:bbv.Common.Security.HashService.CompareWithHash(System.String,System.String)">
|
214
|
+
<summary>
|
215
|
+
Computes a hash value of the text and compares it with the other hash value.
|
216
|
+
</summary>
|
217
|
+
<param name="text">The text.</param>
|
218
|
+
<param name="hash">The hash.</param>
|
219
|
+
<returns>
|
220
|
+
true if the computed hash is equal to the other, otherwise false.
|
221
|
+
</returns>
|
222
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="hash"/>is null</exception>
|
223
|
+
</member>
|
224
|
+
<member name="M:bbv.Common.Security.HashService.CompareWithHash(System.String,bbv.Common.IO.ITextReader)">
|
225
|
+
<summary>
|
226
|
+
Compares the generated hash value from the text with the hash value from the file.
|
227
|
+
</summary>
|
228
|
+
<param name="text">The text for generating the hash.</param>
|
229
|
+
<param name="reader">The textreader for the hash value.</param>
|
230
|
+
<returns>
|
231
|
+
true if the hash from the file is equal to the computed hash.
|
232
|
+
</returns>
|
233
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="reader"/>is null</exception>
|
234
|
+
</member>
|
235
|
+
<member name="M:bbv.Common.Security.HashService.CompareWithHash(bbv.Common.IO.ITextReader,bbv.Common.IO.ITextReader)">
|
236
|
+
<summary>
|
237
|
+
Compares the computed hash value with the hash value from the input data.
|
238
|
+
</summary>
|
239
|
+
<param name="reader">The textreader for computing the hash.</param>
|
240
|
+
<param name="hashReader">The textreader for the hash value.</param>
|
241
|
+
<returns>
|
242
|
+
true if the hash from the textreader is equal to the computed hash.
|
243
|
+
</returns>
|
244
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="reader"/>is null</exception>
|
245
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="hashReader"/>is null</exception>
|
246
|
+
</member>
|
247
|
+
<member name="M:bbv.Common.Security.HashService.CompareWithHash(bbv.Common.IO.ITextReader,System.String)">
|
248
|
+
<summary>
|
249
|
+
Compares the computed hash value with the hash value from the input data.
|
250
|
+
</summary>
|
251
|
+
<param name="reader">The textreader for computing the hash.</param>
|
252
|
+
<param name="hash">The hash value.</param>
|
253
|
+
<returns>
|
254
|
+
true if the computed hash from the textreader is equal to the other hash.
|
255
|
+
</returns>
|
256
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="reader"/>is null</exception>
|
257
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="hash"/>is null</exception>
|
258
|
+
</member>
|
259
|
+
<member name="T:bbv.Common.Security.MD5Algorithm">
|
260
|
+
<summary>
|
261
|
+
Contains methods to compute a MD5 hash value from the specified input data.
|
262
|
+
</summary>
|
263
|
+
</member>
|
264
|
+
<member name="M:bbv.Common.Security.MD5Algorithm.#ctor">
|
265
|
+
<summary>
|
266
|
+
Initializes a new instance of the <see cref="T:bbv.Common.Security.MD5Algorithm"/> class.
|
267
|
+
</summary>
|
268
|
+
</member>
|
269
|
+
<member name="M:bbv.Common.Security.MD5Algorithm.ComputeHash(System.String)">
|
270
|
+
<summary>
|
271
|
+
Computes the hash value for the specified string.
|
272
|
+
</summary>
|
273
|
+
<param name="text">The text for the input data.</param>
|
274
|
+
<returns>Hash value as a string.</returns>
|
275
|
+
</member>
|
276
|
+
<member name="M:bbv.Common.Security.MD5Algorithm.ComputeHashFromStream(System.IO.Stream)">
|
277
|
+
<summary>
|
278
|
+
Computes the hash for the specified stream.
|
279
|
+
</summary>
|
280
|
+
<param name="stream">The stream for the input data.</param>
|
281
|
+
<returns>Hash value as a string.</returns>
|
282
|
+
</member>
|
283
|
+
<member name="M:bbv.Common.Security.MD5Algorithm.BytesToString(System.Collections.IEnumerable)">
|
284
|
+
<summary>
|
285
|
+
Convert an array of bytes to a string in the specified format.
|
286
|
+
</summary>
|
287
|
+
<param name="bytes">The array of bytes.</param>
|
288
|
+
<returns>String value of the byte array.</returns>
|
289
|
+
</member>
|
290
|
+
<member name="P:bbv.Common.Security.MD5Algorithm.Format">
|
291
|
+
<summary>
|
292
|
+
Gets or sets the format of the hash value.
|
293
|
+
</summary>
|
294
|
+
<value>The format, {0:x2}.</value>
|
295
|
+
</member>
|
296
|
+
<member name="T:bbv.Common.Security.SHA1Algorithm">
|
297
|
+
<summary>
|
298
|
+
Contains methods to compute sha 1 algorithm from input data
|
299
|
+
</summary>
|
300
|
+
</member>
|
301
|
+
<member name="F:bbv.Common.Security.SHA1Algorithm.HexStringFormat">
|
302
|
+
<summary>
|
303
|
+
The format string for hex representation
|
304
|
+
</summary>
|
305
|
+
</member>
|
306
|
+
<member name="M:bbv.Common.Security.SHA1Algorithm.#ctor">
|
307
|
+
<summary>
|
308
|
+
Initializes a new instance of the <see cref="T:bbv.Common.Security.SHA1Algorithm"/> class.
|
309
|
+
</summary>
|
310
|
+
</member>
|
311
|
+
<member name="M:bbv.Common.Security.SHA1Algorithm.ComputeHash(System.String)">
|
312
|
+
<summary>
|
313
|
+
Computes the hash value for the specified string.
|
314
|
+
</summary>
|
315
|
+
<param name="text">The text for the input data.</param>
|
316
|
+
<returns>Hash value as a string.</returns>
|
317
|
+
</member>
|
318
|
+
<member name="M:bbv.Common.Security.SHA1Algorithm.ComputeHashFromStream(System.IO.Stream)">
|
319
|
+
<summary>
|
320
|
+
Computes the hash for the specified Stream.
|
321
|
+
</summary>
|
322
|
+
<param name="stream">The stream for the input data.</param>
|
323
|
+
<returns>Hash value as a string.</returns>
|
324
|
+
</member>
|
325
|
+
<member name="M:bbv.Common.Security.SHA1Algorithm.BytesToString(System.Collections.IEnumerable)">
|
326
|
+
<summary>
|
327
|
+
Convert an array of bytes to a string in the specified format.
|
328
|
+
</summary>
|
329
|
+
<param name="bytes">The array of bytes.</param>
|
330
|
+
<returns>String value of the byte array.</returns>
|
331
|
+
</member>
|
332
|
+
<member name="P:bbv.Common.Security.SHA1Algorithm.Format">
|
333
|
+
<summary>
|
334
|
+
Gets or sets the format of the hash value.
|
335
|
+
</summary>
|
336
|
+
<value>The format, {0:x2}.</value>
|
337
|
+
</member>
|
338
|
+
</members>
|
339
|
+
</doc>
|
Binary file
|
@@ -0,0 +1,2559 @@
|
|
1
|
+
<?xml version="1.0"?>
|
2
|
+
<doc>
|
3
|
+
<assembly>
|
4
|
+
<name>bbv.Common.StateMachine</name>
|
5
|
+
</assembly>
|
6
|
+
<members>
|
7
|
+
<member name="T:bbv.Common.StateMachine.Extensions.ExtensionBase`2">
|
8
|
+
<summary>
|
9
|
+
Base class for state machine extensions with empty implementation.
|
10
|
+
</summary>
|
11
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
12
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
13
|
+
</member>
|
14
|
+
<member name="T:bbv.Common.StateMachine.IExtension`2">
|
15
|
+
<summary>
|
16
|
+
Extensions for a state machine have to implement this interface.
|
17
|
+
</summary>
|
18
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
19
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
20
|
+
</member>
|
21
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.SwitchedState(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
22
|
+
<summary>
|
23
|
+
Called after the state machine switched states.
|
24
|
+
</summary>
|
25
|
+
<param name="stateMachine">The state machine.</param>
|
26
|
+
<param name="oldState">The old state.</param>
|
27
|
+
<param name="newState">The new state.</param>
|
28
|
+
</member>
|
29
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.InitializingStateMachine(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},`0@)">
|
30
|
+
<summary>
|
31
|
+
Called when the state machine is initializing.
|
32
|
+
</summary>
|
33
|
+
<param name="stateMachine">The state machine.</param>
|
34
|
+
<param name="initialState">The initial state. Can be replaced by the extension.</param>
|
35
|
+
</member>
|
36
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.InitializedStateMachine(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},`0)">
|
37
|
+
<summary>
|
38
|
+
Called when the state machine was initialized.
|
39
|
+
</summary>
|
40
|
+
<param name="stateMachine">The state machine.</param>
|
41
|
+
<param name="stateContext">The state context of the initial state.</param>
|
42
|
+
<param name="initialState">The initial state.</param>
|
43
|
+
</member>
|
44
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.FiringEvent(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},`1@,System.Object[]@)">
|
45
|
+
<summary>
|
46
|
+
Called when an event is firing on the state machine.
|
47
|
+
</summary>
|
48
|
+
<param name="stateMachine">The state machine.</param>
|
49
|
+
<param name="eventId">The event id. Can be replaced by the extension.</param>
|
50
|
+
<param name="eventArguments">The event arguments. Can be replaced by the extension.</param>
|
51
|
+
</member>
|
52
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.FiredEvent(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
53
|
+
<summary>
|
54
|
+
Called when an event was fired on the state machine.
|
55
|
+
</summary>
|
56
|
+
<param name="stateMachine">The state machine.</param>
|
57
|
+
<param name="context">The transition context.</param>
|
58
|
+
</member>
|
59
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandlingEntryActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception@)">
|
60
|
+
<summary>
|
61
|
+
Called before an entry action exception is handled.
|
62
|
+
</summary>
|
63
|
+
<param name="stateMachine">The state machine.</param>
|
64
|
+
<param name="state">The state.</param>
|
65
|
+
<param name="stateContext">The state context.</param>
|
66
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
67
|
+
</member>
|
68
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandledEntryActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
69
|
+
<summary>
|
70
|
+
Called after an entry action exception was handled.
|
71
|
+
</summary>
|
72
|
+
<param name="stateMachine">The state machine.</param>
|
73
|
+
<param name="state">The state.</param>
|
74
|
+
<param name="stateContext">The state context.</param>
|
75
|
+
<param name="exception">The exception.</param>
|
76
|
+
</member>
|
77
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandlingExitActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception@)">
|
78
|
+
<summary>
|
79
|
+
Called before an exit action exception is handled.
|
80
|
+
</summary>
|
81
|
+
<param name="stateMachine">The state machine.</param>
|
82
|
+
<param name="state">The state.</param>
|
83
|
+
<param name="stateContext">The state context.</param>
|
84
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
85
|
+
</member>
|
86
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandledExitActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
87
|
+
<summary>
|
88
|
+
Called after an exit action exception was handled.
|
89
|
+
</summary>
|
90
|
+
<param name="stateMachine">The state machine.</param>
|
91
|
+
<param name="state">The state.</param>
|
92
|
+
<param name="stateContext">The state context.</param>
|
93
|
+
<param name="exception">The exception.</param>
|
94
|
+
</member>
|
95
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandlingGuardException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception@)">
|
96
|
+
<summary>
|
97
|
+
Called before a guard exception is handled.
|
98
|
+
</summary>
|
99
|
+
<param name="stateMachine">The state machine.</param>
|
100
|
+
<param name="transition">The transition.</param>
|
101
|
+
<param name="transitionContext">The transition context.</param>
|
102
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
103
|
+
</member>
|
104
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandledGuardException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
105
|
+
<summary>
|
106
|
+
Called after a guard exception was handled.
|
107
|
+
</summary>
|
108
|
+
<param name="stateMachine">The state machine.</param>
|
109
|
+
<param name="transition">The transition.</param>
|
110
|
+
<param name="transitionContext">The transition context.</param>
|
111
|
+
<param name="exception">The exception.</param>
|
112
|
+
</member>
|
113
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandlingTransitionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception@)">
|
114
|
+
<summary>
|
115
|
+
Called before a transition exception is handled.
|
116
|
+
</summary>
|
117
|
+
<param name="stateMachine">The state machine.</param>
|
118
|
+
<param name="transition">The transition.</param>
|
119
|
+
<param name="context">The context.</param>
|
120
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
121
|
+
</member>
|
122
|
+
<member name="M:bbv.Common.StateMachine.IExtension`2.HandledTransitionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
123
|
+
<summary>
|
124
|
+
Called after a transition exception is handled.
|
125
|
+
</summary>
|
126
|
+
<param name="stateMachine">The state machine.</param>
|
127
|
+
<param name="transition">The transition.</param>
|
128
|
+
<param name="transitionContext">The transition context.</param>
|
129
|
+
<param name="exception">The exception.</param>
|
130
|
+
</member>
|
131
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.SwitchedState(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
132
|
+
<summary>
|
133
|
+
Called after the state machine switched states.
|
134
|
+
</summary>
|
135
|
+
<param name="stateMachine">The state machine.</param>
|
136
|
+
<param name="oldState">The old state.</param>
|
137
|
+
<param name="newState">The new state.</param>
|
138
|
+
</member>
|
139
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.InitializingStateMachine(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},`0@)">
|
140
|
+
<summary>
|
141
|
+
Called when the state machine is initializing.
|
142
|
+
</summary>
|
143
|
+
<param name="stateMachine">The state machine.</param>
|
144
|
+
<param name="initialState">The initial state. Can be replaced by the extension.</param>
|
145
|
+
</member>
|
146
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.InitializedStateMachine(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},`0)">
|
147
|
+
<summary>
|
148
|
+
Called when the state machine was initialized.
|
149
|
+
</summary>
|
150
|
+
<param name="stateMachine">The state machine.</param>
|
151
|
+
<param name="stateContext">The state context of the initial state.</param>
|
152
|
+
<param name="initialState">The initial state.</param>
|
153
|
+
</member>
|
154
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.FiringEvent(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},`1@,System.Object[]@)">
|
155
|
+
<summary>
|
156
|
+
Called when an event is firing on the state machine.
|
157
|
+
</summary>
|
158
|
+
<param name="stateMachine">The state machine.</param>
|
159
|
+
<param name="eventId">The event id. Can be replaced by the extension.</param>
|
160
|
+
<param name="eventArguments">The event arguments. Can be replaced by the extension.</param>
|
161
|
+
</member>
|
162
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.FiredEvent(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
163
|
+
<summary>
|
164
|
+
Called when an event was fired on the state machine.
|
165
|
+
</summary>
|
166
|
+
<param name="stateMachine">The state machine.</param>
|
167
|
+
<param name="context">The transition context.</param>
|
168
|
+
</member>
|
169
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandlingEntryActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception@)">
|
170
|
+
<summary>
|
171
|
+
Called before an entry action exception is handled.
|
172
|
+
</summary>
|
173
|
+
<param name="stateMachine">The state machine.</param>
|
174
|
+
<param name="state">The state.</param>
|
175
|
+
<param name="stateContext">The state context.</param>
|
176
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
177
|
+
</member>
|
178
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandledEntryActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
179
|
+
<summary>
|
180
|
+
Called after an entry action exception was handled.
|
181
|
+
</summary>
|
182
|
+
<param name="stateMachine">The state machine.</param>
|
183
|
+
<param name="state">The state.</param>
|
184
|
+
<param name="stateContext">The state context.</param>
|
185
|
+
<param name="exception">The exception.</param>
|
186
|
+
</member>
|
187
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandlingExitActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception@)">
|
188
|
+
<summary>
|
189
|
+
Called before an exit action exception is handled.
|
190
|
+
</summary>
|
191
|
+
<param name="stateMachine">The state machine.</param>
|
192
|
+
<param name="state">The state.</param>
|
193
|
+
<param name="stateContext">The state context.</param>
|
194
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
195
|
+
</member>
|
196
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandledExitActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
197
|
+
<summary>
|
198
|
+
Called after an exit action exception was handled.
|
199
|
+
</summary>
|
200
|
+
<param name="stateMachine">The state machine.</param>
|
201
|
+
<param name="state">The state.</param>
|
202
|
+
<param name="stateContext">The state context.</param>
|
203
|
+
<param name="exception">The exception.</param>
|
204
|
+
</member>
|
205
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandlingGuardException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception@)">
|
206
|
+
<summary>
|
207
|
+
Called before a guard exception is handled.
|
208
|
+
</summary>
|
209
|
+
<param name="stateMachine">The state machine.</param>
|
210
|
+
<param name="transition">The transition.</param>
|
211
|
+
<param name="transitionContext">The transition context.</param>
|
212
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
213
|
+
</member>
|
214
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandledGuardException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
215
|
+
<summary>
|
216
|
+
Called after a guard exception was handled.
|
217
|
+
</summary>
|
218
|
+
<param name="stateMachine">The state machine.</param>
|
219
|
+
<param name="transition">The transition.</param>
|
220
|
+
<param name="transitionContext">The transition context.</param>
|
221
|
+
<param name="exception">The exception.</param>
|
222
|
+
</member>
|
223
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandlingTransitionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception@)">
|
224
|
+
<summary>
|
225
|
+
Called before a transition exception is handled.
|
226
|
+
</summary>
|
227
|
+
<param name="stateMachine">The state machine.</param>
|
228
|
+
<param name="transition">The transition.</param>
|
229
|
+
<param name="context">The context.</param>
|
230
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
231
|
+
</member>
|
232
|
+
<member name="M:bbv.Common.StateMachine.Extensions.ExtensionBase`2.HandledTransitionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
233
|
+
<summary>
|
234
|
+
Called after a transition exception is handled.
|
235
|
+
</summary>
|
236
|
+
<param name="stateMachine">The state machine.</param>
|
237
|
+
<param name="transition">The transition.</param>
|
238
|
+
<param name="transitionContext">The transition context.</param>
|
239
|
+
<param name="exception">The exception.</param>
|
240
|
+
</member>
|
241
|
+
<member name="T:bbv.Common.StateMachine.Internals.IExtensionHost`2">
|
242
|
+
<summary>
|
243
|
+
Interface to execute actions on all extensions of the event broker.
|
244
|
+
</summary>
|
245
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
246
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
247
|
+
</member>
|
248
|
+
<member name="M:bbv.Common.StateMachine.Internals.IExtensionHost`2.ForEach(System.Action{bbv.Common.StateMachine.IExtension{`0,`1}})">
|
249
|
+
<summary>
|
250
|
+
Executes the specified action for all extensions.
|
251
|
+
</summary>
|
252
|
+
<param name="action">The action to execute.</param>
|
253
|
+
</member>
|
254
|
+
<member name="T:bbv.Common.StateMachine.IStateMachineInformation`2">
|
255
|
+
<summary>
|
256
|
+
Provides information about a state machine.
|
257
|
+
</summary>
|
258
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
259
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
260
|
+
</member>
|
261
|
+
<member name="P:bbv.Common.StateMachine.IStateMachineInformation`2.Name">
|
262
|
+
<summary>
|
263
|
+
Gets the name of this instance.
|
264
|
+
</summary>
|
265
|
+
<value>The name of this instance.</value>
|
266
|
+
</member>
|
267
|
+
<member name="P:bbv.Common.StateMachine.IStateMachineInformation`2.CurrentStateId">
|
268
|
+
<summary>
|
269
|
+
Gets the id of the current state.
|
270
|
+
</summary>
|
271
|
+
<value>The id of the current state.</value>
|
272
|
+
</member>
|
273
|
+
<member name="T:bbv.Common.StateMachine.Extensions.Log4NetExtension`2">
|
274
|
+
<summary>
|
275
|
+
Extension for logging with log4net.
|
276
|
+
</summary>
|
277
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
278
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
279
|
+
</member>
|
280
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.#ctor">
|
281
|
+
<summary>
|
282
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Extensions.Log4NetExtension`2"/> class.
|
283
|
+
</summary>
|
284
|
+
</member>
|
285
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.#ctor(System.String)">
|
286
|
+
<summary>
|
287
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Extensions.Log4NetExtension`2"/> class.
|
288
|
+
</summary>
|
289
|
+
<param name="logger">The logger.</param>
|
290
|
+
</member>
|
291
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.SwitchedState(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
292
|
+
<summary>
|
293
|
+
Called after the state machine switched states.
|
294
|
+
</summary>
|
295
|
+
<param name="stateMachine">The state machine.</param>
|
296
|
+
<param name="oldState">The old state.</param>
|
297
|
+
<param name="newState">The new state.</param>
|
298
|
+
</member>
|
299
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.InitializingStateMachine(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},`0@)">
|
300
|
+
<summary>
|
301
|
+
Called when the state machine is initializing.
|
302
|
+
</summary>
|
303
|
+
<param name="stateMachine">The state machine.</param>
|
304
|
+
<param name="initialState">The initial state. Can be replaced by the extension.</param>
|
305
|
+
</member>
|
306
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.InitializedStateMachine(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},`0)">
|
307
|
+
<summary>
|
308
|
+
Called when the state machine was initialized.
|
309
|
+
</summary>
|
310
|
+
<param name="stateMachine">The state machine.</param>
|
311
|
+
<param name="stateContext">The state context of the initial state.</param>
|
312
|
+
<param name="initialState">The initial state.</param>
|
313
|
+
</member>
|
314
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.FiringEvent(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},`1@,System.Object[]@)">
|
315
|
+
<summary>
|
316
|
+
Called when an event is firing on the state machine.
|
317
|
+
</summary>
|
318
|
+
<param name="stateMachine">The state machine.</param>
|
319
|
+
<param name="eventId">The event id. Can be replaced by the extension.</param>
|
320
|
+
<param name="eventArguments">The event arguments. Can be replaced by the extension.</param>
|
321
|
+
</member>
|
322
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.FiredEvent(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
323
|
+
<summary>
|
324
|
+
Called when an event was fired on the state machine.
|
325
|
+
</summary>
|
326
|
+
<param name="stateMachine">The state machine.</param>
|
327
|
+
<param name="context">The transition context.</param>
|
328
|
+
</member>
|
329
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.HandlingEntryActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception@)">
|
330
|
+
<summary>
|
331
|
+
Called before an entry action exception is handled.
|
332
|
+
</summary>
|
333
|
+
<param name="stateMachine">The state machine.</param>
|
334
|
+
<param name="state">The state.</param>
|
335
|
+
<param name="stateContext">The state context.</param>
|
336
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
337
|
+
</member>
|
338
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.HandlingExitActionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception@)">
|
339
|
+
<summary>
|
340
|
+
Called before an exit action exception is handled.
|
341
|
+
</summary>
|
342
|
+
<param name="stateMachine">The state machine.</param>
|
343
|
+
<param name="state">The state.</param>
|
344
|
+
<param name="stateContext">The state context.</param>
|
345
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
346
|
+
</member>
|
347
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.HandlingGuardException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception@)">
|
348
|
+
<summary>
|
349
|
+
Called before a guard exception is handled.
|
350
|
+
</summary>
|
351
|
+
<param name="stateMachine">The state machine.</param>
|
352
|
+
<param name="transition">The transition.</param>
|
353
|
+
<param name="transitionContext">The transition context.</param>
|
354
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
355
|
+
</member>
|
356
|
+
<member name="M:bbv.Common.StateMachine.Extensions.Log4NetExtension`2.HandlingTransitionException(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.ITransition{`0,`1},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception@)">
|
357
|
+
<summary>
|
358
|
+
Called before a transition exception is handled.
|
359
|
+
</summary>
|
360
|
+
<param name="stateMachine">The state machine.</param>
|
361
|
+
<param name="transition">The transition.</param>
|
362
|
+
<param name="context">The context.</param>
|
363
|
+
<param name="exception">The exception. Can be replaced by the extension.</param>
|
364
|
+
</member>
|
365
|
+
<member name="T:bbv.Common.StateMachine.Internals.ActionHolder">
|
366
|
+
<summary>
|
367
|
+
Wraps a parameterless action.
|
368
|
+
</summary>
|
369
|
+
</member>
|
370
|
+
<member name="T:bbv.Common.StateMachine.Internals.IActionHolder">
|
371
|
+
<summary>
|
372
|
+
Wrapper for parameterless actions and actions with parameters.
|
373
|
+
</summary>
|
374
|
+
</member>
|
375
|
+
<member name="M:bbv.Common.StateMachine.Internals.IActionHolder.Execute">
|
376
|
+
<summary>
|
377
|
+
Executes the wrapped action.
|
378
|
+
</summary>
|
379
|
+
</member>
|
380
|
+
<member name="F:bbv.Common.StateMachine.Internals.ActionHolder.action">
|
381
|
+
<summary>
|
382
|
+
the wrapped action.
|
383
|
+
</summary>
|
384
|
+
</member>
|
385
|
+
<member name="M:bbv.Common.StateMachine.Internals.ActionHolder.#ctor(System.Action)">
|
386
|
+
<summary>
|
387
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.ActionHolder"/> class.
|
388
|
+
</summary>
|
389
|
+
<param name="action">The wrapped action.</param>
|
390
|
+
</member>
|
391
|
+
<member name="M:bbv.Common.StateMachine.Internals.ActionHolder.Execute">
|
392
|
+
<summary>
|
393
|
+
Executes the wrapped action.
|
394
|
+
</summary>
|
395
|
+
</member>
|
396
|
+
<member name="T:bbv.Common.StateMachine.Internals.ActionHolder`1">
|
397
|
+
<summary>
|
398
|
+
Wraps an action with a single parameter.
|
399
|
+
</summary>
|
400
|
+
<typeparam name="T">The type of the parameter of the action.</typeparam>
|
401
|
+
</member>
|
402
|
+
<member name="F:bbv.Common.StateMachine.Internals.ActionHolder`1.action">
|
403
|
+
<summary>
|
404
|
+
the wrapped action
|
405
|
+
</summary>
|
406
|
+
</member>
|
407
|
+
<member name="F:bbv.Common.StateMachine.Internals.ActionHolder`1.parameter">
|
408
|
+
<summary>
|
409
|
+
the parameter that is passed to the action on execution.
|
410
|
+
</summary>
|
411
|
+
</member>
|
412
|
+
<member name="M:bbv.Common.StateMachine.Internals.ActionHolder`1.#ctor(System.Action{`0},`0)">
|
413
|
+
<summary>
|
414
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.ActionHolder`1"/> class.
|
415
|
+
</summary>
|
416
|
+
<param name="action">The wrapped action.</param>
|
417
|
+
<param name="parameter">The parameter that is passed to the action on execution.</param>
|
418
|
+
</member>
|
419
|
+
<member name="M:bbv.Common.StateMachine.Internals.ActionHolder`1.Execute">
|
420
|
+
<summary>
|
421
|
+
Executes the wrapped action.
|
422
|
+
</summary>
|
423
|
+
</member>
|
424
|
+
<member name="T:bbv.Common.StateMachine.ActiveStateMachine`2">
|
425
|
+
<summary>
|
426
|
+
An active state machine.
|
427
|
+
This state machine reacts to events on its own worker thread and the <see cref="M:bbv.Common.StateMachine.ActiveStateMachine`2.Fire(`1,System.Object[])"/> or
|
428
|
+
<see cref="M:bbv.Common.StateMachine.ActiveStateMachine`2.FirePriority(`1,System.Object[])"/> methods return immediately back to the caller.
|
429
|
+
</summary>
|
430
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
431
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
432
|
+
</member>
|
433
|
+
<member name="T:bbv.Common.StateMachine.IStateMachine`2">
|
434
|
+
<summary>
|
435
|
+
A state machine.
|
436
|
+
</summary>
|
437
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
438
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
439
|
+
</member>
|
440
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.In(`0)">
|
441
|
+
<summary>
|
442
|
+
Define the behavior of a state.
|
443
|
+
</summary>
|
444
|
+
<param name="state">The state.</param>
|
445
|
+
<returns>Syntax to build state behavior.</returns>
|
446
|
+
</member>
|
447
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.DefineHierarchyOn(`0,`0,bbv.Common.StateMachine.HistoryType,`0[])">
|
448
|
+
<summary>
|
449
|
+
Defines a state hierarchy.
|
450
|
+
</summary>
|
451
|
+
<param name="superStateId">The super state id.</param>
|
452
|
+
<param name="initialSubStateId">The initial sub state id.</param>
|
453
|
+
<param name="historyType">Type of the history.</param>
|
454
|
+
<param name="subStateIds">The sub state ids.</param>
|
455
|
+
</member>
|
456
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.Fire(`1,System.Object[])">
|
457
|
+
<summary>
|
458
|
+
Fires the specified event.
|
459
|
+
</summary>
|
460
|
+
<param name="eventId">The event.</param>
|
461
|
+
<param name="eventArguments">The event arguments.</param>
|
462
|
+
</member>
|
463
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.FirePriority(`1,System.Object[])">
|
464
|
+
<summary>
|
465
|
+
Fires the specified priority event. The event will be handled before any already queued event.
|
466
|
+
</summary>
|
467
|
+
<param name="eventId">The event.</param>
|
468
|
+
<param name="eventArguments">The event arguments.</param>
|
469
|
+
</member>
|
470
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.Initialize(`0)">
|
471
|
+
<summary>
|
472
|
+
Initializes the state machine to the specified initial state.
|
473
|
+
</summary>
|
474
|
+
<param name="initialState">The state to which the state machine is initialized.</param>
|
475
|
+
</member>
|
476
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.Start">
|
477
|
+
<summary>
|
478
|
+
Starts the state machine. Events will be processed.
|
479
|
+
If the state machine is not started then the events will be queued until the state machine is started.
|
480
|
+
Already queued events are processed
|
481
|
+
</summary>
|
482
|
+
</member>
|
483
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.Stop">
|
484
|
+
<summary>
|
485
|
+
Stops the state machine. Events will be queued until the state machine is started.
|
486
|
+
</summary>
|
487
|
+
</member>
|
488
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.AddExtension(bbv.Common.StateMachine.IExtension{`0,`1})">
|
489
|
+
<summary>
|
490
|
+
Adds an extension.
|
491
|
+
</summary>
|
492
|
+
<param name="extension">The extension.</param>
|
493
|
+
</member>
|
494
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.ClearExtensions">
|
495
|
+
<summary>
|
496
|
+
Clears all extensions.
|
497
|
+
</summary>
|
498
|
+
</member>
|
499
|
+
<member name="M:bbv.Common.StateMachine.IStateMachine`2.Report">
|
500
|
+
<summary>
|
501
|
+
Returns a report of this state machine with all states and transitions.
|
502
|
+
</summary>
|
503
|
+
<returns>A string containing a report of this state machine with all states and transitions.</returns>
|
504
|
+
</member>
|
505
|
+
<member name="E:bbv.Common.StateMachine.IStateMachine`2.TransitionDeclined">
|
506
|
+
<summary>
|
507
|
+
Occurs when no transition could be executed.
|
508
|
+
</summary>
|
509
|
+
</member>
|
510
|
+
<member name="E:bbv.Common.StateMachine.IStateMachine`2.ExceptionThrown">
|
511
|
+
<summary>
|
512
|
+
Occurs when an exception was thrown inside the state machine.
|
513
|
+
</summary>
|
514
|
+
</member>
|
515
|
+
<member name="E:bbv.Common.StateMachine.IStateMachine`2.TransitionExceptionThrown">
|
516
|
+
<summary>
|
517
|
+
Occurs when an exception was thrown inside a transition of the state machine.
|
518
|
+
</summary>
|
519
|
+
</member>
|
520
|
+
<member name="E:bbv.Common.StateMachine.IStateMachine`2.TransitionBegin">
|
521
|
+
<summary>
|
522
|
+
Occurs when a transition begins.
|
523
|
+
</summary>
|
524
|
+
</member>
|
525
|
+
<member name="E:bbv.Common.StateMachine.IStateMachine`2.TransitionCompleted">
|
526
|
+
<summary>
|
527
|
+
Occurs when a transition completed.
|
528
|
+
</summary>
|
529
|
+
</member>
|
530
|
+
<member name="P:bbv.Common.StateMachine.IStateMachine`2.IsRunning">
|
531
|
+
<summary>
|
532
|
+
Gets a value indicating whether this instance is running. The state machine is running if if was started and not yet stopped.
|
533
|
+
</summary>
|
534
|
+
<value><c>true</c> if this instance is running; otherwise, <c>false</c>.</value>
|
535
|
+
</member>
|
536
|
+
<member name="F:bbv.Common.StateMachine.ActiveStateMachine`2.stateMachine">
|
537
|
+
<summary>
|
538
|
+
The internal state machine.
|
539
|
+
</summary>
|
540
|
+
</member>
|
541
|
+
<member name="F:bbv.Common.StateMachine.ActiveStateMachine`2.moduleController">
|
542
|
+
<summary>
|
543
|
+
The module controller used to make this state machine active.
|
544
|
+
</summary>
|
545
|
+
</member>
|
546
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.#ctor">
|
547
|
+
<summary>
|
548
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.ActiveStateMachine`2"/> class.
|
549
|
+
</summary>
|
550
|
+
</member>
|
551
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.#ctor(System.String)">
|
552
|
+
<summary>
|
553
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.ActiveStateMachine`2"/> class.
|
554
|
+
</summary>
|
555
|
+
<param name="name">The name of the state machine. Used in log messages.</param>
|
556
|
+
</member>
|
557
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.#ctor(System.String,bbv.Common.StateMachine.Internals.IFactory{`0,`1})">
|
558
|
+
<summary>
|
559
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.ActiveStateMachine`2"/> class.
|
560
|
+
</summary>
|
561
|
+
<param name="name">The name of the state machine.</param>
|
562
|
+
<param name="factory">The factory.</param>
|
563
|
+
</member>
|
564
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.In(`0)">
|
565
|
+
<summary>
|
566
|
+
Define the behavior of a state.
|
567
|
+
</summary>
|
568
|
+
<param name="state">The state.</param>
|
569
|
+
<returns>Syntax to build state behavior.</returns>
|
570
|
+
</member>
|
571
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.DefineHierarchyOn(`0,`0,bbv.Common.StateMachine.HistoryType,`0[])">
|
572
|
+
<summary>
|
573
|
+
Defines a state hierarchy.
|
574
|
+
</summary>
|
575
|
+
<param name="superStateId">The super state id.</param>
|
576
|
+
<param name="initialSubStateId">The initial state id.</param>
|
577
|
+
<param name="historyType">Type of the history.</param>
|
578
|
+
<param name="subStateIds">The sub state ids.</param>
|
579
|
+
</member>
|
580
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Fire(`1,System.Object[])">
|
581
|
+
<summary>
|
582
|
+
Fires the specified event.
|
583
|
+
</summary>
|
584
|
+
<param name="eventId">The event.</param>
|
585
|
+
<param name="eventArguments">The event arguments.</param>
|
586
|
+
</member>
|
587
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.FirePriority(`1,System.Object[])">
|
588
|
+
<summary>
|
589
|
+
Fires the specified priority event. The event will be handled before any already queued event.
|
590
|
+
</summary>
|
591
|
+
<param name="eventId">The event.</param>
|
592
|
+
<param name="eventArguments">The event arguments.</param>
|
593
|
+
</member>
|
594
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Initialize(`0)">
|
595
|
+
<summary>
|
596
|
+
Initializes the state machine to the specified initial state.
|
597
|
+
</summary>
|
598
|
+
<param name="initialState">The state to which the state machine is initialized.</param>
|
599
|
+
</member>
|
600
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Start">
|
601
|
+
<summary>
|
602
|
+
Starts the state machine. Events will be processed.
|
603
|
+
If the state machine is not started then the events will be queued until the state machine is started.
|
604
|
+
Already queued events are processed
|
605
|
+
</summary>
|
606
|
+
</member>
|
607
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Stop">
|
608
|
+
<summary>
|
609
|
+
Stops the state machine. Events will be queued until the state machine is started.
|
610
|
+
</summary>
|
611
|
+
</member>
|
612
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.AddExtension(bbv.Common.StateMachine.IExtension{`0,`1})">
|
613
|
+
<summary>
|
614
|
+
Adds the extension.
|
615
|
+
</summary>
|
616
|
+
<param name="extension">The extension.</param>
|
617
|
+
</member>
|
618
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.ClearExtensions">
|
619
|
+
<summary>
|
620
|
+
Clears all extensions.
|
621
|
+
</summary>
|
622
|
+
</member>
|
623
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Report">
|
624
|
+
<summary>
|
625
|
+
Returns a report of this state machine with all states and transitions.
|
626
|
+
</summary>
|
627
|
+
<returns>A string containing a report of this state machine with all states and transitions.</returns>
|
628
|
+
</member>
|
629
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Execute(bbv.Common.StateMachine.Internals.EventInformation{`1})">
|
630
|
+
<summary>
|
631
|
+
Fires an event to the state machine.
|
632
|
+
</summary>
|
633
|
+
<param name="message">The message containing the event information.</param>
|
634
|
+
</member>
|
635
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.Initialize(bbv.Common.StateMachine.ActiveStateMachine{`0,`1}.InitializeMessage)">
|
636
|
+
<summary>
|
637
|
+
Initializes the state machine on the worker thread.
|
638
|
+
</summary>
|
639
|
+
<param name="message">The message containing the initial state.</param>
|
640
|
+
</member>
|
641
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.ToString">
|
642
|
+
<summary>
|
643
|
+
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
644
|
+
</summary>
|
645
|
+
<returns>
|
646
|
+
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
647
|
+
</returns>
|
648
|
+
</member>
|
649
|
+
<member name="E:bbv.Common.StateMachine.ActiveStateMachine`2.TransitionDeclined">
|
650
|
+
<summary>
|
651
|
+
Occurs when no transition could be executed.
|
652
|
+
</summary>
|
653
|
+
</member>
|
654
|
+
<member name="E:bbv.Common.StateMachine.ActiveStateMachine`2.ExceptionThrown">
|
655
|
+
<summary>
|
656
|
+
Occurs when an exception was thrown inside the state machine.
|
657
|
+
</summary>
|
658
|
+
</member>
|
659
|
+
<member name="E:bbv.Common.StateMachine.ActiveStateMachine`2.TransitionExceptionThrown">
|
660
|
+
<summary>
|
661
|
+
Occurs when an exception was thrown inside a transition of the state machine.
|
662
|
+
</summary>
|
663
|
+
</member>
|
664
|
+
<member name="E:bbv.Common.StateMachine.ActiveStateMachine`2.TransitionBegin">
|
665
|
+
<summary>
|
666
|
+
Occurs when a transition begins.
|
667
|
+
</summary>
|
668
|
+
</member>
|
669
|
+
<member name="E:bbv.Common.StateMachine.ActiveStateMachine`2.TransitionCompleted">
|
670
|
+
<summary>
|
671
|
+
Occurs when a transition completed.
|
672
|
+
</summary>
|
673
|
+
</member>
|
674
|
+
<member name="P:bbv.Common.StateMachine.ActiveStateMachine`2.IsRunning">
|
675
|
+
<summary>
|
676
|
+
Gets a value indicating whether this instance is running. The state machine is running if if was started and not yet stopped.
|
677
|
+
</summary>
|
678
|
+
<value><c>true</c> if this instance is running; otherwise, <c>false</c>.</value>
|
679
|
+
</member>
|
680
|
+
<member name="T:bbv.Common.StateMachine.ActiveStateMachine`2.InitializeMessage">
|
681
|
+
<summary>
|
682
|
+
Message used to communicate the state to initialize to the worker thread.
|
683
|
+
</summary>
|
684
|
+
</member>
|
685
|
+
<member name="M:bbv.Common.StateMachine.ActiveStateMachine`2.InitializeMessage.#ctor(`0)">
|
686
|
+
<summary>
|
687
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.ActiveStateMachine`2.InitializeMessage"/> class.
|
688
|
+
</summary>
|
689
|
+
<param name="initialState">The initial state.</param>
|
690
|
+
</member>
|
691
|
+
<member name="P:bbv.Common.StateMachine.ActiveStateMachine`2.InitializeMessage.InitialState">
|
692
|
+
<summary>
|
693
|
+
Gets the initial state.
|
694
|
+
</summary>
|
695
|
+
<value>The initial state.</value>
|
696
|
+
</member>
|
697
|
+
<member name="T:bbv.Common.StateMachine.Internals.ContextEventArgs`2">
|
698
|
+
<summary>
|
699
|
+
Event arguments holding context information.
|
700
|
+
</summary>
|
701
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
702
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
703
|
+
</member>
|
704
|
+
<member name="F:bbv.Common.StateMachine.Internals.ContextEventArgs`2.stateContext">
|
705
|
+
<summary>
|
706
|
+
The context.
|
707
|
+
</summary>
|
708
|
+
</member>
|
709
|
+
<member name="M:bbv.Common.StateMachine.Internals.ContextEventArgs`2.#ctor(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
710
|
+
<summary>
|
711
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.ContextEventArgs`2"/> class.
|
712
|
+
</summary>
|
713
|
+
<param name="stateContext">The event context.</param>
|
714
|
+
</member>
|
715
|
+
<member name="P:bbv.Common.StateMachine.Internals.ContextEventArgs`2.StateContext">
|
716
|
+
<summary>
|
717
|
+
Gets the event context.
|
718
|
+
</summary>
|
719
|
+
<value>The event context.</value>
|
720
|
+
</member>
|
721
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateMachineInitializer`2">
|
722
|
+
<summary>
|
723
|
+
Responsible for entering the initial state of the state machine.
|
724
|
+
All states up in the hierarchy are entered, too.
|
725
|
+
</summary>
|
726
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
727
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
728
|
+
</member>
|
729
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachineInitializer`2.initialState">
|
730
|
+
<summary>
|
731
|
+
The state to enter.
|
732
|
+
</summary>
|
733
|
+
</member>
|
734
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachineInitializer`2.stateContext">
|
735
|
+
<summary>
|
736
|
+
Context information of this operation.
|
737
|
+
</summary>
|
738
|
+
</member>
|
739
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineInitializer`2.#ctor(bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
740
|
+
<summary>
|
741
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateMachineInitializer`2"/> class.
|
742
|
+
</summary>
|
743
|
+
<param name="initialState">The initial state to enter.</param>
|
744
|
+
<param name="stateContext">The state context.</param>
|
745
|
+
</member>
|
746
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineInitializer`2.EnterInitialState">
|
747
|
+
<summary>
|
748
|
+
Enters the initial state by entering all states further up in the hierarchy.
|
749
|
+
</summary>
|
750
|
+
<returns>The entered state. The initial state or a sub state of the initial state.</returns>
|
751
|
+
</member>
|
752
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineInitializer`2.TraverseUpTheStateHierarchy">
|
753
|
+
<summary>
|
754
|
+
Traverses up the state hierarchy and build the stack of states.
|
755
|
+
</summary>
|
756
|
+
<returns>The stack containing all states up the state hierarchy.</returns>
|
757
|
+
</member>
|
758
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineInitializer`2.TraverseDownTheStateHierarchyAndEnterStates(System.Collections.Generic.Stack{bbv.Common.StateMachine.Internals.IState{`0,`1}})">
|
759
|
+
<summary>
|
760
|
+
Traverses down the state hierarchy and enter all states along.
|
761
|
+
</summary>
|
762
|
+
<param name="stack">The stack containing the state hierarchy.</param>
|
763
|
+
</member>
|
764
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateMachineReport`2">
|
765
|
+
<summary>
|
766
|
+
Creates reports of state machines.
|
767
|
+
</summary>
|
768
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
769
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
770
|
+
</member>
|
771
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineReport`2.Report(System.String,System.Collections.Generic.IEnumerable{bbv.Common.StateMachine.Internals.IState{`0,`1}},System.Nullable{`0})">
|
772
|
+
<summary>
|
773
|
+
Returns a string that describes this state machine.
|
774
|
+
</summary>
|
775
|
+
<param name="name">The name of the state machine.</param>
|
776
|
+
<param name="states">The states.</param>
|
777
|
+
<param name="initialStateId">The initial state id.</param>
|
778
|
+
<returns>Description of the state machine</returns>
|
779
|
+
</member>
|
780
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineReport`2.ReportState(bbv.Common.StateMachine.Internals.IState{`0,`1},System.Text.StringBuilder,System.String)">
|
781
|
+
<summary>
|
782
|
+
Creates the part of the report for the specified state.
|
783
|
+
</summary>
|
784
|
+
<param name="state">The state.</param>
|
785
|
+
<param name="report">The report to add to.</param>
|
786
|
+
<param name="indentation">The current indentation level.</param>
|
787
|
+
</member>
|
788
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineReport`2.ReportStateNameInitialStateHistoryTypeEntryAndExitAction(System.Text.StringBuilder,System.String,bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
789
|
+
<summary>
|
790
|
+
Reports the state name, initial state, history type, entry and exit action.
|
791
|
+
</summary>
|
792
|
+
<param name="report">The report.</param>
|
793
|
+
<param name="indentation">The current indentation.</param>
|
794
|
+
<param name="state">The state.</param>
|
795
|
+
</member>
|
796
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachineReport`2.ReportTransition(System.Text.StringBuilder,System.String,bbv.Common.StateMachine.Internals.TransitionDictionary{`0,`1}.TransitionInfo)">
|
797
|
+
<summary>
|
798
|
+
Reports the transition.
|
799
|
+
</summary>
|
800
|
+
<param name="report">The report.</param>
|
801
|
+
<param name="indentation">The indentation.</param>
|
802
|
+
<param name="transition">The transition.</param>
|
803
|
+
</member>
|
804
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateContext`2">
|
805
|
+
<summary>
|
806
|
+
Provides context information. Gathers information during executing operations on the state machine
|
807
|
+
</summary>
|
808
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
809
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
810
|
+
</member>
|
811
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateContext`2.state">
|
812
|
+
<summary>
|
813
|
+
The source state of the transition.
|
814
|
+
</summary>
|
815
|
+
</member>
|
816
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateContext`2.exceptions">
|
817
|
+
<summary>
|
818
|
+
The exceptions that occurred during performing an operation.
|
819
|
+
</summary>
|
820
|
+
</member>
|
821
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateContext`2.records">
|
822
|
+
<summary>
|
823
|
+
The list of records (state exits, entries)
|
824
|
+
</summary>
|
825
|
+
</member>
|
826
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.#ctor">
|
827
|
+
<summary>
|
828
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateContext`2"/> class.
|
829
|
+
</summary>
|
830
|
+
</member>
|
831
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.#ctor(bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.INotifier{`0,`1})">
|
832
|
+
<summary>
|
833
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateContext`2"/> class.
|
834
|
+
</summary>
|
835
|
+
<param name="state">The state.</param>
|
836
|
+
<param name="notifier">The notifier.</param>
|
837
|
+
</member>
|
838
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.AddRecord(`0,bbv.Common.StateMachine.Internals.StateContext{`0,`1}.RecordType)">
|
839
|
+
<summary>
|
840
|
+
Adds a record.
|
841
|
+
</summary>
|
842
|
+
<param name="stateId">The state id.</param>
|
843
|
+
<param name="recordType">Type of the record.</param>
|
844
|
+
</member>
|
845
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.GetRecords">
|
846
|
+
<summary>
|
847
|
+
Gets all records in string representation.
|
848
|
+
</summary>
|
849
|
+
<returns>All records in string representation.</returns>
|
850
|
+
</member>
|
851
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.OnExceptionThrown(System.Exception)">
|
852
|
+
<summary>
|
853
|
+
Called when an exception should be notified.
|
854
|
+
</summary>
|
855
|
+
<param name="exception">The exception.</param>
|
856
|
+
</member>
|
857
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.AddException(System.Exception)">
|
858
|
+
<summary>
|
859
|
+
Adds an exception.
|
860
|
+
</summary>
|
861
|
+
<param name="exception">The exception.</param>
|
862
|
+
</member>
|
863
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateContext`2.State">
|
864
|
+
<summary>
|
865
|
+
Gets the source state of the transition.
|
866
|
+
</summary>
|
867
|
+
<value>The state.</value>
|
868
|
+
</member>
|
869
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateContext`2.Exceptions">
|
870
|
+
<summary>
|
871
|
+
Gets the exceptions.
|
872
|
+
</summary>
|
873
|
+
<value>The exceptions.</value>
|
874
|
+
</member>
|
875
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateContext`2.Notifier">
|
876
|
+
<summary>
|
877
|
+
Gets the notifier.
|
878
|
+
</summary>
|
879
|
+
<value>The notifier.</value>
|
880
|
+
</member>
|
881
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateContext`2.RecordType">
|
882
|
+
<summary>
|
883
|
+
Specifies the type of the record.
|
884
|
+
</summary>
|
885
|
+
</member>
|
886
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateContext`2.RecordType.Enter">
|
887
|
+
<summary>
|
888
|
+
A state was entered.
|
889
|
+
</summary>
|
890
|
+
</member>
|
891
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateContext`2.RecordType.Exit">
|
892
|
+
<summary>
|
893
|
+
A state was exited.
|
894
|
+
</summary>
|
895
|
+
</member>
|
896
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateContext`2.Record">
|
897
|
+
<summary>
|
898
|
+
A record of a state exit or entry. Used to log the way taken by transitions and initialization.
|
899
|
+
</summary>
|
900
|
+
</member>
|
901
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.Record.#ctor(`0,bbv.Common.StateMachine.Internals.StateContext{`0,`1}.RecordType)">
|
902
|
+
<summary>
|
903
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateContext`2.Record"/> class.
|
904
|
+
</summary>
|
905
|
+
<param name="stateId">The state id.</param>
|
906
|
+
<param name="recordType">Type of the record.</param>
|
907
|
+
</member>
|
908
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateContext`2.Record.ToString">
|
909
|
+
<summary>
|
910
|
+
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
911
|
+
</summary>
|
912
|
+
<returns>
|
913
|
+
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
914
|
+
</returns>
|
915
|
+
</member>
|
916
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateContext`2.Record.StateId">
|
917
|
+
<summary>
|
918
|
+
Gets the state id.
|
919
|
+
</summary>
|
920
|
+
<value>The state id.</value>
|
921
|
+
</member>
|
922
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateContext`2.Record.RecordType">
|
923
|
+
<summary>
|
924
|
+
Gets the type of the record.
|
925
|
+
</summary>
|
926
|
+
<value>The type of the record.</value>
|
927
|
+
</member>
|
928
|
+
<member name="T:bbv.Common.StateMachine.Internals.EventInformation`1">
|
929
|
+
<summary>
|
930
|
+
Provides information about an event: event-id and arguments.
|
931
|
+
</summary>
|
932
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
933
|
+
</member>
|
934
|
+
<member name="M:bbv.Common.StateMachine.Internals.EventInformation`1.#ctor(`0,System.Object[])">
|
935
|
+
<summary>
|
936
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.EventInformation`1"/> class.
|
937
|
+
</summary>
|
938
|
+
<param name="eventId">The event id.</param>
|
939
|
+
<param name="eventArguments">The event arguments.</param>
|
940
|
+
</member>
|
941
|
+
<member name="P:bbv.Common.StateMachine.Internals.EventInformation`1.EventId">
|
942
|
+
<summary>
|
943
|
+
Gets the event id.
|
944
|
+
</summary>
|
945
|
+
<value>The event id.</value>
|
946
|
+
</member>
|
947
|
+
<member name="P:bbv.Common.StateMachine.Internals.EventInformation`1.EventArguments">
|
948
|
+
<summary>
|
949
|
+
Gets the event arguments.
|
950
|
+
</summary>
|
951
|
+
<value>The event arguments.</value>
|
952
|
+
</member>
|
953
|
+
<member name="T:bbv.Common.StateMachine.ExceptionEventArgs`2">
|
954
|
+
<summary>
|
955
|
+
Event arguments providing exception information.
|
956
|
+
</summary>
|
957
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
958
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
959
|
+
</member>
|
960
|
+
<member name="F:bbv.Common.StateMachine.ExceptionEventArgs`2.exception">
|
961
|
+
<summary>
|
962
|
+
The exception.
|
963
|
+
</summary>
|
964
|
+
</member>
|
965
|
+
<member name="M:bbv.Common.StateMachine.ExceptionEventArgs`2.#ctor(bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
966
|
+
<summary>
|
967
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.ExceptionEventArgs`2"/> class.
|
968
|
+
</summary>
|
969
|
+
<param name="stateContext">The event context.</param>
|
970
|
+
<param name="exception">The exception.</param>
|
971
|
+
</member>
|
972
|
+
<member name="P:bbv.Common.StateMachine.ExceptionEventArgs`2.Exception">
|
973
|
+
<summary>
|
974
|
+
Gets the exception.
|
975
|
+
</summary>
|
976
|
+
<value>The exception.</value>
|
977
|
+
</member>
|
978
|
+
<member name="T:bbv.Common.StateMachine.HistoryType">
|
979
|
+
<summary>
|
980
|
+
Defines the history behavior of a state (on re-entrance of a super state).
|
981
|
+
</summary>
|
982
|
+
</member>
|
983
|
+
<member name="F:bbv.Common.StateMachine.HistoryType.None">
|
984
|
+
<summary>
|
985
|
+
The state enters into its initial sub-state. The sub-state itself enters its initial sub-state and so on
|
986
|
+
until the innermost nested state is reached.
|
987
|
+
</summary>
|
988
|
+
</member>
|
989
|
+
<member name="F:bbv.Common.StateMachine.HistoryType.Shallow">
|
990
|
+
<summary>
|
991
|
+
The state enters into its last active sub-state. The sub-state itself enters its initial sub-state and so on
|
992
|
+
until the innermost nested state is reached.
|
993
|
+
</summary>
|
994
|
+
</member>
|
995
|
+
<member name="F:bbv.Common.StateMachine.HistoryType.Deep">
|
996
|
+
<summary>
|
997
|
+
The state enters into its last active sub-state. The sub-state itself enters into-its last active state and so on
|
998
|
+
until the innermost nested state is reached.
|
999
|
+
</summary>
|
1000
|
+
</member>
|
1001
|
+
<member name="T:bbv.Common.StateMachine.Internals.INotifier`2">
|
1002
|
+
<summary>
|
1003
|
+
Provides functionalities to notify events.
|
1004
|
+
</summary>
|
1005
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1006
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1007
|
+
</member>
|
1008
|
+
<member name="M:bbv.Common.StateMachine.Internals.INotifier`2.OnExceptionThrown(bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
1009
|
+
<summary>
|
1010
|
+
Called when an exception was thrown.
|
1011
|
+
</summary>
|
1012
|
+
<param name="stateContext">The context.</param>
|
1013
|
+
<param name="exception">The exception.</param>
|
1014
|
+
</member>
|
1015
|
+
<member name="M:bbv.Common.StateMachine.Internals.INotifier`2.OnExceptionThrown(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
1016
|
+
<summary>
|
1017
|
+
Called when an exception was thrown in a transition.
|
1018
|
+
</summary>
|
1019
|
+
<param name="context">The transition context.</param>
|
1020
|
+
<param name="exception">The exception.</param>
|
1021
|
+
</member>
|
1022
|
+
<member name="M:bbv.Common.StateMachine.Internals.INotifier`2.OnTransitionBegin(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
1023
|
+
<summary>
|
1024
|
+
Called before a transition is executed.
|
1025
|
+
</summary>
|
1026
|
+
<param name="context">The context.</param>
|
1027
|
+
</member>
|
1028
|
+
<member name="T:bbv.Common.StateMachine.Internals.IState`2">
|
1029
|
+
<summary>
|
1030
|
+
Represents a state of the state machine.
|
1031
|
+
</summary>
|
1032
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1033
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1034
|
+
</member>
|
1035
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.Fire(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
1036
|
+
<summary>
|
1037
|
+
Fires the specified event id on this state.
|
1038
|
+
</summary>
|
1039
|
+
<param name="context">The event context.</param>
|
1040
|
+
<returns>The result of the transition.</returns>
|
1041
|
+
</member>
|
1042
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.Entry(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1043
|
+
<summary>
|
1044
|
+
Enters this state.
|
1045
|
+
</summary>
|
1046
|
+
<param name="stateContext">The event context.</param>
|
1047
|
+
</member>
|
1048
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.Exit(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1049
|
+
<summary>
|
1050
|
+
Exits this state.
|
1051
|
+
</summary>
|
1052
|
+
<param name="stateContext">The event context.</param>
|
1053
|
+
</member>
|
1054
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.EnterByHistory(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1055
|
+
<summary>
|
1056
|
+
Enters this state by its history depending on <see cref="P:bbv.Common.StateMachine.Internals.State`2.HistoryType"/>.
|
1057
|
+
The <see cref="M:bbv.Common.StateMachine.Internals.State`2.Entry(bbv.Common.StateMachine.Internals.StateContext{`0,`1})"/> method has to be called already.
|
1058
|
+
</summary>
|
1059
|
+
<param name="stateContext">The event context.</param>
|
1060
|
+
<returns>
|
1061
|
+
The active state (depends on <see cref="P:bbv.Common.StateMachine.Internals.State`2.HistoryType"/>.
|
1062
|
+
</returns>
|
1063
|
+
</member>
|
1064
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.EnterShallow(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1065
|
+
<summary>
|
1066
|
+
Enters this state is shallow mode:
|
1067
|
+
The entry action is executed and the initial state is entered in shallow mode if there is one.
|
1068
|
+
</summary>
|
1069
|
+
<param name="stateContext">The event context.</param>
|
1070
|
+
<returns>The active state.</returns>
|
1071
|
+
</member>
|
1072
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.EnterDeep(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1073
|
+
<summary>
|
1074
|
+
Enters this state is deep mode:
|
1075
|
+
The entry action is executed and the initial state is entered in deep mode if there is one.
|
1076
|
+
</summary>
|
1077
|
+
<param name="stateContext">The event context.</param>
|
1078
|
+
<returns>The active state.</returns>
|
1079
|
+
</member>
|
1080
|
+
<member name="M:bbv.Common.StateMachine.Internals.IState`2.ToString">
|
1081
|
+
<summary>
|
1082
|
+
Returns a <see cref="T:System.String"/> that represents this instance.
|
1083
|
+
</summary>
|
1084
|
+
<returns>
|
1085
|
+
A <see cref="T:System.String"/> that represents this instance.
|
1086
|
+
</returns>
|
1087
|
+
</member>
|
1088
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.Id">
|
1089
|
+
<summary>
|
1090
|
+
Gets the id of this state.
|
1091
|
+
</summary>
|
1092
|
+
<value>The id of this state.</value>
|
1093
|
+
</member>
|
1094
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.InitialState">
|
1095
|
+
<summary>
|
1096
|
+
Gets or sets the initial sub-state. Null if this state has no sub-states.
|
1097
|
+
</summary>
|
1098
|
+
<value>The initial sub-state. Null if this state has no sub-states.</value>
|
1099
|
+
</member>
|
1100
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.SuperState">
|
1101
|
+
<summary>
|
1102
|
+
Gets or sets the super-state. Null if this is a root state.
|
1103
|
+
</summary>
|
1104
|
+
<value>The super-state.</value>
|
1105
|
+
</member>
|
1106
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.SubStates">
|
1107
|
+
<summary>
|
1108
|
+
Gets the sub-states.
|
1109
|
+
</summary>
|
1110
|
+
<value>The sub-states.</value>
|
1111
|
+
</member>
|
1112
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.Transitions">
|
1113
|
+
<summary>
|
1114
|
+
Gets the transitions.
|
1115
|
+
</summary>
|
1116
|
+
<value>The transitions.</value>
|
1117
|
+
</member>
|
1118
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.Level">
|
1119
|
+
<summary>
|
1120
|
+
Gets or sets the level in the hierarchy.
|
1121
|
+
</summary>
|
1122
|
+
<value>The level in the hierarchy.</value>
|
1123
|
+
</member>
|
1124
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.LastActiveState">
|
1125
|
+
<summary>
|
1126
|
+
Gets or sets the last active state of this state.
|
1127
|
+
</summary>
|
1128
|
+
<value>The last state of the active.</value>
|
1129
|
+
</member>
|
1130
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.EntryAction">
|
1131
|
+
<summary>
|
1132
|
+
Gets or sets the entry action.
|
1133
|
+
</summary>
|
1134
|
+
<value>The entry action.</value>
|
1135
|
+
</member>
|
1136
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.ExitAction">
|
1137
|
+
<summary>
|
1138
|
+
Gets or sets the exit action.
|
1139
|
+
</summary>
|
1140
|
+
<value>The exit action.</value>
|
1141
|
+
</member>
|
1142
|
+
<member name="P:bbv.Common.StateMachine.Internals.IState`2.HistoryType">
|
1143
|
+
<summary>
|
1144
|
+
Gets or sets the history type of this state.
|
1145
|
+
</summary>
|
1146
|
+
<value>The type of the history.</value>
|
1147
|
+
</member>
|
1148
|
+
<member name="T:bbv.Common.StateMachine.Internals.IStateDictionary`2">
|
1149
|
+
<summary>
|
1150
|
+
Manages the states of a state machine.
|
1151
|
+
</summary>
|
1152
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1153
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1154
|
+
</member>
|
1155
|
+
<member name="M:bbv.Common.StateMachine.Internals.IStateDictionary`2.GetStates">
|
1156
|
+
<summary>
|
1157
|
+
Gets all states defined in this dictionary.
|
1158
|
+
</summary>
|
1159
|
+
<returns>All states in this directory.</returns>
|
1160
|
+
</member>
|
1161
|
+
<member name="P:bbv.Common.StateMachine.Internals.IStateDictionary`2.Item(`0)">
|
1162
|
+
<summary>
|
1163
|
+
Gets the <see cref="T:bbv.Common.StateMachine.Internals.IState`2"/> with the specified state id.
|
1164
|
+
</summary>
|
1165
|
+
<value>State with the specified id.</value>
|
1166
|
+
<param name="stateId">The State id.</param>
|
1167
|
+
</member>
|
1168
|
+
<member name="T:bbv.Common.StateMachine.Internals.IEntryActionSyntax`2">
|
1169
|
+
<summary>
|
1170
|
+
Defines the entry action syntax.
|
1171
|
+
</summary>
|
1172
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1173
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1174
|
+
</member>
|
1175
|
+
<member name="T:bbv.Common.StateMachine.Internals.IExitActionSyntax`2">
|
1176
|
+
<summary>
|
1177
|
+
Defines the exit action syntax.
|
1178
|
+
</summary>
|
1179
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1180
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1181
|
+
</member>
|
1182
|
+
<member name="T:bbv.Common.StateMachine.Internals.IEventSyntax`2">
|
1183
|
+
<summary>
|
1184
|
+
Defines the event syntax.
|
1185
|
+
</summary>
|
1186
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1187
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1188
|
+
</member>
|
1189
|
+
<member name="M:bbv.Common.StateMachine.Internals.IEventSyntax`2.On(`1)">
|
1190
|
+
<summary>
|
1191
|
+
Defines an event that is accepted.
|
1192
|
+
</summary>
|
1193
|
+
<param name="eventId">The event id.</param>
|
1194
|
+
<returns>Event action syntax.</returns>
|
1195
|
+
</member>
|
1196
|
+
<member name="M:bbv.Common.StateMachine.Internals.IExitActionSyntax`2.ExecuteOnExit(System.Action)">
|
1197
|
+
<summary>
|
1198
|
+
Defines an exit action.
|
1199
|
+
</summary>
|
1200
|
+
<param name="action">The action.</param>
|
1201
|
+
<returns>Event syntax.</returns>
|
1202
|
+
</member>
|
1203
|
+
<member name="M:bbv.Common.StateMachine.Internals.IExitActionSyntax`2.ExecuteOnExit``1(System.Action{``0},``0)">
|
1204
|
+
<summary>
|
1205
|
+
Defines an exit action.
|
1206
|
+
</summary>
|
1207
|
+
<typeparam name="T">Type of the parameter of the exit action method.</typeparam>
|
1208
|
+
<param name="action">The action.</param>
|
1209
|
+
<param name="parameter">The parameter that will be passed to the exit action.</param>
|
1210
|
+
<returns>Exit action syntax.</returns>
|
1211
|
+
</member>
|
1212
|
+
<member name="M:bbv.Common.StateMachine.Internals.IEntryActionSyntax`2.ExecuteOnEntry(System.Action)">
|
1213
|
+
<summary>
|
1214
|
+
Defines an entry action.
|
1215
|
+
</summary>
|
1216
|
+
<param name="action">The action.</param>
|
1217
|
+
<returns>Exit action syntax.</returns>
|
1218
|
+
</member>
|
1219
|
+
<member name="M:bbv.Common.StateMachine.Internals.IEntryActionSyntax`2.ExecuteOnEntry``1(System.Action{``0},``0)">
|
1220
|
+
<summary>
|
1221
|
+
Defines an entry action.
|
1222
|
+
</summary>
|
1223
|
+
<typeparam name="T">Type of the parameter of the entry action method.</typeparam>
|
1224
|
+
<param name="action">The action.</param>
|
1225
|
+
<param name="parameter">The parameter that will be passed to the entry action.</param>
|
1226
|
+
<returns>Exit action syntax.</returns>
|
1227
|
+
</member>
|
1228
|
+
<member name="T:bbv.Common.StateMachine.Internals.IGotoSyntax`2">
|
1229
|
+
<summary>
|
1230
|
+
Defines the goto syntax.
|
1231
|
+
</summary>
|
1232
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1233
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1234
|
+
</member>
|
1235
|
+
<member name="M:bbv.Common.StateMachine.Internals.IGotoSyntax`2.Goto(`0)">
|
1236
|
+
<summary>
|
1237
|
+
Defines where to go in response to an event.
|
1238
|
+
</summary>
|
1239
|
+
<param name="target">The target.</param>
|
1240
|
+
<returns>Execute syntax.</returns>
|
1241
|
+
</member>
|
1242
|
+
<member name="T:bbv.Common.StateMachine.Internals.IExecuteSyntax`2">
|
1243
|
+
<summary>
|
1244
|
+
Defines the execute syntax.
|
1245
|
+
</summary>
|
1246
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1247
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1248
|
+
</member>
|
1249
|
+
<member name="T:bbv.Common.StateMachine.Internals.IGuardSyntax`2">
|
1250
|
+
<summary>
|
1251
|
+
Defines the guard syntax.
|
1252
|
+
</summary>
|
1253
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1254
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1255
|
+
</member>
|
1256
|
+
<member name="M:bbv.Common.StateMachine.Internals.IGuardSyntax`2.OnlyIf(System.Func{System.Object[],System.Boolean})">
|
1257
|
+
<summary>
|
1258
|
+
Defines a guard for a transition.
|
1259
|
+
</summary>
|
1260
|
+
<param name="guard">The guard.</param>
|
1261
|
+
<returns>Event syntax.</returns>
|
1262
|
+
</member>
|
1263
|
+
<member name="M:bbv.Common.StateMachine.Internals.IExecuteSyntax`2.Execute(System.Action{System.Object[]}[])">
|
1264
|
+
<summary>
|
1265
|
+
Defines the actions to execute on a transition.
|
1266
|
+
</summary>
|
1267
|
+
<param name="actions">The actions.</param>
|
1268
|
+
<returns>Guard syntax.</returns>
|
1269
|
+
</member>
|
1270
|
+
<member name="T:bbv.Common.StateMachine.Internals.IEventActionSyntax`2">
|
1271
|
+
<summary>
|
1272
|
+
Defines the action syntax.
|
1273
|
+
</summary>
|
1274
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1275
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1276
|
+
</member>
|
1277
|
+
<member name="M:bbv.Common.StateMachine.Internals.IEventActionSyntax`2.Goto(`0)">
|
1278
|
+
<summary>
|
1279
|
+
Defines where to go in response to an event.
|
1280
|
+
</summary>
|
1281
|
+
<param name="target">The target.</param>
|
1282
|
+
<returns>Execute syntax.</returns>
|
1283
|
+
</member>
|
1284
|
+
<member name="M:bbv.Common.StateMachine.Internals.IEventActionSyntax`2.Execute(System.Action{System.Object[]}[])">
|
1285
|
+
<summary>
|
1286
|
+
Defines the actions to execute on a transition.
|
1287
|
+
</summary>
|
1288
|
+
<param name="actions">The actions.</param>
|
1289
|
+
<returns>Guard syntax.</returns>
|
1290
|
+
</member>
|
1291
|
+
<member name="T:bbv.Common.StateMachine.Internals.ITransition`2">
|
1292
|
+
<summary>
|
1293
|
+
Represents a transition in the state machine.
|
1294
|
+
</summary>
|
1295
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1296
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1297
|
+
</member>
|
1298
|
+
<member name="M:bbv.Common.StateMachine.Internals.ITransition`2.Fire(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
1299
|
+
<summary>
|
1300
|
+
Fires the transition.
|
1301
|
+
</summary>
|
1302
|
+
<param name="context">The event context.</param>
|
1303
|
+
<returns>The result of the transition.</returns>
|
1304
|
+
</member>
|
1305
|
+
<member name="P:bbv.Common.StateMachine.Internals.ITransition`2.Source">
|
1306
|
+
<summary>
|
1307
|
+
Gets or sets the source state of the transition.
|
1308
|
+
</summary>
|
1309
|
+
<value>The source.</value>
|
1310
|
+
</member>
|
1311
|
+
<member name="P:bbv.Common.StateMachine.Internals.ITransition`2.Target">
|
1312
|
+
<summary>
|
1313
|
+
Gets or sets the target state of the transition.
|
1314
|
+
</summary>
|
1315
|
+
<value>The target.</value>
|
1316
|
+
</member>
|
1317
|
+
<member name="P:bbv.Common.StateMachine.Internals.ITransition`2.Actions">
|
1318
|
+
<summary>
|
1319
|
+
Gets the actions of this transaction.
|
1320
|
+
</summary>
|
1321
|
+
<value>The actions.</value>
|
1322
|
+
</member>
|
1323
|
+
<member name="P:bbv.Common.StateMachine.Internals.ITransition`2.Guard">
|
1324
|
+
<summary>
|
1325
|
+
Gets or sets the guard of this transition.
|
1326
|
+
</summary>
|
1327
|
+
<value>The guard.</value>
|
1328
|
+
</member>
|
1329
|
+
<member name="T:bbv.Common.StateMachine.Internals.ITransitionResult`2">
|
1330
|
+
<summary>
|
1331
|
+
Represents the result of a transition.
|
1332
|
+
</summary>
|
1333
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1334
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1335
|
+
</member>
|
1336
|
+
<member name="P:bbv.Common.StateMachine.Internals.ITransitionResult`2.Fired">
|
1337
|
+
<summary>
|
1338
|
+
Gets a value indicating whether this <see cref="T:bbv.Common.StateMachine.Internals.ITransitionResult`2"/> is fired.
|
1339
|
+
</summary>
|
1340
|
+
<value><c>true</c> if fired; otherwise, <c>false</c>.</value>
|
1341
|
+
</member>
|
1342
|
+
<member name="P:bbv.Common.StateMachine.Internals.ITransitionResult`2.NewState">
|
1343
|
+
<summary>
|
1344
|
+
Gets the new state.
|
1345
|
+
</summary>
|
1346
|
+
<value>The new state.</value>
|
1347
|
+
</member>
|
1348
|
+
<member name="T:bbv.Common.StateMachine.PassiveStateMachine`2">
|
1349
|
+
<summary>
|
1350
|
+
A passive state machine.
|
1351
|
+
This state machine reacts to events on the current thread.
|
1352
|
+
</summary>
|
1353
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1354
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1355
|
+
</member>
|
1356
|
+
<member name="F:bbv.Common.StateMachine.PassiveStateMachine`2.stateMachine">
|
1357
|
+
<summary>
|
1358
|
+
The internal state machine.
|
1359
|
+
</summary>
|
1360
|
+
</member>
|
1361
|
+
<member name="F:bbv.Common.StateMachine.PassiveStateMachine`2.events">
|
1362
|
+
<summary>
|
1363
|
+
List of all queued events.
|
1364
|
+
</summary>
|
1365
|
+
</member>
|
1366
|
+
<member name="F:bbv.Common.StateMachine.PassiveStateMachine`2.executing">
|
1367
|
+
<summary>
|
1368
|
+
Whether this state machine is executing an event. Allows that events can be added while executing.
|
1369
|
+
</summary>
|
1370
|
+
</member>
|
1371
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.#ctor">
|
1372
|
+
<summary>
|
1373
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.PassiveStateMachine`2"/> class.
|
1374
|
+
</summary>
|
1375
|
+
</member>
|
1376
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.#ctor(System.String)">
|
1377
|
+
<summary>
|
1378
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.PassiveStateMachine`2"/> class.
|
1379
|
+
</summary>
|
1380
|
+
<param name="name">The name of the state machine. Used in log messages.</param>
|
1381
|
+
</member>
|
1382
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.#ctor(System.String,bbv.Common.StateMachine.Internals.IFactory{`0,`1})">
|
1383
|
+
<summary>
|
1384
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.PassiveStateMachine`2"/> class.
|
1385
|
+
</summary>
|
1386
|
+
<param name="name">The name of the state machine. Used in log messages.</param>
|
1387
|
+
<param name="factory">The factory.</param>
|
1388
|
+
</member>
|
1389
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.In(`0)">
|
1390
|
+
<summary>
|
1391
|
+
Define the behavior of a state.
|
1392
|
+
</summary>
|
1393
|
+
<param name="state">The state.</param>
|
1394
|
+
<returns>Syntax to build state behavior.</returns>
|
1395
|
+
</member>
|
1396
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.DefineHierarchyOn(`0,`0,bbv.Common.StateMachine.HistoryType,`0[])">
|
1397
|
+
<summary>
|
1398
|
+
Defines a state hierarchy.
|
1399
|
+
</summary>
|
1400
|
+
<param name="superStateId">The super state id.</param>
|
1401
|
+
<param name="initialSubStateId">The initial state id.</param>
|
1402
|
+
<param name="historyType">Type of the history.</param>
|
1403
|
+
<param name="subStateIds">The sub state ids.</param>
|
1404
|
+
</member>
|
1405
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.Fire(`1,System.Object[])">
|
1406
|
+
<summary>
|
1407
|
+
Fires the specified event.
|
1408
|
+
</summary>
|
1409
|
+
<param name="eventId">The event.</param>
|
1410
|
+
<param name="eventArguments">The event arguments.</param>
|
1411
|
+
</member>
|
1412
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.FirePriority(`1,System.Object[])">
|
1413
|
+
<summary>
|
1414
|
+
Fires the specified priority event. The event will be handled before any already queued event.
|
1415
|
+
</summary>
|
1416
|
+
<param name="eventId">The event.</param>
|
1417
|
+
<param name="eventArguments">The event arguments.</param>
|
1418
|
+
</member>
|
1419
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.Initialize(`0)">
|
1420
|
+
<summary>
|
1421
|
+
Initializes the state machine to the specified initial state.
|
1422
|
+
</summary>
|
1423
|
+
<param name="initialState">The state to which the state machine is initialized.</param>
|
1424
|
+
</member>
|
1425
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.Start">
|
1426
|
+
<summary>
|
1427
|
+
Starts the state machine. Events will be processed.
|
1428
|
+
If the state machine is not started then the events will be queued until the state machine is started.
|
1429
|
+
Already queued events are processed.
|
1430
|
+
</summary>
|
1431
|
+
</member>
|
1432
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.Stop">
|
1433
|
+
<summary>
|
1434
|
+
Stops the state machine. Events will be queued until the state machine is started.
|
1435
|
+
</summary>
|
1436
|
+
</member>
|
1437
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.AddExtension(bbv.Common.StateMachine.IExtension{`0,`1})">
|
1438
|
+
<summary>
|
1439
|
+
Adds an extension.
|
1440
|
+
</summary>
|
1441
|
+
<param name="extension">The extension.</param>
|
1442
|
+
</member>
|
1443
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.ClearExtensions">
|
1444
|
+
<summary>
|
1445
|
+
Clears all extensions.
|
1446
|
+
</summary>
|
1447
|
+
</member>
|
1448
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.Report">
|
1449
|
+
<summary>
|
1450
|
+
Returns a report of this state machine with all states and transitions.
|
1451
|
+
</summary>
|
1452
|
+
<returns>A string containing a report of this state machine with all states and transitions.</returns>
|
1453
|
+
</member>
|
1454
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.Execute">
|
1455
|
+
<summary>
|
1456
|
+
Executes all queued events.
|
1457
|
+
</summary>
|
1458
|
+
</member>
|
1459
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.ProcessQueuedEvents">
|
1460
|
+
<summary>
|
1461
|
+
Processes the queued events.
|
1462
|
+
</summary>
|
1463
|
+
</member>
|
1464
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.GetNextEventToProcess">
|
1465
|
+
<summary>
|
1466
|
+
Gets the next event to process for the queue.
|
1467
|
+
</summary>
|
1468
|
+
<returns>The next queued event.</returns>
|
1469
|
+
</member>
|
1470
|
+
<member name="M:bbv.Common.StateMachine.PassiveStateMachine`2.FireEventOnStateMachine(bbv.Common.StateMachine.Internals.EventInformation{`1})">
|
1471
|
+
<summary>
|
1472
|
+
Fires the event on state machine.
|
1473
|
+
</summary>
|
1474
|
+
<param name="e">The event to fire.</param>
|
1475
|
+
</member>
|
1476
|
+
<member name="E:bbv.Common.StateMachine.PassiveStateMachine`2.TransitionDeclined">
|
1477
|
+
<summary>
|
1478
|
+
Occurs when no transition could be executed.
|
1479
|
+
</summary>
|
1480
|
+
</member>
|
1481
|
+
<member name="E:bbv.Common.StateMachine.PassiveStateMachine`2.ExceptionThrown">
|
1482
|
+
<summary>
|
1483
|
+
Occurs when an exception was thrown inside the state machine.
|
1484
|
+
</summary>
|
1485
|
+
</member>
|
1486
|
+
<member name="E:bbv.Common.StateMachine.PassiveStateMachine`2.TransitionExceptionThrown">
|
1487
|
+
<summary>
|
1488
|
+
Occurs when an exception was thrown inside a transition of the state machine.
|
1489
|
+
</summary>
|
1490
|
+
</member>
|
1491
|
+
<member name="E:bbv.Common.StateMachine.PassiveStateMachine`2.TransitionBegin">
|
1492
|
+
<summary>
|
1493
|
+
Occurs when a transition begins.
|
1494
|
+
</summary>
|
1495
|
+
</member>
|
1496
|
+
<member name="E:bbv.Common.StateMachine.PassiveStateMachine`2.TransitionCompleted">
|
1497
|
+
<summary>
|
1498
|
+
Occurs when a transition completed.
|
1499
|
+
</summary>
|
1500
|
+
</member>
|
1501
|
+
<member name="P:bbv.Common.StateMachine.PassiveStateMachine`2.IsRunning">
|
1502
|
+
<summary>
|
1503
|
+
Gets a value indicating whether this instance is running. The state machine is running if if was started and not yet stopped.
|
1504
|
+
</summary>
|
1505
|
+
<value><c>true</c> if this instance is running; otherwise, <c>false</c>.</value>
|
1506
|
+
</member>
|
1507
|
+
<member name="T:bbv.Common.StateMachine.Internals.State`2">
|
1508
|
+
<summary>
|
1509
|
+
A state of the state machine.
|
1510
|
+
A state can be a sub-state or super-state of another state.
|
1511
|
+
</summary>
|
1512
|
+
<typeparam name="TState">The type of the state id.</typeparam>
|
1513
|
+
<typeparam name="TEvent">The type of the event id.</typeparam>
|
1514
|
+
</member>
|
1515
|
+
<member name="F:bbv.Common.StateMachine.Internals.State`2.subStates">
|
1516
|
+
<summary>
|
1517
|
+
Collection of the sub-states of this state.
|
1518
|
+
</summary>
|
1519
|
+
</member>
|
1520
|
+
<member name="F:bbv.Common.StateMachine.Internals.State`2.transitions">
|
1521
|
+
<summary>
|
1522
|
+
Collection of transitions that start in this state (<see cref="P:bbv.Common.StateMachine.Internals.ITransition`2.Source"/> is equal to this state).
|
1523
|
+
</summary>
|
1524
|
+
</member>
|
1525
|
+
<member name="F:bbv.Common.StateMachine.Internals.State`2.level">
|
1526
|
+
<summary>
|
1527
|
+
The level of this state within the state hierarchy [1..maxLevel]
|
1528
|
+
</summary>
|
1529
|
+
</member>
|
1530
|
+
<member name="F:bbv.Common.StateMachine.Internals.State`2.superState">
|
1531
|
+
<summary>
|
1532
|
+
The super-state of this state. Null for states with <see cref="F:bbv.Common.StateMachine.Internals.State`2.level"/> equal to 1.
|
1533
|
+
</summary>
|
1534
|
+
</member>
|
1535
|
+
<member name="F:bbv.Common.StateMachine.Internals.State`2.initialState">
|
1536
|
+
<summary>
|
1537
|
+
The initial sub-state of this state.
|
1538
|
+
</summary>
|
1539
|
+
</member>
|
1540
|
+
<member name="F:bbv.Common.StateMachine.Internals.State`2.historyType">
|
1541
|
+
<summary>
|
1542
|
+
The <see cref="P:bbv.Common.StateMachine.Internals.State`2.HistoryType"/> of this state.
|
1543
|
+
</summary>
|
1544
|
+
</member>
|
1545
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.#ctor(`0,bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IExtensionHost{`0,`1})">
|
1546
|
+
<summary>
|
1547
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.State`2"/> class.
|
1548
|
+
</summary>
|
1549
|
+
<param name="id">The unique id of this state.</param>
|
1550
|
+
<param name="stateMachineInformation">The state machine information.</param>
|
1551
|
+
<param name="extensionHost">The extension host.</param>
|
1552
|
+
</member>
|
1553
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.Fire(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
1554
|
+
<summary>
|
1555
|
+
Goes recursively up the state hierarchy until a state is found that can handle the event.
|
1556
|
+
</summary>
|
1557
|
+
<param name="context">The event context.</param>
|
1558
|
+
<returns>The result of the transition.</returns>
|
1559
|
+
</member>
|
1560
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.Entry(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1561
|
+
<summary>
|
1562
|
+
Enters this state.
|
1563
|
+
</summary>
|
1564
|
+
<param name="stateContext">The event context.</param>
|
1565
|
+
</member>
|
1566
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.Exit(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1567
|
+
<summary>
|
1568
|
+
Exits this state, executes the exit action and sets the <see cref="P:bbv.Common.StateMachine.Internals.State`2.LastActiveState"/> on the super-state.
|
1569
|
+
</summary>
|
1570
|
+
<param name="stateContext">The event context.</param>
|
1571
|
+
</member>
|
1572
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.EnterByHistory(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1573
|
+
<summary>
|
1574
|
+
Enters this state by its history depending on <see cref="P:bbv.Common.StateMachine.Internals.State`2.HistoryType"/>.
|
1575
|
+
The <see cref="M:bbv.Common.StateMachine.Internals.State`2.Entry(bbv.Common.StateMachine.Internals.StateContext{`0,`1})"/> method has to be called already.
|
1576
|
+
</summary>
|
1577
|
+
<param name="stateContext">The event context.</param>
|
1578
|
+
<returns>
|
1579
|
+
The active state (depends on <see cref="P:bbv.Common.StateMachine.Internals.State`2.HistoryType"/>.
|
1580
|
+
</returns>
|
1581
|
+
</member>
|
1582
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.EnterShallow(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1583
|
+
<summary>
|
1584
|
+
Enters this state is shallow mode:
|
1585
|
+
The entry action is executed and the initial state is entered in shallow mode if there is one.
|
1586
|
+
</summary>
|
1587
|
+
<param name="stateContext">The event context.</param>
|
1588
|
+
<returns>The entered state.</returns>
|
1589
|
+
</member>
|
1590
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.EnterDeep(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1591
|
+
<summary>
|
1592
|
+
Enters this state is deep mode:
|
1593
|
+
The entry action is executed and the initial state is entered in deep mode if there is one.
|
1594
|
+
</summary>
|
1595
|
+
<param name="stateContext">The event context.</param>
|
1596
|
+
<returns>The active state.</returns>
|
1597
|
+
</member>
|
1598
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.ToString">
|
1599
|
+
<summary>
|
1600
|
+
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
1601
|
+
</summary>
|
1602
|
+
<returns>
|
1603
|
+
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
1604
|
+
</returns>
|
1605
|
+
</member>
|
1606
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.SetInitialLevel">
|
1607
|
+
<summary>
|
1608
|
+
Sets the initial level depending on the level of the super state of this instance.
|
1609
|
+
</summary>
|
1610
|
+
</member>
|
1611
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.SetLevelOfSubStates">
|
1612
|
+
<summary>
|
1613
|
+
Sets the level of all sub states.
|
1614
|
+
</summary>
|
1615
|
+
</member>
|
1616
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.ExecuteEntryAction(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1617
|
+
<summary>
|
1618
|
+
Executes the entry action.
|
1619
|
+
</summary>
|
1620
|
+
<param name="stateContext">The state context.</param>
|
1621
|
+
</member>
|
1622
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.ExecuteExitAction(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1623
|
+
<summary>
|
1624
|
+
Executes the exit action.
|
1625
|
+
</summary>
|
1626
|
+
<param name="stateContext">The state context.</param>
|
1627
|
+
</member>
|
1628
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.HandleException(System.Exception,bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1629
|
+
<summary>
|
1630
|
+
Handles the specified exception.
|
1631
|
+
</summary>
|
1632
|
+
<param name="exception">The exception.</param>
|
1633
|
+
<param name="stateContext">The state context.</param>
|
1634
|
+
</member>
|
1635
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.SetThisStateAsLastStateOfSuperState">
|
1636
|
+
<summary>
|
1637
|
+
Sets this instance as the last state of this instance's super state.
|
1638
|
+
</summary>
|
1639
|
+
</member>
|
1640
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.EnterHistoryDeep(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1641
|
+
<summary>
|
1642
|
+
Enters this instance with history type = deep.
|
1643
|
+
</summary>
|
1644
|
+
<param name="stateContext">The state context.</param>
|
1645
|
+
<returns>The entered state.</returns>
|
1646
|
+
</member>
|
1647
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.EnterHistoryShallow(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1648
|
+
<summary>
|
1649
|
+
Enters this instance with history type = shallow.
|
1650
|
+
</summary>
|
1651
|
+
<param name="stateContext">The state context.</param>
|
1652
|
+
<returns>The entered state.</returns>
|
1653
|
+
</member>
|
1654
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.EnterHistoryNone(bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
1655
|
+
<summary>
|
1656
|
+
Enters this instance with history type = none.
|
1657
|
+
</summary>
|
1658
|
+
<param name="stateContext">The state context.</param>
|
1659
|
+
<returns>The entered state.</returns>
|
1660
|
+
</member>
|
1661
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.CheckSuperStateIsNotThisInstance(bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
1662
|
+
<summary>
|
1663
|
+
Throws an exception if the new super state is this instance.
|
1664
|
+
</summary>
|
1665
|
+
<param name="newSuperState">The value.</param>
|
1666
|
+
</member>
|
1667
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.CheckInitialStateIsNotThisInstance(bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
1668
|
+
<summary>
|
1669
|
+
Throws an exception if the new initial state is this instance.
|
1670
|
+
</summary>
|
1671
|
+
<param name="newInitialState">The value.</param>
|
1672
|
+
</member>
|
1673
|
+
<member name="M:bbv.Common.StateMachine.Internals.State`2.CheckInitialStateIsASubState(bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
1674
|
+
<summary>
|
1675
|
+
Throws an exception if the new initial state is not a sub-state of this instance.
|
1676
|
+
</summary>
|
1677
|
+
<param name="value">The value.</param>
|
1678
|
+
</member>
|
1679
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.LastActiveState">
|
1680
|
+
<summary>
|
1681
|
+
Gets or sets the last active state of this state.
|
1682
|
+
</summary>
|
1683
|
+
<value>The last state of the active.</value>
|
1684
|
+
</member>
|
1685
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.Id">
|
1686
|
+
<summary>
|
1687
|
+
Gets the unique id of this state.
|
1688
|
+
</summary>
|
1689
|
+
<value>The id of this state.</value>
|
1690
|
+
</member>
|
1691
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.EntryAction">
|
1692
|
+
<summary>
|
1693
|
+
Gets or sets the entry action.
|
1694
|
+
</summary>
|
1695
|
+
<value>The entry action.</value>
|
1696
|
+
</member>
|
1697
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.ExitAction">
|
1698
|
+
<summary>
|
1699
|
+
Gets or sets the exit action.
|
1700
|
+
</summary>
|
1701
|
+
<value>The exit action.</value>
|
1702
|
+
</member>
|
1703
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.InitialState">
|
1704
|
+
<summary>
|
1705
|
+
Gets or sets the initial sub state of this state.
|
1706
|
+
</summary>
|
1707
|
+
<value>The initial sub state of this state.</value>
|
1708
|
+
</member>
|
1709
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.SuperState">
|
1710
|
+
<summary>
|
1711
|
+
Gets or sets the super-state of this state.
|
1712
|
+
</summary>
|
1713
|
+
<remarks>
|
1714
|
+
The <see cref="P:bbv.Common.StateMachine.Internals.State`2.Level"/> of this state is changed accordingly to the super-state.
|
1715
|
+
</remarks>
|
1716
|
+
<value>The super-state of this super.</value>
|
1717
|
+
</member>
|
1718
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.Level">
|
1719
|
+
<summary>
|
1720
|
+
Gets or sets the level of this state in the state hierarchy.
|
1721
|
+
When set then the levels of all sub-states are changed accordingly.
|
1722
|
+
</summary>
|
1723
|
+
<value>The level.</value>
|
1724
|
+
</member>
|
1725
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.HistoryType">
|
1726
|
+
<summary>
|
1727
|
+
Gets or sets the history type of this state.
|
1728
|
+
</summary>
|
1729
|
+
<value>The type of the history.</value>
|
1730
|
+
</member>
|
1731
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.SubStates">
|
1732
|
+
<summary>
|
1733
|
+
Gets the sub-states of this state.
|
1734
|
+
</summary>
|
1735
|
+
<value>The sub-states of this state.</value>
|
1736
|
+
</member>
|
1737
|
+
<member name="P:bbv.Common.StateMachine.Internals.State`2.Transitions">
|
1738
|
+
<summary>
|
1739
|
+
Gets the transitions that start in this state.
|
1740
|
+
</summary>
|
1741
|
+
<value>The transitions.</value>
|
1742
|
+
</member>
|
1743
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateBuilder`2">
|
1744
|
+
<summary>
|
1745
|
+
Provides operations to build a state machine.
|
1746
|
+
</summary>
|
1747
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1748
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1749
|
+
</member>
|
1750
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateBuilder`2.state">
|
1751
|
+
<summary>
|
1752
|
+
The state on which is operated.
|
1753
|
+
</summary>
|
1754
|
+
</member>
|
1755
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateBuilder`2.stateDictionary">
|
1756
|
+
<summary>
|
1757
|
+
The state dictionary of the state machine.
|
1758
|
+
</summary>
|
1759
|
+
</member>
|
1760
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateBuilder`2.currentTransition">
|
1761
|
+
<summary>
|
1762
|
+
The transition on which is operated. Null if no current transition.
|
1763
|
+
</summary>
|
1764
|
+
</member>
|
1765
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.#ctor(bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.IStateDictionary{`0,`1},bbv.Common.StateMachine.Internals.IFactory{`0,`1})">
|
1766
|
+
<summary>
|
1767
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateBuilder`2"/> class.
|
1768
|
+
</summary>
|
1769
|
+
<param name="state">The state to build.</param>
|
1770
|
+
<param name="stateDictionary">The state dictionary of the state machine.</param>
|
1771
|
+
<param name="factory">The factory.</param>
|
1772
|
+
</member>
|
1773
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.ExecuteOnEntry(System.Action)">
|
1774
|
+
<summary>
|
1775
|
+
Defines an entry action.
|
1776
|
+
</summary>
|
1777
|
+
<param name="action">The action.</param>
|
1778
|
+
<returns>Exit action syntax.</returns>
|
1779
|
+
</member>
|
1780
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.ExecuteOnEntry``1(System.Action{``0},``0)">
|
1781
|
+
<summary>
|
1782
|
+
Defines an entry action.
|
1783
|
+
</summary>
|
1784
|
+
<typeparam name="T">Type of the parameter of the entry action method.</typeparam>
|
1785
|
+
<param name="action">The action.</param>
|
1786
|
+
<param name="parameter">The parameter that will be passed to the entry action.</param>
|
1787
|
+
<returns>Exit action syntax.</returns>
|
1788
|
+
</member>
|
1789
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.ExecuteOnExit(System.Action)">
|
1790
|
+
<summary>
|
1791
|
+
Defines an exit action.
|
1792
|
+
</summary>
|
1793
|
+
<param name="action">The action.</param>
|
1794
|
+
<returns>Event syntax.</returns>
|
1795
|
+
</member>
|
1796
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.ExecuteOnExit``1(System.Action{``0},``0)">
|
1797
|
+
<summary>
|
1798
|
+
Defines an exit action.
|
1799
|
+
</summary>
|
1800
|
+
<typeparam name="T">Type of the parameter of the exit action method.</typeparam>
|
1801
|
+
<param name="action">The action.</param>
|
1802
|
+
<param name="parameter">The parameter that will be passed to the exit action.</param>
|
1803
|
+
<returns>Exit action syntax.</returns>
|
1804
|
+
</member>
|
1805
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.On(`1)">
|
1806
|
+
<summary>
|
1807
|
+
Builds a transition.
|
1808
|
+
</summary>
|
1809
|
+
<param name="eventId">The event that triggers the transition.</param>
|
1810
|
+
<returns>Syntax to build the transition.</returns>
|
1811
|
+
</member>
|
1812
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.Goto(`0)">
|
1813
|
+
<summary>
|
1814
|
+
Defines where to go in response to an event.
|
1815
|
+
</summary>
|
1816
|
+
<param name="target">The target.</param>
|
1817
|
+
<returns>Execute syntax.</returns>
|
1818
|
+
</member>
|
1819
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.Execute(System.Action{System.Object[]}[])">
|
1820
|
+
<summary>
|
1821
|
+
Defines the actions to execute on a transition.
|
1822
|
+
</summary>
|
1823
|
+
<param name="actions">The actions.</param>
|
1824
|
+
<returns>Guard syntax.</returns>
|
1825
|
+
</member>
|
1826
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateBuilder`2.OnlyIf(System.Func{System.Object[],System.Boolean})">
|
1827
|
+
<summary>
|
1828
|
+
Defines a guard for a transition.
|
1829
|
+
</summary>
|
1830
|
+
<param name="guard">The guard.</param>
|
1831
|
+
<returns>Event syntax.</returns>
|
1832
|
+
</member>
|
1833
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateDictionary`2">
|
1834
|
+
<summary>
|
1835
|
+
Dictionary mapping state ids to states.
|
1836
|
+
</summary>
|
1837
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1838
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1839
|
+
</member>
|
1840
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateDictionary`2.dictionary">
|
1841
|
+
<summary>
|
1842
|
+
Maps ids to states.
|
1843
|
+
</summary>
|
1844
|
+
</member>
|
1845
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateDictionary`2.#ctor(bbv.Common.StateMachine.Internals.IFactory{`0,`1})">
|
1846
|
+
<summary>
|
1847
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateDictionary`2"/> class.
|
1848
|
+
</summary>
|
1849
|
+
<param name="factory">The factory.</param>
|
1850
|
+
</member>
|
1851
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateDictionary`2.GetStates">
|
1852
|
+
<summary>
|
1853
|
+
Gets all states defined in this dictionary.
|
1854
|
+
</summary>
|
1855
|
+
<returns>All states in this directory.</returns>
|
1856
|
+
</member>
|
1857
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateDictionary`2.Item(`0)">
|
1858
|
+
<summary>
|
1859
|
+
Gets the <see cref="T:bbv.Common.StateMachine.Internals.IState`2"/> with the specified state id.
|
1860
|
+
</summary>
|
1861
|
+
<value>State with the specified id.</value>
|
1862
|
+
<param name="stateId">The State id.</param>
|
1863
|
+
</member>
|
1864
|
+
<member name="T:bbv.Common.StateMachine.Internals.StateMachine`2">
|
1865
|
+
<summary>
|
1866
|
+
Base implementation of a state machine.
|
1867
|
+
</summary>
|
1868
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
1869
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
1870
|
+
</member>
|
1871
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachine`2.states">
|
1872
|
+
<summary>
|
1873
|
+
The dictionary of all states.
|
1874
|
+
</summary>
|
1875
|
+
</member>
|
1876
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachine`2.name">
|
1877
|
+
<summary>
|
1878
|
+
Name of this state machine used in log messages.
|
1879
|
+
</summary>
|
1880
|
+
</member>
|
1881
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachine`2.extensions">
|
1882
|
+
<summary>
|
1883
|
+
Extensions of this state machine.
|
1884
|
+
</summary>
|
1885
|
+
</member>
|
1886
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachine`2.currentState">
|
1887
|
+
<summary>
|
1888
|
+
The current state.
|
1889
|
+
</summary>
|
1890
|
+
</member>
|
1891
|
+
<member name="F:bbv.Common.StateMachine.Internals.StateMachine`2.initialStateId">
|
1892
|
+
<summary>
|
1893
|
+
The initial state of the state machine.
|
1894
|
+
</summary>
|
1895
|
+
</member>
|
1896
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.#ctor">
|
1897
|
+
<summary>
|
1898
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateMachine`2"/> class.
|
1899
|
+
</summary>
|
1900
|
+
</member>
|
1901
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.#ctor(System.String)">
|
1902
|
+
<summary>
|
1903
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateMachine`2"/> class.
|
1904
|
+
</summary>
|
1905
|
+
<param name="name">The name of this state machine used in log messages.</param>
|
1906
|
+
</member>
|
1907
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.#ctor(System.String,bbv.Common.StateMachine.Internals.IFactory{`0,`1})">
|
1908
|
+
<summary>
|
1909
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.StateMachine`2"/> class.
|
1910
|
+
</summary>
|
1911
|
+
<param name="name">The name of this state machine used in log messages.</param>
|
1912
|
+
<param name="factory">The factory used to create internal instances.</param>
|
1913
|
+
</member>
|
1914
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.AddExtension(bbv.Common.StateMachine.IExtension{`0,`1})">
|
1915
|
+
<summary>
|
1916
|
+
Adds the extension.
|
1917
|
+
</summary>
|
1918
|
+
<param name="extension">The extension.</param>
|
1919
|
+
</member>
|
1920
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.ClearExtensions">
|
1921
|
+
<summary>
|
1922
|
+
Clears all extensions.
|
1923
|
+
</summary>
|
1924
|
+
</member>
|
1925
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.ForEach(System.Action{bbv.Common.StateMachine.IExtension{`0,`1}})">
|
1926
|
+
<summary>
|
1927
|
+
Executes the specified action for all extensions.
|
1928
|
+
</summary>
|
1929
|
+
<param name="action">The action to execute.</param>
|
1930
|
+
</member>
|
1931
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.In(`0)">
|
1932
|
+
<summary>
|
1933
|
+
Define the behavior of a state.
|
1934
|
+
</summary>
|
1935
|
+
<param name="state">The state.</param>
|
1936
|
+
<returns>Syntax to build state behavior.</returns>
|
1937
|
+
</member>
|
1938
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.Initialize(`0)">
|
1939
|
+
<summary>
|
1940
|
+
Initializes the state machine by setting the specified initial state.
|
1941
|
+
</summary>
|
1942
|
+
<param name="initialState">The initial state of the state machine.</param>
|
1943
|
+
</member>
|
1944
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.Fire(`1)">
|
1945
|
+
<summary>
|
1946
|
+
Fires the specified event.
|
1947
|
+
</summary>
|
1948
|
+
<param name="eventId">The event.</param>
|
1949
|
+
</member>
|
1950
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.Fire(`1,System.Object[])">
|
1951
|
+
<summary>
|
1952
|
+
Fires the specified event.
|
1953
|
+
</summary>
|
1954
|
+
<param name="eventId">The event.</param>
|
1955
|
+
<param name="eventArguments">The event arguments.</param>
|
1956
|
+
</member>
|
1957
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.DefineHierarchyOn(`0,`0,bbv.Common.StateMachine.HistoryType,`0[])">
|
1958
|
+
<summary>
|
1959
|
+
Defines a state hierarchy.
|
1960
|
+
</summary>
|
1961
|
+
<param name="superStateId">The super state id.</param>
|
1962
|
+
<param name="initialSubStateId">The initial state id.</param>
|
1963
|
+
<param name="historyType">Type of the history.</param>
|
1964
|
+
<param name="subStateIds">The sub state ids.</param>
|
1965
|
+
</member>
|
1966
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.OnExceptionThrown(bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Exception)">
|
1967
|
+
<summary>
|
1968
|
+
Fires the <see cref="E:bbv.Common.StateMachine.Internals.StateMachine`2.ExceptionThrown"/> event.
|
1969
|
+
</summary>
|
1970
|
+
<param name="stateContext">The context.</param>
|
1971
|
+
<param name="exception">The exception.</param>
|
1972
|
+
</member>
|
1973
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.OnExceptionThrown(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
1974
|
+
<summary>
|
1975
|
+
Fires the <see cref="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionExceptionThrown"/> event.
|
1976
|
+
</summary>
|
1977
|
+
<param name="transitionContext">The transition context.</param>
|
1978
|
+
<param name="exception">The exception.</param>
|
1979
|
+
</member>
|
1980
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.OnTransitionBegin(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
1981
|
+
<summary>
|
1982
|
+
Fires the <see cref="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionBegin"/> event.
|
1983
|
+
</summary>
|
1984
|
+
<param name="transitionContext">The transition context.</param>
|
1985
|
+
</member>
|
1986
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.ToString">
|
1987
|
+
<summary>
|
1988
|
+
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
1989
|
+
</summary>
|
1990
|
+
<returns>
|
1991
|
+
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
1992
|
+
</returns>
|
1993
|
+
</member>
|
1994
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.Report">
|
1995
|
+
<summary>
|
1996
|
+
Returns a string that describes this state machine.
|
1997
|
+
</summary>
|
1998
|
+
<returns>Description of the state machine</returns>
|
1999
|
+
</member>
|
2000
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.OnTransitionDeclined(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2001
|
+
<summary>
|
2002
|
+
Fires the <see cref="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionDeclined"/> event.
|
2003
|
+
</summary>
|
2004
|
+
<param name="transitionContext">The transition event context.</param>
|
2005
|
+
</member>
|
2006
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.OnTransitionCompleted(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2007
|
+
<summary>
|
2008
|
+
Fires the <see cref="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionCompleted"/> event.
|
2009
|
+
</summary>
|
2010
|
+
<param name="transitionContext">The transition event context.</param>
|
2011
|
+
</member>
|
2012
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.Initialize(bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
2013
|
+
<summary>
|
2014
|
+
Initializes the state machine by setting the specified initial state.
|
2015
|
+
</summary>
|
2016
|
+
<param name="initialState">The initial state.</param>
|
2017
|
+
<param name="stateContext">The event context.</param>
|
2018
|
+
</member>
|
2019
|
+
<member name="M:bbv.Common.StateMachine.Internals.StateMachine`2.RaiseEvent``1(System.EventHandler{``0},``0,bbv.Common.StateMachine.Internals.StateContext{`0,`1},System.Boolean)">
|
2020
|
+
<summary>
|
2021
|
+
Raises an event and catches all exceptions. If an exception is caught then <paramref name="raiseEventOnException"/> specifies whether the
|
2022
|
+
<see cref="E:bbv.Common.StateMachine.Internals.StateMachine`2.ExceptionThrown"/> event is risen.
|
2023
|
+
</summary>
|
2024
|
+
<typeparam name="T">The type of the event arguments.</typeparam>
|
2025
|
+
<param name="eventHandler">The event handler.</param>
|
2026
|
+
<param name="arguments">The arguments.</param>
|
2027
|
+
<param name="stateContext">The event context.</param>
|
2028
|
+
<param name="raiseEventOnException">if set to <c>true</c> [raise event on exception].</param>
|
2029
|
+
</member>
|
2030
|
+
<member name="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionDeclined">
|
2031
|
+
<summary>
|
2032
|
+
Occurs when no transition could be executed.
|
2033
|
+
</summary>
|
2034
|
+
</member>
|
2035
|
+
<member name="E:bbv.Common.StateMachine.Internals.StateMachine`2.ExceptionThrown">
|
2036
|
+
<summary>
|
2037
|
+
Occurs when an exception was thrown inside the state machine.
|
2038
|
+
</summary>
|
2039
|
+
</member>
|
2040
|
+
<member name="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionExceptionThrown">
|
2041
|
+
<summary>
|
2042
|
+
Occurs when an exception was thrown inside a transition of the state machine.
|
2043
|
+
</summary>
|
2044
|
+
</member>
|
2045
|
+
<member name="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionBegin">
|
2046
|
+
<summary>
|
2047
|
+
Occurs when a transition begins.
|
2048
|
+
</summary>
|
2049
|
+
</member>
|
2050
|
+
<member name="E:bbv.Common.StateMachine.Internals.StateMachine`2.TransitionCompleted">
|
2051
|
+
<summary>
|
2052
|
+
Occurs when a transition completed.
|
2053
|
+
</summary>
|
2054
|
+
</member>
|
2055
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateMachine`2.Name">
|
2056
|
+
<summary>
|
2057
|
+
Gets the name of this instance.
|
2058
|
+
</summary>
|
2059
|
+
<value>The name of this instance.</value>
|
2060
|
+
</member>
|
2061
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateMachine`2.CurrentStateId">
|
2062
|
+
<summary>
|
2063
|
+
Gets the id of the current state.
|
2064
|
+
</summary>
|
2065
|
+
<value>The id of the current state.</value>
|
2066
|
+
</member>
|
2067
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateMachine`2.Initialized">
|
2068
|
+
<summary>
|
2069
|
+
Gets a value indicating whether this state machine was initialized.
|
2070
|
+
</summary>
|
2071
|
+
<value><c>true</c> if initialized; otherwise, <c>false</c>.</value>
|
2072
|
+
</member>
|
2073
|
+
<member name="P:bbv.Common.StateMachine.Internals.StateMachine`2.CurrentState">
|
2074
|
+
<summary>
|
2075
|
+
Gets or sets the state of the current.
|
2076
|
+
</summary>
|
2077
|
+
<value>The state of the current.</value>
|
2078
|
+
</member>
|
2079
|
+
<member name="T:bbv.Common.StateMachine.Internals.Transition`2">
|
2080
|
+
<summary>
|
2081
|
+
A transition of the state machine.
|
2082
|
+
</summary>
|
2083
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2084
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2085
|
+
</member>
|
2086
|
+
<member name="F:bbv.Common.StateMachine.Internals.Transition`2.actions">
|
2087
|
+
<summary>
|
2088
|
+
The actions that are executed when this transition is fired.
|
2089
|
+
</summary>
|
2090
|
+
</member>
|
2091
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.#ctor(bbv.Common.StateMachine.IStateMachineInformation{`0,`1},bbv.Common.StateMachine.Internals.IExtensionHost{`0,`1})">
|
2092
|
+
<summary>
|
2093
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.Transition`2"/> class.
|
2094
|
+
</summary>
|
2095
|
+
<param name="stateMachineInformation">The state machine information.</param>
|
2096
|
+
<param name="extensionHost">The extension host.</param>
|
2097
|
+
</member>
|
2098
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.Fire(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2099
|
+
<summary>
|
2100
|
+
Fires the transition.
|
2101
|
+
</summary>
|
2102
|
+
<param name="context">The event context.</param>
|
2103
|
+
<returns>The result of the transition.</returns>
|
2104
|
+
</member>
|
2105
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.ToString">
|
2106
|
+
<summary>
|
2107
|
+
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
2108
|
+
</summary>
|
2109
|
+
<returns>
|
2110
|
+
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
2111
|
+
</returns>
|
2112
|
+
</member>
|
2113
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.Fire(bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},System.Object[],bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2114
|
+
<summary>
|
2115
|
+
Recursively traverses the state hierarchy, exiting states along
|
2116
|
+
the way, performing the action, and entering states to the target.
|
2117
|
+
</summary>
|
2118
|
+
<remarks>
|
2119
|
+
There exist the following transition scenarios:
|
2120
|
+
0. there is no target state (internal transition)
|
2121
|
+
--> handled outside this method.
|
2122
|
+
1. The source and target state are the same (self transition)
|
2123
|
+
--> perform the transition directly:
|
2124
|
+
Exit source state, perform transition actions and enter target state
|
2125
|
+
2. The target state is a direct or indirect sub-state of the source state
|
2126
|
+
--> perform the transition actions, then traverse the hierarchy
|
2127
|
+
from the source state down to the target state,
|
2128
|
+
entering each state along the way.
|
2129
|
+
No state is exited.
|
2130
|
+
3. The source state is a sub-state of the target state
|
2131
|
+
--> traverse the hierarchy from the source up to the target,
|
2132
|
+
exiting each state along the way.
|
2133
|
+
Then perform transition actions.
|
2134
|
+
Finally enter the target state.
|
2135
|
+
4. The source and target state share the same super-state
|
2136
|
+
5. All other scenarios:
|
2137
|
+
a. The source and target states reside at the same level in the hierarchy
|
2138
|
+
but do not share the same direct super-state
|
2139
|
+
--> exit the source state, move up the hierarchy on both sides and enter the target state
|
2140
|
+
b. The source state is lower in the hierarchy than the target state
|
2141
|
+
--> exit the source state and move up the hierarchy on the source state side
|
2142
|
+
c. The target state is lower in the hierarchy than the source state
|
2143
|
+
--> move up the hierarchy on the target state side, afterward enter target state
|
2144
|
+
</remarks>
|
2145
|
+
<param name="source">The source state.</param>
|
2146
|
+
<param name="target">The target state.</param>
|
2147
|
+
<param name="eventArguments">The event arguments.</param>
|
2148
|
+
<param name="context">The event context.</param>
|
2149
|
+
</member>
|
2150
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.ShouldFire(System.Object[],bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2151
|
+
<summary>
|
2152
|
+
Returns a value indicating whether the transition should fire (according to the <see cref="P:bbv.Common.StateMachine.Internals.Transition`2.Guard"/>).
|
2153
|
+
</summary>
|
2154
|
+
<param name="eventArguments">The event arguments.</param>
|
2155
|
+
<param name="context">The event context.</param>
|
2156
|
+
<returns>A value indicating whether to execute the transition.</returns>
|
2157
|
+
</member>
|
2158
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.HandleException(System.Exception,bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2159
|
+
<summary>
|
2160
|
+
Handles an exception thrown during performing the transition or guard evaluation.
|
2161
|
+
</summary>
|
2162
|
+
<param name="exception">The exception.</param>
|
2163
|
+
<param name="context">The context.</param>
|
2164
|
+
</member>
|
2165
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.PerformActions(System.Object[],bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2166
|
+
<summary>
|
2167
|
+
Performs the actions of this transition.
|
2168
|
+
</summary>
|
2169
|
+
<param name="eventArguments">The event arguments.</param>
|
2170
|
+
<param name="context">The event context.</param>
|
2171
|
+
</member>
|
2172
|
+
<member name="M:bbv.Common.StateMachine.Internals.Transition`2.UnwindSubStates(bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.StateContext{`0,`1})">
|
2173
|
+
<summary>
|
2174
|
+
Exits all sub-states up the hierarchy up to the <paramref name="origin"/> state.
|
2175
|
+
</summary>
|
2176
|
+
<param name="origin">The origin.</param>
|
2177
|
+
<param name="stateContext">The event context.</param>
|
2178
|
+
</member>
|
2179
|
+
<member name="P:bbv.Common.StateMachine.Internals.Transition`2.Source">
|
2180
|
+
<summary>
|
2181
|
+
Gets or sets the source state of this transition.
|
2182
|
+
</summary>
|
2183
|
+
<value>The source state.</value>
|
2184
|
+
</member>
|
2185
|
+
<member name="P:bbv.Common.StateMachine.Internals.Transition`2.Target">
|
2186
|
+
<summary>
|
2187
|
+
Gets or sets the target state of this transition.
|
2188
|
+
</summary>
|
2189
|
+
<value>The target state.</value>
|
2190
|
+
</member>
|
2191
|
+
<member name="P:bbv.Common.StateMachine.Internals.Transition`2.Guard">
|
2192
|
+
<summary>
|
2193
|
+
Gets or sets the guard of this transition.
|
2194
|
+
</summary>
|
2195
|
+
<value>The guard.</value>
|
2196
|
+
</member>
|
2197
|
+
<member name="P:bbv.Common.StateMachine.Internals.Transition`2.Actions">
|
2198
|
+
<summary>
|
2199
|
+
Gets the actions of this transaction.
|
2200
|
+
</summary>
|
2201
|
+
<value>The actions.</value>
|
2202
|
+
</member>
|
2203
|
+
<member name="P:bbv.Common.StateMachine.Internals.Transition`2.InternalTransition">
|
2204
|
+
<summary>
|
2205
|
+
Gets a value indicating whether this is an internal transition.
|
2206
|
+
</summary>
|
2207
|
+
<value><c>true</c> if this is an internal transition; otherwise, <c>false</c>.</value>
|
2208
|
+
</member>
|
2209
|
+
<member name="T:bbv.Common.StateMachine.TransitionCompletedEventArgs`2">
|
2210
|
+
<summary>
|
2211
|
+
Provides information about a completed transition.
|
2212
|
+
</summary>
|
2213
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2214
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2215
|
+
</member>
|
2216
|
+
<member name="T:bbv.Common.StateMachine.TransitionEventArgs`2">
|
2217
|
+
<summary>
|
2218
|
+
Event arguments providing a transition context.
|
2219
|
+
</summary>
|
2220
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2221
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2222
|
+
</member>
|
2223
|
+
<member name="M:bbv.Common.StateMachine.TransitionEventArgs`2.#ctor(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2224
|
+
<summary>
|
2225
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.TransitionEventArgs`2"/> class.
|
2226
|
+
</summary>
|
2227
|
+
<param name="context">The event context.</param>
|
2228
|
+
</member>
|
2229
|
+
<member name="M:bbv.Common.StateMachine.TransitionEventArgs`2.ToString">
|
2230
|
+
<summary>
|
2231
|
+
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
2232
|
+
</summary>
|
2233
|
+
<returns>
|
2234
|
+
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
2235
|
+
</returns>
|
2236
|
+
</member>
|
2237
|
+
<member name="P:bbv.Common.StateMachine.TransitionEventArgs`2.StateId">
|
2238
|
+
<summary>
|
2239
|
+
Gets the id of the source state of the transition.
|
2240
|
+
</summary>
|
2241
|
+
<value>The id of the source state of the transition.</value>
|
2242
|
+
</member>
|
2243
|
+
<member name="P:bbv.Common.StateMachine.TransitionEventArgs`2.EventId">
|
2244
|
+
<summary>
|
2245
|
+
Gets the event id.
|
2246
|
+
</summary>
|
2247
|
+
<value>The event id.</value>
|
2248
|
+
</member>
|
2249
|
+
<member name="P:bbv.Common.StateMachine.TransitionEventArgs`2.EventArguments">
|
2250
|
+
<summary>
|
2251
|
+
Gets the event arguments.
|
2252
|
+
</summary>
|
2253
|
+
<value>The event arguments.</value>
|
2254
|
+
</member>
|
2255
|
+
<member name="P:bbv.Common.StateMachine.TransitionEventArgs`2.TransitionContext">
|
2256
|
+
<summary>
|
2257
|
+
Gets the event context.
|
2258
|
+
</summary>
|
2259
|
+
<value>The event context.</value>
|
2260
|
+
</member>
|
2261
|
+
<member name="F:bbv.Common.StateMachine.TransitionCompletedEventArgs`2.newStateId">
|
2262
|
+
<summary>
|
2263
|
+
The new state the state machine is in after the transition.
|
2264
|
+
</summary>
|
2265
|
+
</member>
|
2266
|
+
<member name="M:bbv.Common.StateMachine.TransitionCompletedEventArgs`2.#ctor(System.Nullable{`0},bbv.Common.StateMachine.Internals.TransitionContext{`0,`1})">
|
2267
|
+
<summary>
|
2268
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.TransitionCompletedEventArgs`2"/> class.
|
2269
|
+
</summary>
|
2270
|
+
<param name="newStateId">The new state id.</param>
|
2271
|
+
<param name="context">The context.</param>
|
2272
|
+
</member>
|
2273
|
+
<member name="P:bbv.Common.StateMachine.TransitionCompletedEventArgs`2.NewStateId">
|
2274
|
+
<summary>
|
2275
|
+
Gets the new state id the state machine is in after the transition.
|
2276
|
+
</summary>
|
2277
|
+
<value>The new state id the state machine is in after the transition.</value>
|
2278
|
+
</member>
|
2279
|
+
<member name="T:bbv.Common.StateMachine.Internals.TransitionDictionary`2">
|
2280
|
+
<summary>
|
2281
|
+
Manages the transitions of a state.
|
2282
|
+
</summary>
|
2283
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2284
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2285
|
+
</member>
|
2286
|
+
<member name="F:bbv.Common.StateMachine.Internals.TransitionDictionary`2.transitions">
|
2287
|
+
<summary>
|
2288
|
+
The transitions.
|
2289
|
+
</summary>
|
2290
|
+
</member>
|
2291
|
+
<member name="F:bbv.Common.StateMachine.Internals.TransitionDictionary`2.state">
|
2292
|
+
<summary>
|
2293
|
+
The state this transition dictionary belongs to.
|
2294
|
+
</summary>
|
2295
|
+
</member>
|
2296
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.#ctor(bbv.Common.StateMachine.Internals.IState{`0,`1})">
|
2297
|
+
<summary>
|
2298
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.TransitionDictionary`2"/> class.
|
2299
|
+
</summary>
|
2300
|
+
<param name="state">The state.</param>
|
2301
|
+
</member>
|
2302
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.Add(`1,bbv.Common.StateMachine.Internals.ITransition{`0,`1})">
|
2303
|
+
<summary>
|
2304
|
+
Adds the specified event id.
|
2305
|
+
</summary>
|
2306
|
+
<param name="eventId">The event id.</param>
|
2307
|
+
<param name="transition">The transition.</param>
|
2308
|
+
</member>
|
2309
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.GetTransitions">
|
2310
|
+
<summary>
|
2311
|
+
Gets all transitions.
|
2312
|
+
</summary>
|
2313
|
+
<returns>All transitions.</returns>
|
2314
|
+
</member>
|
2315
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.CheckTransitionDoesNotYetExist(bbv.Common.StateMachine.Internals.ITransition{`0,`1})">
|
2316
|
+
<summary>
|
2317
|
+
Throws an exception if the specified transition is already defined on this state.
|
2318
|
+
</summary>
|
2319
|
+
<param name="transition">The transition.</param>
|
2320
|
+
</member>
|
2321
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.MakeSureEventExistsInTransitionList(`1)">
|
2322
|
+
<summary>
|
2323
|
+
If there is no entry in the <see cref="F:bbv.Common.StateMachine.Internals.TransitionDictionary`2.transitions"/> dictionary then one is created.
|
2324
|
+
</summary>
|
2325
|
+
<param name="eventId">The event id.</param>
|
2326
|
+
</member>
|
2327
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.GetTransitionsOfEvent(`1,System.Collections.Generic.List{bbv.Common.StateMachine.Internals.TransitionDictionary{`0,`1}.TransitionInfo})">
|
2328
|
+
<summary>
|
2329
|
+
Gets all the transitions associated to the specified event.
|
2330
|
+
</summary>
|
2331
|
+
<param name="eventId">The event id.</param>
|
2332
|
+
<param name="list">The list to add the transition.</param>
|
2333
|
+
</member>
|
2334
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionDictionary`2.Item(`1)">
|
2335
|
+
<summary>
|
2336
|
+
Gets the transitions for the specified event id.
|
2337
|
+
</summary>
|
2338
|
+
<value>transitions for the event id.</value>
|
2339
|
+
<param name="eventId">Id of the event.</param>
|
2340
|
+
</member>
|
2341
|
+
<member name="T:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo">
|
2342
|
+
<summary>
|
2343
|
+
Describes a transition.
|
2344
|
+
</summary>
|
2345
|
+
</member>
|
2346
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo.#ctor(`1,bbv.Common.StateMachine.Internals.IState{`0,`1},bbv.Common.StateMachine.Internals.IState{`0,`1},System.Boolean,System.Int32)">
|
2347
|
+
<summary>
|
2348
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo"/> class.
|
2349
|
+
</summary>
|
2350
|
+
<param name="eventId">The event id.</param>
|
2351
|
+
<param name="source">The source.</param>
|
2352
|
+
<param name="target">The target.</param>
|
2353
|
+
<param name="hasGuard">Whether the transition has a guard or not.</param>
|
2354
|
+
<param name="actions">The number actions.</param>
|
2355
|
+
</member>
|
2356
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo.EventId">
|
2357
|
+
<summary>
|
2358
|
+
Gets the event id.
|
2359
|
+
</summary>
|
2360
|
+
<value>The event id.</value>
|
2361
|
+
</member>
|
2362
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo.Source">
|
2363
|
+
<summary>
|
2364
|
+
Gets the source.
|
2365
|
+
</summary>
|
2366
|
+
<value>The source.</value>
|
2367
|
+
</member>
|
2368
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo.Target">
|
2369
|
+
<summary>
|
2370
|
+
Gets the target.
|
2371
|
+
</summary>
|
2372
|
+
<value>The target.</value>
|
2373
|
+
</member>
|
2374
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo.HasGuard">
|
2375
|
+
<summary>
|
2376
|
+
Gets a value indicating whether this instance has a guard.
|
2377
|
+
</summary>
|
2378
|
+
<value><c>true</c> if this instance has a guard; otherwise, <c>false</c>.</value>
|
2379
|
+
</member>
|
2380
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionDictionary`2.TransitionInfo.Actions">
|
2381
|
+
<summary>
|
2382
|
+
Gets the number of actions.
|
2383
|
+
</summary>
|
2384
|
+
<value>The actions.</value>
|
2385
|
+
</member>
|
2386
|
+
<member name="T:bbv.Common.StateMachine.Internals.TransitionContext`2">
|
2387
|
+
<summary>
|
2388
|
+
Provides context information during a transition.
|
2389
|
+
</summary>
|
2390
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2391
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2392
|
+
</member>
|
2393
|
+
<member name="F:bbv.Common.StateMachine.Internals.TransitionContext`2.eventId">
|
2394
|
+
<summary>
|
2395
|
+
The event that causes the transition.
|
2396
|
+
</summary>
|
2397
|
+
</member>
|
2398
|
+
<member name="F:bbv.Common.StateMachine.Internals.TransitionContext`2.eventArguments">
|
2399
|
+
<summary>
|
2400
|
+
The event arguments.
|
2401
|
+
</summary>
|
2402
|
+
</member>
|
2403
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionContext`2.#ctor">
|
2404
|
+
<summary>
|
2405
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.TransitionContext`2"/> class.
|
2406
|
+
</summary>
|
2407
|
+
</member>
|
2408
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionContext`2.#ctor(bbv.Common.StateMachine.Internals.IState{`0,`1},`1,System.Object[],bbv.Common.StateMachine.Internals.INotifier{`0,`1})">
|
2409
|
+
<summary>
|
2410
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.TransitionContext`2"/> class.
|
2411
|
+
</summary>
|
2412
|
+
<param name="state">The source state.</param>
|
2413
|
+
<param name="eventId">The event id.</param>
|
2414
|
+
<param name="eventArguments">The event arguments.</param>
|
2415
|
+
<param name="notifier">The notifier to fire events about transition events and exceptions.</param>
|
2416
|
+
</member>
|
2417
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionContext`2.OnExceptionThrown(System.Exception)">
|
2418
|
+
<summary>
|
2419
|
+
Called when an exception should be notified.
|
2420
|
+
</summary>
|
2421
|
+
<param name="exception">The exception.</param>
|
2422
|
+
</member>
|
2423
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionContext`2.OnTransitionBegin">
|
2424
|
+
<summary>
|
2425
|
+
Called when a transition beginning should be notified.
|
2426
|
+
</summary>
|
2427
|
+
</member>
|
2428
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionContext`2.EventId">
|
2429
|
+
<summary>
|
2430
|
+
Gets the event id.
|
2431
|
+
</summary>
|
2432
|
+
<value>The event id.</value>
|
2433
|
+
</member>
|
2434
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionContext`2.EventArguments">
|
2435
|
+
<summary>
|
2436
|
+
Gets the event arguments.
|
2437
|
+
</summary>
|
2438
|
+
<value>The event arguments.</value>
|
2439
|
+
</member>
|
2440
|
+
<member name="T:bbv.Common.StateMachine.TransitionExceptionEventArgs`2">
|
2441
|
+
<summary>
|
2442
|
+
Event arguments providing transition exceptions.
|
2443
|
+
</summary>
|
2444
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2445
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2446
|
+
</member>
|
2447
|
+
<member name="F:bbv.Common.StateMachine.TransitionExceptionEventArgs`2.exception">
|
2448
|
+
<summary>
|
2449
|
+
The exception.
|
2450
|
+
</summary>
|
2451
|
+
</member>
|
2452
|
+
<member name="M:bbv.Common.StateMachine.TransitionExceptionEventArgs`2.#ctor(bbv.Common.StateMachine.Internals.TransitionContext{`0,`1},System.Exception)">
|
2453
|
+
<summary>
|
2454
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.TransitionExceptionEventArgs`2"/> class.
|
2455
|
+
</summary>
|
2456
|
+
<param name="context">The event context.</param>
|
2457
|
+
<param name="exception">The exception.</param>
|
2458
|
+
</member>
|
2459
|
+
<member name="P:bbv.Common.StateMachine.TransitionExceptionEventArgs`2.Exception">
|
2460
|
+
<summary>
|
2461
|
+
Gets the exception.
|
2462
|
+
</summary>
|
2463
|
+
<value>The exception.</value>
|
2464
|
+
</member>
|
2465
|
+
<member name="T:bbv.Common.StateMachine.Internals.TransitionResult`2">
|
2466
|
+
<summary>
|
2467
|
+
Represents the result of a transition.
|
2468
|
+
</summary>
|
2469
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2470
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2471
|
+
</member>
|
2472
|
+
<member name="F:bbv.Common.StateMachine.Internals.TransitionResult`2.NotFired">
|
2473
|
+
<summary>
|
2474
|
+
This value represents that no transition was fired.
|
2475
|
+
</summary>
|
2476
|
+
</member>
|
2477
|
+
<member name="M:bbv.Common.StateMachine.Internals.TransitionResult`2.#ctor(System.Boolean,bbv.Common.StateMachine.Internals.IState{`0,`1},System.Collections.Generic.ICollection{System.Exception})">
|
2478
|
+
<summary>
|
2479
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.Internals.TransitionResult`2"/> class.
|
2480
|
+
</summary>
|
2481
|
+
<param name="fired">if set to <c>true</c> [fired].</param>
|
2482
|
+
<param name="newState">The new state.</param>
|
2483
|
+
<param name="exceptions">The exceptions.</param>
|
2484
|
+
</member>
|
2485
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionResult`2.Fired">
|
2486
|
+
<summary>
|
2487
|
+
Gets a value indicating whether this <see cref="T:bbv.Common.StateMachine.Internals.ITransitionResult`2"/> is fired.
|
2488
|
+
</summary>
|
2489
|
+
<value><c>true</c> if fired; otherwise, <c>false</c>.</value>
|
2490
|
+
</member>
|
2491
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionResult`2.NewState">
|
2492
|
+
<summary>
|
2493
|
+
Gets the new state the state machine is in.
|
2494
|
+
</summary>
|
2495
|
+
<value>The new state.</value>
|
2496
|
+
</member>
|
2497
|
+
<member name="P:bbv.Common.StateMachine.Internals.TransitionResult`2.Exceptions">
|
2498
|
+
<summary>
|
2499
|
+
Gets all exceptions that occurred during executing the transition.
|
2500
|
+
</summary>
|
2501
|
+
<value>The exceptions.</value>
|
2502
|
+
</member>
|
2503
|
+
<member name="T:bbv.Common.StateMachine.UnitTestStateMachine`2">
|
2504
|
+
<summary>
|
2505
|
+
Special state machine that can be used in unit tests for easier exception testing.
|
2506
|
+
This state machine does not only signal exception cases and declined transitions with events
|
2507
|
+
but throws exceptions, too. This guarantees that these exception cases don't stay hidden in
|
2508
|
+
unit tests.
|
2509
|
+
</summary>
|
2510
|
+
<typeparam name="TState">The type of the state.</typeparam>
|
2511
|
+
<typeparam name="TEvent">The type of the event.</typeparam>
|
2512
|
+
</member>
|
2513
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.#ctor">
|
2514
|
+
<summary>
|
2515
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.UnitTestStateMachine`2"/> class.
|
2516
|
+
</summary>
|
2517
|
+
</member>
|
2518
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.#ctor(System.String)">
|
2519
|
+
<summary>
|
2520
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.UnitTestStateMachine`2"/> class.
|
2521
|
+
</summary>
|
2522
|
+
<param name="name">The name of the state machine. Used in log messages.</param>
|
2523
|
+
</member>
|
2524
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.#ctor(System.String,bbv.Common.StateMachine.Internals.IFactory{`0,`1})">
|
2525
|
+
<summary>
|
2526
|
+
Initializes a new instance of the <see cref="T:bbv.Common.StateMachine.UnitTestStateMachine`2"/> class.
|
2527
|
+
</summary>
|
2528
|
+
<param name="name">The name of the state machine. Used in log messages.</param>
|
2529
|
+
<param name="factory">The factory.</param>
|
2530
|
+
</member>
|
2531
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.HandleTransitionDeclined(System.Object,bbv.Common.StateMachine.TransitionEventArgs{`0,`1})">
|
2532
|
+
<summary>
|
2533
|
+
Throws an exception when a transition declined event is received.
|
2534
|
+
</summary>
|
2535
|
+
<param name="sender">The sender.</param>
|
2536
|
+
<param name="e">The <see cref="T:bbv.Common.StateMachine.TransitionEventArgs`2"/> instance containing the event data.</param>
|
2537
|
+
</member>
|
2538
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.HandleExceptionThrown(System.Object,bbv.Common.StateMachine.ExceptionEventArgs{`0,`1})">
|
2539
|
+
<summary>
|
2540
|
+
Throws the exception received in the event arguments. The stack trace of the original exception is restored.
|
2541
|
+
</summary>
|
2542
|
+
<param name="sender">The sender.</param>
|
2543
|
+
<param name="e">The <see cref="T:bbv.Common.StateMachine.ExceptionEventArgs`2"/> instance containing the event data.</param>
|
2544
|
+
</member>
|
2545
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.HandleTranistionExceptionThrown(System.Object,bbv.Common.StateMachine.TransitionExceptionEventArgs{`0,`1})">
|
2546
|
+
<summary>
|
2547
|
+
Throws the exception received in the event arguments. The stack trace of the original exception is restored.
|
2548
|
+
</summary>
|
2549
|
+
<param name="sender">The sender.</param>
|
2550
|
+
<param name="e">The <see cref="T:bbv.Common.StateMachine.ExceptionEventArgs`2"/> instance containing the event data.</param>
|
2551
|
+
</member>
|
2552
|
+
<member name="M:bbv.Common.StateMachine.UnitTestStateMachine`2.RestoreOriginalStackTrace(System.Exception)">
|
2553
|
+
<summary>
|
2554
|
+
Restores the original stack trace of the specified exception.
|
2555
|
+
</summary>
|
2556
|
+
<param name="exception">The exception.</param>
|
2557
|
+
</member>
|
2558
|
+
</members>
|
2559
|
+
</doc>
|