-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathDuetAPI.xml
9289 lines (9289 loc) · 378 KB
/
DuetAPI.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>DuetAPI</name>
</assembly>
<members>
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
<summary>
Specifies that the method or property will ensure that the listed field and property members have
not-<see langword="null"/> values.
</summary>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
<summary>
Gets field or property member names.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
<summary>
Initializes the attribute with a field or property member.
</summary>
<param name="member">
The field or property member that is promised to be not-null.
</param>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
<summary>
Initializes the attribute with the list of field and property members.
</summary>
<param name="members">
The list of field and property members that are promised to be not-null.
</param>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
<summary>
Specifies that the method or property will ensure that the listed field and property members have
non-<see langword="null"/> values when returning with the specified return value condition.
</summary>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
<summary>
Gets the return value condition.
</summary>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
<summary>
Gets field or property member names.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
<summary>
Initializes the attribute with the specified return value condition and a field or property member.
</summary>
<param name="returnValue">
The return value condition. If the method returns this value,
the associated parameter will not be <see langword="null"/>.
</param>
<param name="member">
The field or property member that is promised to be not-<see langword="null"/>.
</param>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
<summary>
Initializes the attribute with the specified return value condition and list
of field and property members.
</summary>
<param name="returnValue">
The return value condition. If the method returns this value,
the associated parameter will not be <see langword="null"/>.
</param>
<param name="members">
The list of field and property members that are promised to be not-null.
</param>
</member>
<member name="T:DuetAPI.CodeChannel">
<summary>
Enumeration of supported input channel names
</summary>
<remarks>
The indices of this enum are tightly coupled with RepRapFirmware.
Make sure to update this enum accordingly whenever changes are made to it!
</remarks>
</member>
<member name="F:DuetAPI.CodeChannel.HTTP">
<summary>
Code channel for HTTP requests
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Telnet">
<summary>
Code channel for Telnet requests
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.File">
<summary>
Code channel for primary file prints
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.USB">
<summary>
Code channel for USB requests
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Aux">
<summary>
Code channel for serial devices (e.g. PanelDue)
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Trigger">
<summary>
Code channel for running triggers or config.g
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Queue">
<summary>
Code channel for the code queue that executes a couple of codes in-sync with moves of the primary print file
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.LCD">
<summary>
Code channel for auxiliary LCD devices (e.g. PanelOne)
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.SBC">
<summary>
Default code channel for requests over SPI
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Daemon">
<summary>
Code channel that executes the daemon process
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Aux2">
<summary>
Code channel for the second UART port
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Autopause">
<summary>
Code channel that executes macros on power fail, heater faults and filament out
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.File2">
<summary>
Code channel for secondary file prints
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Queue2">
<summary>
Code channel for the code queue that executes a couple of codes in-sync with moves of the primary print file
</summary>
</member>
<member name="F:DuetAPI.CodeChannel.Unknown">
<summary>
Unknown code channel
</summary>
</member>
<member name="T:DuetAPI.Commands.BaseCommand">
<summary>
Base class of a command.
When an instance of this class is processed in the control server, the connection identifier of the channel it was received from is assigned.
</summary>
</member>
<member name="M:DuetAPI.Commands.BaseCommand.#ctor">
<summary>
Creates a new instance of the BaseCommand
</summary>
</member>
<member name="P:DuetAPI.Commands.BaseCommand.Command">
<summary>
Name of the command to execute
</summary>
</member>
<member name="M:DuetAPI.Commands.BaseCommand.Invoke">
<summary>
Invokes the command implementation
</summary>
<returns>Result of the command</returns>
</member>
<member name="T:DuetAPI.Commands.Command">
<summary>
Base class of commands that do not return a result
</summary>
</member>
<member name="M:DuetAPI.Commands.Command.Execute">
<summary>
Reserved for the actual command implementation in the control server
</summary>
<returns>Asynchronous task</returns>
</member>
<member name="M:DuetAPI.Commands.Command.Invoke">
<summary>
Invokes the command implementation
</summary>
<returns>null</returns>
</member>
<member name="T:DuetAPI.Commands.Command`1">
<summary>
Base class of a command that returns a result
</summary>
<typeparam name="T">Type of the command result</typeparam>
</member>
<member name="M:DuetAPI.Commands.Command`1.Execute">
<summary>
Reserved for the actual command implementation in the control server
</summary>
<returns>Command result</returns>
</member>
<member name="M:DuetAPI.Commands.Command`1.Invoke">
<summary>
Invokes the command implementation
</summary>
<returns>Command result</returns>
</member>
<member name="T:DuetAPI.Commands.Code">
<summary>
A parsed representation of a generic G/M/T-code
</summary>
</member>
<member name="M:DuetAPI.Commands.Code.#ctor">
<summary>
Create an empty Code representation
</summary>
</member>
<member name="M:DuetAPI.Commands.Code.#ctor(System.String)">
<summary>
Create a new Code instance and attempt to parse the given code string
</summary>
<param name="code">UTF8-encoded G/M/T-Code</param>
</member>
<member name="P:DuetAPI.Commands.Code.SourceConnection">
<summary>
The connection ID this code was received from. If this is 0, the code originates from an internal DCS task
</summary>
<remarks>
Usually there is no need to populate this property. It is internally overwritten by the control server on receipt
</remarks>
</member>
<member name="P:DuetAPI.Commands.Code.Result">
<summary>
Result of this code. This property is only set when the code has finished its excution.
It remains null if the code has been cancelled
</summary>
<remarks>
This used to be of type CodeResult but since v3.2 CodeResult can read Message JSON so it should remain compatible
</remarks>
</member>
<member name="P:DuetAPI.Commands.Code.Type">
<summary>
Type of the code
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Channel">
<summary>
Code channel to send this code to
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.IsFromFileChannel">
<summary>
Check if this code is from a file channel
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.LineNumber">
<summary>
Line number of this code
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Indent">
<summary>
Number of whitespaces prefixing the command content
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Keyword">
<summary>
Type of conditional G-code (if any)
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.KeywordArgument">
<summary>
Argument of the conditional G-code (if any)
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.MajorNumber">
<summary>
Major code number (e.g. 28 in G28)
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.MinorNumber">
<summary>
Minor code number (e.g. 3 in G54.3)
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Flags">
<summary>
Flags of this code
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Comment">
<summary>
Comment of the G/M/T-code. May be null if no comment is present
</summary>
<remarks>
The parser combines different comment segments and concatenates them as a single value.
So for example a code like 'G28 (Do homing) ; via G28' causes the Comment field to be filled with 'Do homing via G28'
</remarks>
</member>
<member name="P:DuetAPI.Commands.Code.FilePosition">
<summary>
File position of this code in bytes (optional)
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Length">
<summary>
Length of the original code in bytes (optional)
</summary>
</member>
<member name="P:DuetAPI.Commands.Code.Parameters">
<summary>
List of parsed code parameters (see <see cref="T:DuetAPI.Commands.CodeParameter"/> for further information)
</summary>
<seealso cref="T:DuetAPI.Commands.CodeParameter"/>
</member>
<member name="M:DuetAPI.Commands.Code.Reset">
<summary>
Reset this instance
</summary>
</member>
<member name="M:DuetAPI.Commands.Code.Parameter(System.Char)">
<summary>
Retrieve the parameter whose letter equals c
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>The parsed parameter instance or null if none could be found</returns>
</member>
<member name="M:DuetAPI.Commands.Code.Parameter(System.Char,System.Object)">
<summary>
Retrieve the parameter whose letter equals c or generate a default parameter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default parameter value (no expression)</param>
<returns>The parsed parameter instance or null if none could be found</returns>
</member>
<member name="M:DuetAPI.Commands.Code.HasParameter(System.Char)">
<summary>
Check if a given parameter exists
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>If the parameter is present</returns>
</member>
<member name="M:DuetAPI.Commands.Code.GetParameter(System.Char)">
<summary>
Retrieve the parameter whose letter equals c
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>The parsed parameter instance or null if none could be found</returns>
</member>
<member name="M:DuetAPI.Commands.Code.GetParameter(System.Char,System.Object)">
<summary>
Retrieve the parameter whose letter equals c or generate a default parameter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default parameter value (no expression)</param>
<returns>The parsed parameter instance or null if none could be found</returns>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetParameter(System.Char,DuetAPI.Commands.CodeParameter@)">
<summary>
Try to get a parameter by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
</member>
<member name="M:DuetAPI.Commands.Code.GetFloat(System.Char)">
<summary>
Get a float parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetFloat(System.Char,System.Single)">
<summary>
Get a float parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetFloat(System.Char,System.Single@)">
<summary>
Try to get a float parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else default</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetFloat(System.Char,System.Nullable{System.Single}@)">
<summary>
Try to get a float parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetInt(System.Char)">
<summary>
Get an integer parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetInt(System.Char,System.Int32)">
<summary>
Get an integer parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetInt(System.Char,System.Int32@)">
<summary>
Try to get an integer parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else default</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetInt(System.Char,System.Nullable{System.Int32}@)">
<summary>
Try to get an integer parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetUInt(System.Char)">
<summary>
Get an unsigned integer parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetUInt(System.Char,System.UInt32)">
<summary>
Get an unsigned integer parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetUInt(System.Char,System.UInt32@)">
<summary>
Try to get an unsigned integer parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else default</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetUInt(System.Char,System.Nullable{System.UInt32}@)">
<summary>
Try to get an unsigned integer parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetLong(System.Char)">
<summary>
Get a long parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetLong(System.Char,System.Int64)">
<summary>
Get a long parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetLong(System.Char,System.Int64@)">
<summary>
Try to get a long parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else default</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetLong(System.Char,System.Nullable{System.Int64}@)">
<summary>
Try to get a long parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetBool(System.Char)">
<summary>
Get a boolean parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetBool(System.Char,System.Boolean)">
<summary>
Get a boolean parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetBool(System.Char,System.Boolean@)">
<summary>
Try to get a long parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else default</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetBool(System.Char,System.Nullable{System.Boolean}@)">
<summary>
Try to get a long parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetString(System.Char)">
<summary>
Get a string parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetOptionalString(System.Char)">
<summary>
Get a string parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value or null</returns>
</member>
<member name="M:DuetAPI.Commands.Code.GetString(System.Char,System.String)">
<summary>
Get an unsigned integer parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetString(System.Char,System.String@)">
<summary>
Try to get a string parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetDriverId(System.Char)">
<summary>
Get a driver ID parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetDriverId(System.Char,DuetAPI.Utility.DriverId)">
<summary>
Get a driver ID parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetDriverId(System.Char,DuetAPI.Utility.DriverId@)">
<summary>
Try to get a driver ID parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetIPAddress(System.Char)">
<summary>
Get an IP address parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetIPAddress(System.Char,System.Net.IPAddress)">
<summary>
Get an IP address parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetIPAddress(System.Char,System.Net.IPAddress@)">
<summary>
Try to get a driver ID parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetFloatArray(System.Char)">
<summary>
Get a float array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetFloatArray(System.Char,System.Single[])">
<summary>
Get a float array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetFloatArray(System.Char,System.Single[]@)">
<summary>
Try to get a float array parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetIntArray(System.Char)">
<summary>
Get an integer array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetIntArray(System.Char,System.Int32[])">
<summary>
Get an integer array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetIntArray(System.Char,System.Int32[]@)">
<summary>
Try to get an integer array parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetUIntArray(System.Char)">
<summary>
Get an unsigned integer array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetUIntArray(System.Char,System.UInt32[])">
<summary>
Get an unsigned integer array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetUIntArray(System.Char,System.UInt32[]@)">
<summary>
Try to get an unsigned integer array parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetLongArray(System.Char)">
<summary>
Get a long array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetLongArray(System.Char,System.Int64[])">
<summary>
Get a long array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetLongArray(System.Char,System.Int64[]@)">
<summary>
Try to get a long array parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetDriverIdArray(System.Char)">
<summary>
Get a driver ID array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.MissingParameterException">Parameter not found</exception>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetDriverIdArray(System.Char,DuetAPI.Utility.DriverId[])">
<summary>
Get a driver ID array parameter value
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="defaultValue">Default value to return if no parameter could be found</param>
<returns>Parameter value</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.TryGetDriverIdArray(System.Char,DuetAPI.Utility.DriverId[]@)">
<summary>
Try to get a long array parameter value by letter
</summary>
<param name="letter">Letter of the parameter to find</param>
<param name="parameter">Parameter if found, else null</param>
<returns>True if the requested parameter could be found</returns>
<exception cref="T:DuetAPI.InvalidParameterTypeException">Failed to convert parameter value</exception>
</member>
<member name="M:DuetAPI.Commands.Code.GetUnprecedentedString(System.Boolean)">
<summary>
Reconstruct an unprecedented string from the parameter list or
retrieve the parameter which does not have a letter assigned
</summary>
<param name="quoteStrings">Encapsulate strings in double quotes</param>
<returns>Unprecedented string</returns>
<remarks>
If no parameter is present, an empty string is returned
</remarks>
</member>
<member name="M:DuetAPI.Commands.Code.ToString">
<summary>
Convert the parsed code back to a text-based G/M/T-code
</summary>
<returns>Reconstructed code string</returns>
</member>
<member name="M:DuetAPI.Commands.Code.ToShortString">
<summary>
Convert only the command portion to a text-based G/M/T-code (e.g. G28)
</summary>
<returns>Command fraction of the code</returns>
</member>
<member name="M:DuetAPI.Commands.Code.KeywordToString">
<summary>
Convert the keyword to a string
</summary>
<returns></returns>
</member>
<member name="M:DuetAPI.Commands.Code.Parse(System.IO.TextReader,DuetAPI.Commands.Code)">
<summary>
Parse the next available G/M/T-code from the given stream
</summary>
<param name="reader">Input to read from</param>
<param name="result">Code to fill</param>
<returns>Whether anything could be read</returns>
<exception cref="T:DuetAPI.CodeParserException">Thrown if the code contains errors like unterminated strings or unterminated comments</exception>
<remarks>
In general it is better to use <see cref="M:DuetAPI.Commands.Code.ParseAsync(System.IO.StreamReader,DuetAPI.Commands.Code,DuetAPI.Commands.CodeParserBuffer)"/> because this implementation
- does not update the line number unless it is specified using the 'N' character
- does not set the corresponding flag for G53 after the first code on a line
- sets the indentation level only for the first code in a line
- does not support Fanuc or LaserWeb styles
</remarks>
</member>
<member name="M:DuetAPI.Commands.Code.AddParameter(DuetAPI.Commands.Code,System.Char,System.String,System.Boolean,System.Boolean)">
<summary>
Add a new parameter to a given <see cref="T:DuetAPI.Commands.Code"/> instance
</summary>
<param name="code">Code to add the parameter to</param>
<param name="letter">Letter of the parameter to 0 if unprecedented</param>
<param name="value">Value of the parameter</param>
<param name="isQuoted">Whether the parameter is a quoted string</param>
<param name="isSingleParameter">Whether the parameter is definitely a single parameter</param>
</member>
<member name="M:DuetAPI.Commands.Code.ConvertDriverIds">
<summary>
Convert parameters of this code to driver id(s)
</summary>
<exception cref="T:DuetAPI.CodeParserException">Driver ID could not be parsed</exception>
</member>
<member name="M:DuetAPI.Commands.Code.ConvertDriverIds(DuetAPI.Commands.CodeParameter)">
<summary>
Convert a given parameter to driver id(s)
</summary>
<exception cref="T:DuetAPI.CodeParserException">Driver ID could not be parsed</exception>
</member>
<member name="M:DuetAPI.Commands.Code.ParseAsync(System.IO.StreamReader,DuetAPI.Commands.Code,DuetAPI.Commands.CodeParserBuffer)">
<summary>
Parse the next available G/M/T-code from the given stream reader asynchronously
</summary>
<param name="reader">Stream reader to read from</param>
<param name="result">Code to fill</param>
<param name="buffer">Internal buffer for parsing codes</param>
<returns>Whether anything could be read</returns>
<exception cref="T:DuetAPI.CodeParserException">Thrown if the code contains errors like unterminated strings or unterminated comments</exception>
</member>
<member name="M:DuetAPI.Commands.Code.ParseAsync(System.IO.Stream,DuetAPI.Commands.Code,DuetAPI.Commands.CodeParserBuffer,System.Threading.CancellationToken)">
<summary>
Parse the next available G/M/T-code from the given stream asynchronously
</summary>
<param name="stream">Stream to read from</param>
<param name="result">Code to fill</param>
<param name="buffer">Internal buffer for parsing codes</param>
<param name="cancellationToken">Cancellation token instance</param>
<returns>Whether anything could be read</returns>
<exception cref="T:System.ArgumentException">BOM from start of file showed that this file is neither ASCII nor UTF-8</exception>
<exception cref="T:DuetAPI.CodeParserException">Thrown if the code contains errors like unterminated strings or unterminated comments</exception>
</member>
<member name="T:DuetAPI.Commands.KeywordType">
<summary>
Enumeration of conditional G-code keywords
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.None">
<summary>
No conditional code
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.If">
<summary>
If condition
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.ElseIf">
<summary>
Else-if condition
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Else">
<summary>
Else condition
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.While">
<summary>
While condition
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Break">
<summary>
Break instruction
</summary>
<seealso cref="F:DuetAPI.Commands.KeywordType.While"/>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Abort">
<summary>
Abort instruction
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Var">
<summary>
Var operation
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Set">
<summary>
Set operation
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Echo">
<summary>
Echo operation
</summary>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Continue">
<summary>
Continue instruction
</summary>
<seealso cref="F:DuetAPI.Commands.KeywordType.While"/>
</member>
<member name="F:DuetAPI.Commands.KeywordType.Global">
<summary>
Global operation
</summary>
</member>
<member name="T:DuetAPI.Commands.CodeFlags">
<summary>
Code bits to classify G/M/T-codes
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.None">
<summary>
Placeholder to indicate that no flags are set
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.Asynchronous">
<summary>
Code execution finishes as soon as it is enqueued in the code queue
</summary>
<remarks>
If codes are started asynchronously, code replies are normally reported via the object model.
In order to keep track of code replies, an <see cref="F:DuetAPI.Connection.ConnectionMode.Intercept"/> connection
in <see cref="F:DuetAPI.Connection.InterceptionMode.Executed"/> mode can be used
</remarks>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsPreProcessed">
<summary>
Code has been preprocessed (i.e. it has been processed by the DCS pre-side code interceptors)
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsInternallyProcessed">
<summary>
Code has been processed internally (if this is set the internal execution of a code is skipped)
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsPostProcessed">
<summary>
Code has been postprocessed (i.e. it has been processed by the internal DCS code processor)
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsFromMacro">
<summary>
Code originates from a macro file
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsNestedMacro">
<summary>
Code originates from a system macro file (i.e. RRF requested it)
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsFromConfig">
<summary>
Code comes from config.g or config.g.bak
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsFromConfigOverride">
<summary>
Code comes from config-override.g
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.EnforceAbsolutePosition">
<summary>
Enforce absolute positioning via prefixed G53 code
</summary>
</member>
<member name="F:DuetAPI.Commands.CodeFlags.IsPrioritized">
<summary>
Execute this code as quickly as possible and skip codes that have the <see cref="F:DuetAPI.Commands.CodeFlags.Unbuffered"/> flag set
</summary>
<remarks>
In order to execute this code as quickly as possible, DCS attempts to change the <see cref="P:DuetAPI.Commands.Code.Channel"/> property
to a a code channel that is completely idle. If this fails, a warning is logged. This flag should be only used for
diagnostics and time-critical codes like M112/M122/M999