-
Notifications
You must be signed in to change notification settings - Fork 58
Expand file tree
/
Copy pathActiveCommandsComponentAc.ref.hpp
More file actions
2160 lines (1811 loc) · 72.7 KB
/
ActiveCommandsComponentAc.ref.hpp
File metadata and controls
2160 lines (1811 loc) · 72.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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
// ======================================================================
// \title ActiveCommandsComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief hpp file for ActiveCommands component base class
// ======================================================================
#ifndef ActiveCommandsComponentAc_HPP
#define ActiveCommandsComponentAc_HPP
#include "AArrayAc.hpp"
#include "AliasTypedPortAc.hpp"
#include "AliasTypedReturnPortAc.hpp"
#include "AliasTypedReturnStringPortAc.hpp"
#include "EEnumAc.hpp"
#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Prm/PrmGetPortAc.hpp"
#include "Fw/Prm/PrmSetPortAc.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "NoArgsAliasStringReturnPortAc.hpp"
#include "NoArgsPortAc.hpp"
#include "NoArgsReturnPortAc.hpp"
#include "NoArgsStringReturnPortAc.hpp"
#include "Os/Mutex.hpp"
#include "SSerializableAc.hpp"
#include "TypedPortAc.hpp"
#include "TypedReturnPortAc.hpp"
//! \class ActiveCommandsComponentBase
//! \brief Auto-generated base for ActiveCommands component
//!
//! An active component with commands
class ActiveCommandsComponentBase :
public Fw::ActiveComponentBase
{
// ----------------------------------------------------------------------
// Friend classes
// ----------------------------------------------------------------------
//! Friend class for white-box testing
friend class ActiveCommandsComponentBaseFriend;
//! Friend class tester to support autocoded test harness
friend class ActiveCommandsTesterBase;
PROTECTED:
// ----------------------------------------------------------------------
// Constants
// ----------------------------------------------------------------------
//! Enumerations for numbers of special input ports
enum {
NUM_CMDIN_INPUT_PORTS = 1,
};
//! Enumerations for numbers of typed input ports
enum {
NUM_ALIASTYPEDASYNC_INPUT_PORTS = 1,
NUM_NOARGSALIASSTRINGRETURNSYNC_INPUT_PORTS = 1,
NUM_NOARGSASYNC_INPUT_PORTS = 1,
NUM_NOARGSGUARDED_INPUT_PORTS = 1,
NUM_NOARGSRETURNGUARDED_INPUT_PORTS = 1,
NUM_NOARGSRETURNSYNC_INPUT_PORTS = 3,
NUM_NOARGSSTRINGRETURNSYNC_INPUT_PORTS = 1,
NUM_NOARGSSYNC_INPUT_PORTS = 3,
NUM_TYPEDALIASGUARDED_INPUT_PORTS = 1,
NUM_TYPEDALIASRETURNSYNC_INPUT_PORTS = 3,
NUM_TYPEDALIASSTRINGRETURNSYNC_INPUT_PORTS = 3,
NUM_TYPEDASYNC_INPUT_PORTS = 1,
NUM_TYPEDASYNCASSERT_INPUT_PORTS = 1,
NUM_TYPEDASYNCBLOCKPRIORITY_INPUT_PORTS = 1,
NUM_TYPEDASYNCDROPPRIORITY_INPUT_PORTS = 1,
NUM_TYPEDGUARDED_INPUT_PORTS = 1,
NUM_TYPEDRETURNGUARDED_INPUT_PORTS = 1,
NUM_TYPEDRETURNSYNC_INPUT_PORTS = 3,
NUM_TYPEDSYNC_INPUT_PORTS = 3,
};
//! Enumerations for numbers of special output ports
enum {
NUM_CMDREGOUT_OUTPUT_PORTS = 1,
NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
NUM_EVENTOUT_OUTPUT_PORTS = 1,
NUM_PRMGETOUT_OUTPUT_PORTS = 1,
NUM_PRMSETOUT_OUTPUT_PORTS = 1,
NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
NUM_TIMEGETOUT_OUTPUT_PORTS = 1,
NUM_TLMOUT_OUTPUT_PORTS = 1,
};
//! Enumerations for numbers of typed output ports
enum {
NUM_NOARGSOUT_OUTPUT_PORTS = 1,
NUM_NOARGSRETURNOUT_OUTPUT_PORTS = 1,
NUM_NOARGSSTRINGRETURNOUT_OUTPUT_PORTS = 1,
NUM_TYPEDALIASOUT_OUTPUT_PORTS = 1,
NUM_TYPEDALIASRETURNOUT_OUTPUT_PORTS = 1,
NUM_TYPEDALIASRETURNSTRINGOUT_OUTPUT_PORTS = 1,
NUM_TYPEDOUT_OUTPUT_PORTS = 1,
NUM_TYPEDRETURNOUT_OUTPUT_PORTS = 1,
};
//! Command opcodes
enum {
OPCODE_CMD_SYNC = 0x0, //!< A sync command with no params
OPCODE_CMD_SYNC_PRIMITIVE = 0x10, //!< An async command with primitive params
OPCODE_CMD_SYNC_STRING = 0x11, //!< A sync command with string params
OPCODE_CMD_SYNC_ENUM = 0x12, //!< A sync command with enum params
OPCODE_CMD_SYNC_ARRAY = 0x13, //!< A sync command with array params
OPCODE_CMD_SYNC_STRUCT = 0x14, //!< A sync command with struct params
OPCODE_CMD_GUARDED = 0x15, //!< A guarded command with no params
OPCODE_CMD_GUARDED_PRIMITIVE = 0x16, //!< A guarded command with primitive params
OPCODE_CMD_GUARDED_STRING = 0x17, //!< A guarded command with string params
OPCODE_CMD_GUARDED_ENUM = 0x18, //!< A guarded command with enum params
OPCODE_CMD_GUARDED_ARRAY = 0x19, //!< A guarded command with array params
OPCODE_CMD_GUARDED_STRUCT = 0x1a, //!< A guarded command with struct params
OPCODE_CMD_ASYNC = 0x1b, //!< An async command with no params
OPCODE_CMD_PRIORITY = 0x20, //!< A command with priority
OPCODE_CMD_PARAMS_PRIORITY = 0x21, //!< A command with params and priority
OPCODE_CMD_DROP = 0x22, //!< A command with queue full behavior
OPCODE_CMD_PARAMS_PRIORITY_DROP = 0x23, //!< A command with params, priority, and queue full behavior
};
public:
// ----------------------------------------------------------------------
// Component initialization
// ----------------------------------------------------------------------
//! Initialize ActiveCommandsComponentBase object
void init(
FwSizeType queueDepth, //!< The queue depth
FwEnumStoreType instance = 0 //!< The instance number
);
public:
// ----------------------------------------------------------------------
// Getters for special input ports
// ----------------------------------------------------------------------
//! Get special input port at index
//!
//! \return cmdIn[portNum]
Fw::InputCmdPort* get_cmdIn_InputPort(
FwIndexType portNum //!< The port number
);
public:
// ----------------------------------------------------------------------
// Getters for typed input ports
// ----------------------------------------------------------------------
//! Get typed input port at index
//!
//! \return aliasTypedAsync[portNum]
Ports::InputAliasTypedPort* get_aliasTypedAsync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsAliasStringReturnSync[portNum]
Ports::InputNoArgsAliasStringReturnPort* get_noArgsAliasStringReturnSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsAsync[portNum]
Ports::InputNoArgsPort* get_noArgsAsync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsGuarded[portNum]
Ports::InputNoArgsPort* get_noArgsGuarded_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsReturnGuarded[portNum]
Ports::InputNoArgsReturnPort* get_noArgsReturnGuarded_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsReturnSync[portNum]
Ports::InputNoArgsReturnPort* get_noArgsReturnSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsStringReturnSync[portNum]
Ports::InputNoArgsStringReturnPort* get_noArgsStringReturnSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return noArgsSync[portNum]
Ports::InputNoArgsPort* get_noArgsSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAliasGuarded[portNum]
Ports::InputAliasTypedPort* get_typedAliasGuarded_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAliasReturnSync[portNum]
Ports::InputAliasTypedReturnPort* get_typedAliasReturnSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAliasStringReturnSync[portNum]
Ports::InputAliasTypedReturnStringPort* get_typedAliasStringReturnSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAsync[portNum]
Ports::InputTypedPort* get_typedAsync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAsyncAssert[portNum]
Ports::InputTypedPort* get_typedAsyncAssert_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAsyncBlockPriority[portNum]
Ports::InputTypedPort* get_typedAsyncBlockPriority_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedAsyncDropPriority[portNum]
Ports::InputTypedPort* get_typedAsyncDropPriority_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedGuarded[portNum]
Ports::InputTypedPort* get_typedGuarded_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedReturnGuarded[portNum]
Ports::InputTypedReturnPort* get_typedReturnGuarded_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedReturnSync[portNum]
Ports::InputTypedReturnPort* get_typedReturnSync_InputPort(
FwIndexType portNum //!< The port number
);
//! Get typed input port at index
//!
//! \return typedSync[portNum]
Ports::InputTypedPort* get_typedSync_InputPort(
FwIndexType portNum //!< The port number
);
public:
// ----------------------------------------------------------------------
// Connect input ports to special output ports
// ----------------------------------------------------------------------
//! Connect port to cmdRegOut[portNum]
void set_cmdRegOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputCmdRegPort* port //!< The input port
);
//! Connect port to cmdResponseOut[portNum]
void set_cmdResponseOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputCmdResponsePort* port //!< The input port
);
//! Connect port to eventOut[portNum]
void set_eventOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputLogPort* port //!< The input port
);
//! Connect port to prmGetOut[portNum]
void set_prmGetOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputPrmGetPort* port //!< The input port
);
//! Connect port to prmSetOut[portNum]
void set_prmSetOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputPrmSetPort* port //!< The input port
);
#if FW_ENABLE_TEXT_LOGGING == 1
//! Connect port to textEventOut[portNum]
void set_textEventOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputLogTextPort* port //!< The input port
);
#endif
//! Connect port to timeGetOut[portNum]
void set_timeGetOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputTimePort* port //!< The input port
);
//! Connect port to tlmOut[portNum]
void set_tlmOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputTlmPort* port //!< The input port
);
public:
// ----------------------------------------------------------------------
// Connect typed input ports to typed output ports
// ----------------------------------------------------------------------
//! Connect port to noArgsOut[portNum]
void set_noArgsOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputNoArgsPort* port //!< The input port
);
//! Connect port to noArgsReturnOut[portNum]
void set_noArgsReturnOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputNoArgsReturnPort* port //!< The input port
);
//! Connect port to noArgsStringReturnOut[portNum]
void set_noArgsStringReturnOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputNoArgsStringReturnPort* port //!< The input port
);
//! Connect port to typedAliasOut[portNum]
void set_typedAliasOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputAliasTypedPort* port //!< The input port
);
//! Connect port to typedAliasReturnOut[portNum]
void set_typedAliasReturnOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputAliasTypedReturnPort* port //!< The input port
);
//! Connect port to typedAliasReturnStringOut[portNum]
void set_typedAliasReturnStringOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputAliasTypedReturnStringPort* port //!< The input port
);
//! Connect port to typedOut[portNum]
void set_typedOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputTypedPort* port //!< The input port
);
//! Connect port to typedReturnOut[portNum]
void set_typedReturnOut_OutputPort(
FwIndexType portNum, //!< The port number
Ports::InputTypedReturnPort* port //!< The input port
);
#if FW_PORT_SERIALIZATION
public:
// ----------------------------------------------------------------------
// Connect serial input ports to special output ports
// ----------------------------------------------------------------------
//! Connect port to cmdRegOut[portNum]
void set_cmdRegOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
//! Connect port to cmdResponseOut[portNum]
void set_cmdResponseOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
//! Connect port to eventOut[portNum]
void set_eventOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
//! Connect port to prmSetOut[portNum]
void set_prmSetOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
#if FW_ENABLE_TEXT_LOGGING == 1
//! Connect port to textEventOut[portNum]
void set_textEventOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
#endif
//! Connect port to timeGetOut[portNum]
void set_timeGetOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
//! Connect port to tlmOut[portNum]
void set_tlmOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
#endif
#if FW_PORT_SERIALIZATION
public:
// ----------------------------------------------------------------------
// Connect serial input ports to typed output ports
// ----------------------------------------------------------------------
//! Connect port to noArgsOut[portNum]
void set_noArgsOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
//! Connect port to typedAliasOut[portNum]
void set_typedAliasOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
//! Connect port to typedOut[portNum]
void set_typedOut_OutputPort(
FwIndexType portNum, //!< The port number
Fw::InputSerializePort* port //!< The port
);
#endif
public:
// ----------------------------------------------------------------------
// Command registration
// ----------------------------------------------------------------------
//! \brief Register commands with the Command Dispatcher
//!
//! Connect the dispatcher first
void regCommands();
PROTECTED:
// ----------------------------------------------------------------------
// Component construction and destruction
// ----------------------------------------------------------------------
//! Construct ActiveCommandsComponentBase object
ActiveCommandsComponentBase(
const char* compName = "" //!< The component name
);
//! Destroy ActiveCommandsComponentBase object
virtual ~ActiveCommandsComponentBase();
PROTECTED:
// ----------------------------------------------------------------------
// Getters for numbers of special input ports
// ----------------------------------------------------------------------
//! Get the number of cmdIn input ports
//!
//! \return The number of cmdIn input ports
FwIndexType getNum_cmdIn_InputPorts() const;
PROTECTED:
// ----------------------------------------------------------------------
// Getters for numbers of typed input ports
// ----------------------------------------------------------------------
//! Get the number of aliasTypedAsync input ports
//!
//! \return The number of aliasTypedAsync input ports
FwIndexType getNum_aliasTypedAsync_InputPorts() const;
//! Get the number of noArgsAliasStringReturnSync input ports
//!
//! \return The number of noArgsAliasStringReturnSync input ports
FwIndexType getNum_noArgsAliasStringReturnSync_InputPorts() const;
//! Get the number of noArgsAsync input ports
//!
//! \return The number of noArgsAsync input ports
FwIndexType getNum_noArgsAsync_InputPorts() const;
//! Get the number of noArgsGuarded input ports
//!
//! \return The number of noArgsGuarded input ports
FwIndexType getNum_noArgsGuarded_InputPorts() const;
//! Get the number of noArgsReturnGuarded input ports
//!
//! \return The number of noArgsReturnGuarded input ports
FwIndexType getNum_noArgsReturnGuarded_InputPorts() const;
//! Get the number of noArgsReturnSync input ports
//!
//! \return The number of noArgsReturnSync input ports
FwIndexType getNum_noArgsReturnSync_InputPorts() const;
//! Get the number of noArgsStringReturnSync input ports
//!
//! \return The number of noArgsStringReturnSync input ports
FwIndexType getNum_noArgsStringReturnSync_InputPorts() const;
//! Get the number of noArgsSync input ports
//!
//! \return The number of noArgsSync input ports
FwIndexType getNum_noArgsSync_InputPorts() const;
//! Get the number of typedAliasGuarded input ports
//!
//! \return The number of typedAliasGuarded input ports
FwIndexType getNum_typedAliasGuarded_InputPorts() const;
//! Get the number of typedAliasReturnSync input ports
//!
//! \return The number of typedAliasReturnSync input ports
FwIndexType getNum_typedAliasReturnSync_InputPorts() const;
//! Get the number of typedAliasStringReturnSync input ports
//!
//! \return The number of typedAliasStringReturnSync input ports
FwIndexType getNum_typedAliasStringReturnSync_InputPorts() const;
//! Get the number of typedAsync input ports
//!
//! \return The number of typedAsync input ports
FwIndexType getNum_typedAsync_InputPorts() const;
//! Get the number of typedAsyncAssert input ports
//!
//! \return The number of typedAsyncAssert input ports
FwIndexType getNum_typedAsyncAssert_InputPorts() const;
//! Get the number of typedAsyncBlockPriority input ports
//!
//! \return The number of typedAsyncBlockPriority input ports
FwIndexType getNum_typedAsyncBlockPriority_InputPorts() const;
//! Get the number of typedAsyncDropPriority input ports
//!
//! \return The number of typedAsyncDropPriority input ports
FwIndexType getNum_typedAsyncDropPriority_InputPorts() const;
//! Get the number of typedGuarded input ports
//!
//! \return The number of typedGuarded input ports
FwIndexType getNum_typedGuarded_InputPorts() const;
//! Get the number of typedReturnGuarded input ports
//!
//! \return The number of typedReturnGuarded input ports
FwIndexType getNum_typedReturnGuarded_InputPorts() const;
//! Get the number of typedReturnSync input ports
//!
//! \return The number of typedReturnSync input ports
FwIndexType getNum_typedReturnSync_InputPorts() const;
//! Get the number of typedSync input ports
//!
//! \return The number of typedSync input ports
FwIndexType getNum_typedSync_InputPorts() const;
PROTECTED:
// ----------------------------------------------------------------------
// Getters for numbers of special output ports
// ----------------------------------------------------------------------
//! Get the number of cmdRegOut output ports
//!
//! \return The number of cmdRegOut output ports
FwIndexType getNum_cmdRegOut_OutputPorts() const;
//! Get the number of cmdResponseOut output ports
//!
//! \return The number of cmdResponseOut output ports
FwIndexType getNum_cmdResponseOut_OutputPorts() const;
//! Get the number of eventOut output ports
//!
//! \return The number of eventOut output ports
FwIndexType getNum_eventOut_OutputPorts() const;
//! Get the number of prmGetOut output ports
//!
//! \return The number of prmGetOut output ports
FwIndexType getNum_prmGetOut_OutputPorts() const;
//! Get the number of prmSetOut output ports
//!
//! \return The number of prmSetOut output ports
FwIndexType getNum_prmSetOut_OutputPorts() const;
#if FW_ENABLE_TEXT_LOGGING == 1
//! Get the number of textEventOut output ports
//!
//! \return The number of textEventOut output ports
FwIndexType getNum_textEventOut_OutputPorts() const;
#endif
//! Get the number of timeGetOut output ports
//!
//! \return The number of timeGetOut output ports
FwIndexType getNum_timeGetOut_OutputPorts() const;
//! Get the number of tlmOut output ports
//!
//! \return The number of tlmOut output ports
FwIndexType getNum_tlmOut_OutputPorts() const;
PROTECTED:
// ----------------------------------------------------------------------
// Getters for numbers of typed output ports
// ----------------------------------------------------------------------
//! Get the number of noArgsOut output ports
//!
//! \return The number of noArgsOut output ports
FwIndexType getNum_noArgsOut_OutputPorts() const;
//! Get the number of noArgsReturnOut output ports
//!
//! \return The number of noArgsReturnOut output ports
FwIndexType getNum_noArgsReturnOut_OutputPorts() const;
//! Get the number of noArgsStringReturnOut output ports
//!
//! \return The number of noArgsStringReturnOut output ports
FwIndexType getNum_noArgsStringReturnOut_OutputPorts() const;
//! Get the number of typedAliasOut output ports
//!
//! \return The number of typedAliasOut output ports
FwIndexType getNum_typedAliasOut_OutputPorts() const;
//! Get the number of typedAliasReturnOut output ports
//!
//! \return The number of typedAliasReturnOut output ports
FwIndexType getNum_typedAliasReturnOut_OutputPorts() const;
//! Get the number of typedAliasReturnStringOut output ports
//!
//! \return The number of typedAliasReturnStringOut output ports
FwIndexType getNum_typedAliasReturnStringOut_OutputPorts() const;
//! Get the number of typedOut output ports
//!
//! \return The number of typedOut output ports
FwIndexType getNum_typedOut_OutputPorts() const;
//! Get the number of typedReturnOut output ports
//!
//! \return The number of typedReturnOut output ports
FwIndexType getNum_typedReturnOut_OutputPorts() const;
PROTECTED:
// ----------------------------------------------------------------------
// Connection status queries for special output ports
// ----------------------------------------------------------------------
//! Check whether port cmdRegOut is connected
//!
//! \return Whether port cmdRegOut is connected
bool isConnected_cmdRegOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port cmdResponseOut is connected
//!
//! \return Whether port cmdResponseOut is connected
bool isConnected_cmdResponseOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port eventOut is connected
//!
//! \return Whether port eventOut is connected
bool isConnected_eventOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port prmGetOut is connected
//!
//! \return Whether port prmGetOut is connected
bool isConnected_prmGetOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port prmSetOut is connected
//!
//! \return Whether port prmSetOut is connected
bool isConnected_prmSetOut_OutputPort(
FwIndexType portNum //!< The port number
);
#if FW_ENABLE_TEXT_LOGGING == 1
//! Check whether port textEventOut is connected
//!
//! \return Whether port textEventOut is connected
bool isConnected_textEventOut_OutputPort(
FwIndexType portNum //!< The port number
);
#endif
//! Check whether port timeGetOut is connected
//!
//! \return Whether port timeGetOut is connected
bool isConnected_timeGetOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port tlmOut is connected
//!
//! \return Whether port tlmOut is connected
bool isConnected_tlmOut_OutputPort(
FwIndexType portNum //!< The port number
);
PROTECTED:
// ----------------------------------------------------------------------
// Connection status queries for typed output ports
// ----------------------------------------------------------------------
//! Check whether port noArgsOut is connected
//!
//! \return Whether port noArgsOut is connected
bool isConnected_noArgsOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port noArgsReturnOut is connected
//!
//! \return Whether port noArgsReturnOut is connected
bool isConnected_noArgsReturnOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port noArgsStringReturnOut is connected
//!
//! \return Whether port noArgsStringReturnOut is connected
bool isConnected_noArgsStringReturnOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port typedAliasOut is connected
//!
//! \return Whether port typedAliasOut is connected
bool isConnected_typedAliasOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port typedAliasReturnOut is connected
//!
//! \return Whether port typedAliasReturnOut is connected
bool isConnected_typedAliasReturnOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port typedAliasReturnStringOut is connected
//!
//! \return Whether port typedAliasReturnStringOut is connected
bool isConnected_typedAliasReturnStringOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port typedOut is connected
//!
//! \return Whether port typedOut is connected
bool isConnected_typedOut_OutputPort(
FwIndexType portNum //!< The port number
);
//! Check whether port typedReturnOut is connected
//!
//! \return Whether port typedReturnOut is connected
bool isConnected_typedReturnOut_OutputPort(
FwIndexType portNum //!< The port number
);
PROTECTED:
// ----------------------------------------------------------------------
// Handlers to implement for typed input ports
// ----------------------------------------------------------------------
//! Handler for input port aliasTypedAsync
virtual void aliasTypedAsync_handler(
FwIndexType portNum, //!< The port number
AliasPrim1 u32, //!< A primitive
AliasPrim2 f32, //!< Another primtive
AliasBool b, //!< A boolean
const Fw::StringBase& str2, //!< A string
const AliasEnum& e, //!< An enum
const AliasArray& a, //!< An array
const AliasStruct& s //!< A struct
) = 0;
//! Handler for input port noArgsAliasStringReturnSync
virtual Fw::String noArgsAliasStringReturnSync_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port noArgsAsync
virtual void noArgsAsync_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port noArgsGuarded
virtual void noArgsGuarded_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port noArgsReturnGuarded
virtual U32 noArgsReturnGuarded_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port noArgsReturnSync
virtual U32 noArgsReturnSync_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port noArgsStringReturnSync
virtual Fw::String noArgsStringReturnSync_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port noArgsSync
virtual void noArgsSync_handler(
FwIndexType portNum //!< The port number
) = 0;
//! Handler for input port typedAliasGuarded
virtual void typedAliasGuarded_handler(
FwIndexType portNum, //!< The port number
AliasPrim1 u32, //!< A primitive
AliasPrim2 f32, //!< Another primtive
AliasBool b, //!< A boolean
const Fw::StringBase& str2, //!< A string
const AliasEnum& e, //!< An enum
const AliasArray& a, //!< An array
const AliasStruct& s //!< A struct
) = 0;
//! Handler for input port typedAliasReturnSync
virtual AliasPrim2 typedAliasReturnSync_handler(
FwIndexType portNum, //!< The port number
AliasPrim1 u32, //!< A primitive
AliasPrim2 f32, //!< Another primtive
AliasBool b, //!< A boolean
const Fw::StringBase& str2, //!< A string
const AliasEnum& e, //!< An enum
const AliasArray& a, //!< An array
const AliasStruct& s //!< A struct
) = 0;
//! Handler for input port typedAliasStringReturnSync
virtual Fw::String typedAliasStringReturnSync_handler(
FwIndexType portNum, //!< The port number
AliasPrim1 u32, //!< A primitive
AliasPrim2 f32, //!< Another primtive
AliasBool b, //!< A boolean
const Fw::StringBase& str2, //!< A string
const AliasEnum& e, //!< An enum
const AliasArray& a, //!< An array
const AnotherAliasStruct& s //!< A struct
) = 0;
//! Handler for input port typedAsync
virtual void typedAsync_handler(
FwIndexType portNum, //!< The port number
U32 u32, //!< A U32
F32 f32, //!< An F32
bool b, //!< A boolean
const Fw::StringBase& str1, //!< A string
const E& e, //!< An enum
const A& a, //!< An array
const S& s //!< A struct
) = 0;
//! Handler for input port typedAsyncAssert
virtual void typedAsyncAssert_handler(
FwIndexType portNum, //!< The port number
U32 u32, //!< A U32
F32 f32, //!< An F32
bool b, //!< A boolean
const Fw::StringBase& str1, //!< A string
const E& e, //!< An enum
const A& a, //!< An array
const S& s //!< A struct
) = 0;
//! Handler for input port typedAsyncBlockPriority
virtual void typedAsyncBlockPriority_handler(
FwIndexType portNum, //!< The port number
U32 u32, //!< A U32
F32 f32, //!< An F32
bool b, //!< A boolean
const Fw::StringBase& str1, //!< A string
const E& e, //!< An enum
const A& a, //!< An array
const S& s //!< A struct
) = 0;
//! Handler for input port typedAsyncDropPriority
virtual void typedAsyncDropPriority_handler(
FwIndexType portNum, //!< The port number
U32 u32, //!< A U32
F32 f32, //!< An F32
bool b, //!< A boolean
const Fw::StringBase& str1, //!< A string
const E& e, //!< An enum
const A& a, //!< An array
const S& s //!< A struct
) = 0;
//! Handler for input port typedGuarded
virtual void typedGuarded_handler(
FwIndexType portNum, //!< The port number
U32 u32, //!< A U32
F32 f32, //!< An F32
bool b, //!< A boolean
const Fw::StringBase& str1, //!< A string