-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMethodInterfaces.h
More file actions
1427 lines (1096 loc) · 23.7 KB
/
Copy pathMethodInterfaces.h
File metadata and controls
1427 lines (1096 loc) · 23.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
#pragma once
#include"BaseLib/CommonDefines.h"
#include"BaseLib/Export.h"
namespace BaseLib { namespace Templates
{
// -------------------------------------------------------------------
// TODO:
// - Important: Commands are not events. Commands may lead to generation of events.
// - Define all events to be identifiable as events, i.e., "Something" using keys, enums, strings, etc
// - Autogenerate using class Event<Data> ?
// - Define one interface with one method for every event, i.e., class SomethingMethod { virtual void Something(); };
// - Define one reactive/observer method for every event, i.e., class SomethingObserver { virtual void OnSomething(); }
// - Implement one subject part for every event, i.e., class SomethingSubject { virtual void OnSomething() { somethingSignaller_.Signal(); }
// - Implement one actor/handler for every event, i.e., process incoming events
// - Implement strategies to process events, event-pairs, etc
// - Connect command chains of actors/handlers with conditional triggers
// -------------------------------------------------------------------
/**
* NOTE!
* - Method interfaces should not be used directly but rather subclassed.
* - If CLASS_TRAITS is used then virtual destructors ARE necessary
* - Only declare virtual destructor if methods can be deleted by client.
* - Possibly declare pure virtual destructor
*
*
* If object is to be a base class for all objects then inheritance must be virtual to avoid "diamond inheritance"
*
* AMethod : public virtual Object
*/
class Object
{
public:
virtual ~Object() {}
};
// --------------------------------------------
// Copy methods
// --------------------------------------------
template <typename Return>
class CopyMethod0
{
public:
virtual ~CopyMethod0() {}
virtual Return Copy() const = 0;
};
template <typename T, typename Arg1>
class CopyMethod1
{
public:
virtual ~CopyMethod1() {}
virtual T Copy(Arg1) const = 0;
};
template <typename T, typename Arg1, typename Arg2>
class CopyMethod2
{
public:
virtual ~CopyMethod2() {}
virtual T Copy(Arg1, Arg2) const = 0;
};
// --------------------------------------------
// Factory methods
// --------------------------------------------
template <typename Return>
class CreateMethod0
{
public:
virtual ~CreateMethod0() {}
virtual Return Create() = 0;
};
template <typename Return, typename Arg1>
class CreateMethod1
{
public:
virtual ~CreateMethod1() {}
virtual Return Create(Arg1) = 0;
};
template <typename Return, typename Arg1, typename Arg2>
class CreateMethod2
{
public:
virtual ~CreateMethod2() {}
virtual Return Create(Arg1, Arg2) = 0;
};
template <typename Return, typename Arg1, typename Arg2, typename Arg3>
class CreateMethod3
{
public:
virtual ~CreateMethod3() {}
virtual Return Create(Arg1, Arg2, Arg3) = 0;
};
template <typename Return, typename Arg1, typename Arg2, typename Arg3, typename Arg4>
class CreateMethod4
{
public:
virtual ~CreateMethod4() {}
virtual Return Create(Arg1, Arg2, Arg3, Arg4) = 0;
};
template <typename Return, typename Arg1, typename Arg2, typename Arg3, typename Arg4, typename Arg5>
class CreateMethod5
{
public:
virtual ~CreateMethod5() {}
virtual Return Create(Arg1, Arg2, Arg3, Arg4, Arg5) = 0;
};
class DLL_STATE IsCreatedMethod
{
public:
virtual ~IsCreatedMethod() {}
virtual bool IsCreated() const = 0;
};
// ----------------------------------------
// Object access methods
// ----------------------------------------
class DLL_STATE DeleteMethod
{
public:
virtual ~DeleteMethod() {}
virtual void Delete() = 0;
};
class DLL_STATE IsDeletedMethod
{
public:
virtual ~IsDeletedMethod() {}
virtual bool IsDeleted() const = 0;
};
class DLL_STATE ModifyMethod
{
public:
virtual ~ModifyMethod() {}
virtual void Modify() = 0;
};
class DLL_STATE IsModifiedMethod
{
public:
virtual ~IsModifiedMethod() {}
virtual bool IsModified() const = 0;
};
class DLL_STATE NotModifyMethod
{
public:
virtual ~NotModifyMethod() {}
virtual void NotModify() = 0;
};
class DLL_STATE IsNotModifiedMethod
{
public:
virtual ~IsNotModifiedMethod() {}
virtual bool IsNotModified() const = 0;
};
class DLL_STATE ReadMethod
{
public:
virtual ~ReadMethod() {}
virtual void Read() = 0;
};
class DLL_STATE IsReadMethod
{
public:
virtual ~IsReadMethod() {}
virtual bool IsRead() const = 0;
};
template <typename Return>
class SubscribeMethod
{
public:
virtual ~SubscribeMethod() {}
virtual Return Subscribe() = 0;
};
template <typename Return, typename Arg1>
class SubscribeMethod1
{
public:
virtual ~SubscribeMethod1() {}
virtual Return Subscribe(Arg1) = 0;
};
template <typename Return>
class UnsubscribeMethod
{
public:
virtual ~UnsubscribeMethod() {}
virtual Return Unsubscribe() = 0;
};
template <typename Return, typename Arg1>
class UnsubscribeMethod1
{
public:
virtual ~UnsubscribeMethod1() {}
virtual Return Unsubscribe(Arg1) = 0;
};
class DLL_STATE IsSubscribedMethod
{
public:
virtual ~IsSubscribedMethod() {}
virtual bool IsSubscribed() const = 0;
};
class DLL_STATE WriteMethod
{
public:
virtual ~WriteMethod() {}
virtual void Write() = 0;
};
class DLL_STATE IsWrittenMethod
{
public:
virtual ~IsWrittenMethod() {}
virtual bool IsWritten() const = 0;
};
class DLL_STATE PublishMethod
{
public:
virtual ~PublishMethod() {}
virtual void Publish() = 0;
};
class DLL_STATE IsPublishedMethod
{
public:
virtual ~IsPublishedMethod() {}
virtual bool IsPublished() const = 0;
};
template <typename Return>
class ResultMethod
{
public:
virtual ~ResultMethod() {}
virtual Return Result() const = 0;
};
template <typename Return, typename Arg1>
class ResultMethod1
{
public:
virtual ~ResultMethod1() {}
virtual Return Result(Arg1) const = 0;
};
// --------------------------------------------
// Typical interface methods
// --------------------------------------------
template <typename Return>
class LoginMethod
{
public:
virtual ~LoginMethod() {}
virtual Return Login() = 0;
};
class DLL_STATE IsLoggedInMethod
{
public:
virtual ~IsLoggedInMethod() {}
virtual bool IsLoggedIn() const = 0;
};
template <typename Return>
class ResetMethod
{
public:
virtual ~ResetMethod() {}
virtual Return Reset() = 0;
};
class DLL_STATE CloseMethod
{
public:
virtual ~CloseMethod() {}
virtual void Close() = 0;
};
class DLL_STATE IsClosedMethod
{
public:
virtual ~IsClosedMethod() {}
virtual bool IsClosed() const = 0;
};
class DLL_STATE CancelMethod
{
public:
virtual ~CancelMethod() {}
virtual bool Cancel() = 0;
};
class DLL_STATE IsCancelledMethod
{
public:
virtual ~IsCancelledMethod() {}
virtual bool IsCancelled() const = 0;
};
class DLL_STATE InterruptMethod
{
public:
virtual ~InterruptMethod() {}
virtual bool Interrupt() = 0;
};
class DLL_STATE IsInterruptedMethod
{
public:
virtual ~IsInterruptedMethod() {}
virtual bool IsInterrupted() const = 0;
};
class DLL_STATE DoneMethod
{
public:
virtual ~DoneMethod() {}
virtual bool Done() = 0;
};
class DLL_STATE IsDoneMethod
{
public:
virtual ~IsDoneMethod() {}
virtual bool IsDone() const = 0;
};
class DLL_STATE EmptyMethod
{
public:
virtual ~EmptyMethod() {}
virtual bool Empty() = 0;
};
class DLL_STATE IsEmptyMethod
{
public:
virtual ~IsEmptyMethod() {}
virtual bool IsEmpty() const = 0;
};
template <typename Return>
class SizeMethod
{
public:
virtual ~SizeMethod() {}
virtual Return Size() const = 0;
};
class DLL_STATE NullMethod
{
public:
virtual ~NullMethod() {}
virtual bool Null() = 0;
};
class DLL_STATE IsNullMethod
{
public:
virtual ~IsNullMethod() {}
virtual bool IsNull() const = 0;
};
class DLL_STATE TimeoutMethod
{
public:
virtual ~TimeoutMethod() {}
virtual void Timeout() = 0;
};
class DLL_STATE IsTimeoutMethod
{
public:
virtual ~IsTimeoutMethod() {}
virtual bool IsTimeout() const = 0;
};
template <typename Return>
class TimeoutInMethod
{
public:
virtual ~TimeoutInMethod() {}
virtual Return TimeoutIn() const = 0;
};
class DLL_STATE FinishMethod
{
public:
virtual ~FinishMethod() {}
virtual void Finish() = 0;
};
class DLL_STATE IsFinishedMethod
{
public:
virtual ~IsFinishedMethod() {}
virtual bool IsFinished() const = 0;
};
class DLL_STATE BlockMethod
{
public:
virtual ~BlockMethod() {}
virtual bool Block() = 0;
};
class DLL_STATE UnblockMethod
{
public:
virtual ~UnblockMethod() {}
virtual bool Unblock() = 0;
};
class DLL_STATE IsBlockedMethod
{
public:
virtual ~IsBlockedMethod() {}
virtual bool IsBlocked() const = 0;
};
/**
* @brief The RepeatMethod class, i.e., Again, OnceMore, etc
*/
class DLL_STATE RepeatMethod
{
public:
virtual ~RepeatMethod() {}
virtual bool Repeat() = 0;
};
template <typename Return, typename Arg1>
class WaitMethod
{
public:
virtual ~WaitMethod() {}
virtual Return Wait(Arg1) const = 0;
};
template <typename Return, typename Arg1>
class WaitForMethod1
{
public:
virtual ~WaitForMethod1() {}
virtual Return WaitFor(Arg1) const = 0;
};
template <typename Return, typename Arg1, typename Arg2>
class WaitForMethod2
{
public:
virtual ~WaitForMethod2() {}
virtual Return WaitFor(Arg1, Arg2) const = 0;
};
template <typename Return>
class PolicyMethod
{
public:
virtual ~PolicyMethod() {}
virtual Return Policy() const = 0;
};
class DLL_STATE IsPolicyViolatedMethod
{
public:
virtual ~IsPolicyViolatedMethod() {}
virtual bool IsPolicyViolated() const = 0;
};
template <typename Return>
class HistoryMethod
{
public:
virtual ~HistoryMethod() {}
virtual Return History() const = 0;
};
template <typename Return>
class IdMethod
{
public:
virtual ~IdMethod() {}
virtual Return Id() const = 0;
};
template <typename Return>
class DescriptionMethod
{
public:
virtual ~DescriptionMethod() {}
virtual Return Description() const = 0;
};
// ----------------------------------------
// Actions from track and field
// "On your mark", "Get set", "Start", "Stop"
// Typical race/run/execution methods
// ----------------------------------------
class DLL_STATE TakeYourMarkMethod
{
public:
virtual ~TakeYourMarkMethod() {}
virtual void TakeYourMark() = 0;
};
class DLL_STATE GetSetMethod
{
public:
virtual ~GetSetMethod() {}
virtual void GetSet() = 0;
};
class DLL_STATE ReadyMethod
{
public:
virtual ~ReadyMethod() {}
virtual void Ready() = 0;
};
template <typename Return>
class ReadyInMethod
{
public:
virtual ~ReadyInMethod() {}
virtual Return ReadyIn() const = 0;
};
class DLL_STATE IsReadyMethod
{
public:
virtual ~IsReadyMethod() {}
virtual bool IsReady() const = 0;
};
class DLL_STATE IsReceivedMethod
{
public:
virtual ~IsReceivedMethod() {}
virtual bool IsReceived() const = 0;
};
class DLL_STATE SuspendMethod
{
public:
virtual ~SuspendMethod() {}
virtual void Suspend() = 0;
};
class DLL_STATE IsSuspendedMethod
{
public:
virtual ~IsSuspendedMethod() {}
virtual bool IsSuspended() const = 0;
};
class DLL_STATE ResumeMethod
{
public:
virtual ~ResumeMethod() {}
virtual void Resume() = 0;
};
template <typename Return>
class AttachMethod
{
public:
virtual ~AttachMethod() {}
virtual Return Attach() = 0;
};
class DLL_STATE IsAttachedMethod
{
public:
virtual ~IsAttachedMethod() {}
virtual bool IsAttached() const = 0;
};
template <typename Return>
class DetachMethod
{
public:
virtual ~DetachMethod() {}
virtual Return Detach() = 0;
};
class DLL_STATE IsResumedMethod
{
public:
virtual ~IsResumedMethod() {}
virtual bool IsResumed() const = 0;
};
class DLL_STATE PostponeMethod
{
public:
virtual ~PostponeMethod() {}
virtual void Postpone() = 0;
};
class DLL_STATE IsPostponedMethod
{
public:
virtual ~IsPostponedMethod() {}
virtual bool IsPostponed() const = 0;
};
class DLL_STATE DeferMethod
{
public:
virtual ~DeferMethod() {}
virtual void Defer() = 0;
};
class DLL_STATE IsDeferredMethod
{
public:
virtual ~IsDeferredMethod() {}
virtual bool IsDeferred() const = 0;
};
class DLL_STATE IsFailureMethod
{
public:
virtual ~IsFailureMethod() {}
virtual bool IsFailure() const = 0;
};
class DLL_STATE StartMethod
{
public:
virtual ~StartMethod() {}
virtual void Start() = 0;
};
class DLL_STATE IsStartedMethod
{
public:
virtual ~IsStartedMethod() {}
virtual bool IsStarted() const = 0;
};
class DLL_STATE IsCurrentMethod
{
public:
virtual ~IsCurrentMethod() {}
virtual bool IsCurrent() const = 0;
};
class DLL_STATE IsStartingMethod
{
public:
virtual ~IsStartingMethod() {}
virtual bool IsStarting() const = 0;
};
class DLL_STATE FalseStartMethod
{
public:
virtual ~FalseStartMethod() {}
virtual void FalseStart() = 0;
};
class DLL_STATE GoMethod
{
public:
virtual ~GoMethod() {}
virtual void Go() = 0;
};
class DLL_STATE TriggerMethod
{
public:
virtual ~TriggerMethod() {}
virtual void Trigger() = 0;
};
class DLL_STATE IsTriggeredMethod
{
public:
virtual ~IsTriggeredMethod() {}
CLASS_TRAITS(IsTriggeredMethod)
virtual bool IsTriggered() const = 0;
};
class DLL_STATE UntriggerMethod
{
public:
virtual ~UntriggerMethod() {}
virtual void Untrigger() = 0;
};
class DLL_STATE StopMethod
{
public:
virtual ~StopMethod() {}
virtual void Stop() = 0;
};
class DLL_STATE IsStoppedMethod
{
public:
virtual ~IsStoppedMethod() {}
virtual bool IsStopped() const = 0;
};
template <typename Return>
class StopAndWaitMethod
{
public:
virtual ~StopAndWaitMethod() {}
virtual Return Stop(int64 msecs) = 0;
};
class DLL_STATE AbortMethod
{
public:
virtual ~AbortMethod() {}
virtual void Abort() = 0;
};
class DLL_STATE IsAbortedMethod
{
public:
virtual ~IsAbortedMethod() {}
virtual bool IsAborted() const = 0;
};
class DLL_STATE SuccessMethod
{
public:
virtual ~SuccessMethod() {}
virtual void Success() = 0;
};
class DLL_STATE IsSuccessMethod
{
public:
virtual ~IsSuccessMethod() {}
virtual bool IsSuccess() const = 0;
};
class DLL_STATE FailureMethod
{
public:
virtual ~FailureMethod() {}
virtual void Failure() = 0;
};
class DLL_STATE IsFailedMethod
{
public:
virtual ~IsFailedMethod() {}
virtual bool IsFailed() const = 0;
};
class DLL_STATE ErrorMethod
{
public:
virtual ~ErrorMethod() {}
virtual void Error() = 0;
};
template<typename Return, typename T>
class ErrorMethod1
{
public:
virtual ~ErrorMethod1() {}
virtual Return Error(T t) = 0;
};
class DLL_STATE CompleteMethod
{
public:
virtual ~CompleteMethod() {}
virtual bool Complete() = 0;
};
class DLL_STATE IsCompletedMethod
{
public:
virtual ~IsCompletedMethod() {}
virtual bool IsCompleted() const = 0;
};
template <typename T>
class VoidNextMethod1
{
public:
virtual ~VoidNextMethod1() {}
virtual void Next(T) = 0;
};
template <typename Return, typename T>
class NextMethod1
{
public:
virtual ~NextMethod1() {}
virtual Return Next(T) = 0;
};
template <typename Return>
class ScheduleMethod
{
public:
virtual ~ScheduleMethod() {}
virtual Return Schedule(int64 msecs) = 0;
};
class DLL_STATE IsScheduledMethod
{
public:
virtual ~IsScheduledMethod() {}
virtual bool IsScheduled() const = 0;
};
class DLL_STATE RunMethod
{
public:
virtual ~RunMethod() {}
virtual void Run() = 0;
};
class DLL_STATE IsRunningMethod
{
public:
virtual ~IsRunningMethod() {}
virtual bool IsRunning() const = 0;
};
class DLL_STATE IsIdleMethod
{
public:
virtual ~IsIdleMethod() {}
virtual bool IsIdle() const = 0;
};
class DLL_STATE RaceMethods
: public TakeYourMarkMethod
, public GetSetMethod
, public StartMethod
, public StopMethod
, public AbortMethod
, public SuccessMethod
, public FailureMethod
, public ErrorMethod
, public CompleteMethod
{
public:
virtual ~RaceMethods() {}
};
template <typename Return, typename T, typename Err>
class ReactorMethods
: public CompleteMethod
, public ErrorMethod1<bool, Err>
, public NextMethod1<Return, T>
{
public:
virtual ~ReactorMethods() {}
};
class DLL_STATE EntryMethod