foxglove-sdk 0.6.2__cp312-cp312-win32.whl → 0.16.6__cp312-cp312-win32.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1053 +1,2860 @@
1
- # Generated by https://github.com/foxglove/foxglove-sdk
2
- from .schemas import (
3
- CameraCalibration,
4
- CircleAnnotation,
5
- Color,
6
- CompressedImage,
7
- CompressedVideo,
8
- FrameTransform,
9
- FrameTransforms,
10
- GeoJson,
11
- Grid,
12
- ImageAnnotations,
13
- KeyValuePair,
14
- LaserScan,
15
- LocationFix,
16
- Log,
17
- PackedElementField,
18
- Point2,
19
- Point3,
20
- PointCloud,
21
- PointsAnnotation,
22
- Pose,
23
- PoseInFrame,
24
- PosesInFrame,
25
- Quaternion,
26
- RawImage,
27
- SceneEntity,
28
- SceneEntityDeletion,
29
- SceneUpdate,
30
- TextAnnotation,
31
- Vector2,
32
- Vector3,
33
- )
34
-
35
- class CameraCalibrationChannel:
36
- """
37
- A channel for logging CameraCalibration messages
38
- """
39
-
40
- def __new__(
41
- cls,
42
- topic: str,
43
- ) -> "CameraCalibrationChannel": ...
44
- def id(self) -> int:
45
- """The unique ID of the channel."""
46
- ...
47
-
48
- def topic(self) -> str:
49
- """The topic name of the channel."""
50
- ...
51
-
52
- def schema_name(self) -> str | None:
53
- """The name of the schema for the channel."""
54
- ...
55
-
56
- def close(self) -> None:
57
- """Close the channel."""
58
- ...
59
-
60
- def log(
61
- self,
62
- message: "CameraCalibration",
63
- *,
64
- log_time: int | None = None,
65
- ) -> None:
66
- """Log a Foxglove CameraCalibration message on the channel."""
67
- ...
68
-
69
- class CircleAnnotationChannel:
70
- """
71
- A channel for logging CircleAnnotation messages
72
- """
73
-
74
- def __new__(
75
- cls,
76
- topic: str,
77
- ) -> "CircleAnnotationChannel": ...
78
- def id(self) -> int:
79
- """The unique ID of the channel."""
80
- ...
81
-
82
- def topic(self) -> str:
83
- """The topic name of the channel."""
84
- ...
85
-
86
- def schema_name(self) -> str | None:
87
- """The name of the schema for the channel."""
88
- ...
89
-
90
- def close(self) -> None:
91
- """Close the channel."""
92
- ...
93
-
94
- def log(
95
- self,
96
- message: "CircleAnnotation",
97
- *,
98
- log_time: int | None = None,
99
- ) -> None:
100
- """Log a Foxglove CircleAnnotation message on the channel."""
101
- ...
102
-
103
- class ColorChannel:
104
- """
105
- A channel for logging Color messages
106
- """
107
-
108
- def __new__(
109
- cls,
110
- topic: str,
111
- ) -> "ColorChannel": ...
112
- def id(self) -> int:
113
- """The unique ID of the channel."""
114
- ...
115
-
116
- def topic(self) -> str:
117
- """The topic name of the channel."""
118
- ...
119
-
120
- def schema_name(self) -> str | None:
121
- """The name of the schema for the channel."""
122
- ...
123
-
124
- def close(self) -> None:
125
- """Close the channel."""
126
- ...
127
-
128
- def log(
129
- self,
130
- message: "Color",
131
- *,
132
- log_time: int | None = None,
133
- ) -> None:
134
- """Log a Foxglove Color message on the channel."""
135
- ...
136
-
137
- class CompressedImageChannel:
138
- """
139
- A channel for logging CompressedImage messages
140
- """
141
-
142
- def __new__(
143
- cls,
144
- topic: str,
145
- ) -> "CompressedImageChannel": ...
146
- def id(self) -> int:
147
- """The unique ID of the channel."""
148
- ...
149
-
150
- def topic(self) -> str:
151
- """The topic name of the channel."""
152
- ...
153
-
154
- def schema_name(self) -> str | None:
155
- """The name of the schema for the channel."""
156
- ...
157
-
158
- def close(self) -> None:
159
- """Close the channel."""
160
- ...
161
-
162
- def log(
163
- self,
164
- message: "CompressedImage",
165
- *,
166
- log_time: int | None = None,
167
- ) -> None:
168
- """Log a Foxglove CompressedImage message on the channel."""
169
- ...
170
-
171
- class CompressedVideoChannel:
172
- """
173
- A channel for logging CompressedVideo messages
174
- """
175
-
176
- def __new__(
177
- cls,
178
- topic: str,
179
- ) -> "CompressedVideoChannel": ...
180
- def id(self) -> int:
181
- """The unique ID of the channel."""
182
- ...
183
-
184
- def topic(self) -> str:
185
- """The topic name of the channel."""
186
- ...
187
-
188
- def schema_name(self) -> str | None:
189
- """The name of the schema for the channel."""
190
- ...
191
-
192
- def close(self) -> None:
193
- """Close the channel."""
194
- ...
195
-
196
- def log(
197
- self,
198
- message: "CompressedVideo",
199
- *,
200
- log_time: int | None = None,
201
- ) -> None:
202
- """Log a Foxglove CompressedVideo message on the channel."""
203
- ...
204
-
205
- class FrameTransformChannel:
206
- """
207
- A channel for logging FrameTransform messages
208
- """
209
-
210
- def __new__(
211
- cls,
212
- topic: str,
213
- ) -> "FrameTransformChannel": ...
214
- def id(self) -> int:
215
- """The unique ID of the channel."""
216
- ...
217
-
218
- def topic(self) -> str:
219
- """The topic name of the channel."""
220
- ...
221
-
222
- def schema_name(self) -> str | None:
223
- """The name of the schema for the channel."""
224
- ...
225
-
226
- def close(self) -> None:
227
- """Close the channel."""
228
- ...
229
-
230
- def log(
231
- self,
232
- message: "FrameTransform",
233
- *,
234
- log_time: int | None = None,
235
- ) -> None:
236
- """Log a Foxglove FrameTransform message on the channel."""
237
- ...
238
-
239
- class FrameTransformsChannel:
240
- """
241
- A channel for logging FrameTransforms messages
242
- """
243
-
244
- def __new__(
245
- cls,
246
- topic: str,
247
- ) -> "FrameTransformsChannel": ...
248
- def id(self) -> int:
249
- """The unique ID of the channel."""
250
- ...
251
-
252
- def topic(self) -> str:
253
- """The topic name of the channel."""
254
- ...
255
-
256
- def schema_name(self) -> str | None:
257
- """The name of the schema for the channel."""
258
- ...
259
-
260
- def close(self) -> None:
261
- """Close the channel."""
262
- ...
263
-
264
- def log(
265
- self,
266
- message: "FrameTransforms",
267
- *,
268
- log_time: int | None = None,
269
- ) -> None:
270
- """Log a Foxglove FrameTransforms message on the channel."""
271
- ...
272
-
273
- class GeoJsonChannel:
274
- """
275
- A channel for logging GeoJson messages
276
- """
277
-
278
- def __new__(
279
- cls,
280
- topic: str,
281
- ) -> "GeoJsonChannel": ...
282
- def id(self) -> int:
283
- """The unique ID of the channel."""
284
- ...
285
-
286
- def topic(self) -> str:
287
- """The topic name of the channel."""
288
- ...
289
-
290
- def schema_name(self) -> str | None:
291
- """The name of the schema for the channel."""
292
- ...
293
-
294
- def close(self) -> None:
295
- """Close the channel."""
296
- ...
297
-
298
- def log(
299
- self,
300
- message: "GeoJson",
301
- *,
302
- log_time: int | None = None,
303
- ) -> None:
304
- """Log a Foxglove GeoJson message on the channel."""
305
- ...
306
-
307
- class GridChannel:
308
- """
309
- A channel for logging Grid messages
310
- """
311
-
312
- def __new__(
313
- cls,
314
- topic: str,
315
- ) -> "GridChannel": ...
316
- def id(self) -> int:
317
- """The unique ID of the channel."""
318
- ...
319
-
320
- def topic(self) -> str:
321
- """The topic name of the channel."""
322
- ...
323
-
324
- def schema_name(self) -> str | None:
325
- """The name of the schema for the channel."""
326
- ...
327
-
328
- def close(self) -> None:
329
- """Close the channel."""
330
- ...
331
-
332
- def log(
333
- self,
334
- message: "Grid",
335
- *,
336
- log_time: int | None = None,
337
- ) -> None:
338
- """Log a Foxglove Grid message on the channel."""
339
- ...
340
-
341
- class ImageAnnotationsChannel:
342
- """
343
- A channel for logging ImageAnnotations messages
344
- """
345
-
346
- def __new__(
347
- cls,
348
- topic: str,
349
- ) -> "ImageAnnotationsChannel": ...
350
- def id(self) -> int:
351
- """The unique ID of the channel."""
352
- ...
353
-
354
- def topic(self) -> str:
355
- """The topic name of the channel."""
356
- ...
357
-
358
- def schema_name(self) -> str | None:
359
- """The name of the schema for the channel."""
360
- ...
361
-
362
- def close(self) -> None:
363
- """Close the channel."""
364
- ...
365
-
366
- def log(
367
- self,
368
- message: "ImageAnnotations",
369
- *,
370
- log_time: int | None = None,
371
- ) -> None:
372
- """Log a Foxglove ImageAnnotations message on the channel."""
373
- ...
374
-
375
- class KeyValuePairChannel:
376
- """
377
- A channel for logging KeyValuePair messages
378
- """
379
-
380
- def __new__(
381
- cls,
382
- topic: str,
383
- ) -> "KeyValuePairChannel": ...
384
- def id(self) -> int:
385
- """The unique ID of the channel."""
386
- ...
387
-
388
- def topic(self) -> str:
389
- """The topic name of the channel."""
390
- ...
391
-
392
- def schema_name(self) -> str | None:
393
- """The name of the schema for the channel."""
394
- ...
395
-
396
- def close(self) -> None:
397
- """Close the channel."""
398
- ...
399
-
400
- def log(
401
- self,
402
- message: "KeyValuePair",
403
- *,
404
- log_time: int | None = None,
405
- ) -> None:
406
- """Log a Foxglove KeyValuePair message on the channel."""
407
- ...
408
-
409
- class LaserScanChannel:
410
- """
411
- A channel for logging LaserScan messages
412
- """
413
-
414
- def __new__(
415
- cls,
416
- topic: str,
417
- ) -> "LaserScanChannel": ...
418
- def id(self) -> int:
419
- """The unique ID of the channel."""
420
- ...
421
-
422
- def topic(self) -> str:
423
- """The topic name of the channel."""
424
- ...
425
-
426
- def schema_name(self) -> str | None:
427
- """The name of the schema for the channel."""
428
- ...
429
-
430
- def close(self) -> None:
431
- """Close the channel."""
432
- ...
433
-
434
- def log(
435
- self,
436
- message: "LaserScan",
437
- *,
438
- log_time: int | None = None,
439
- ) -> None:
440
- """Log a Foxglove LaserScan message on the channel."""
441
- ...
442
-
443
- class LocationFixChannel:
444
- """
445
- A channel for logging LocationFix messages
446
- """
447
-
448
- def __new__(
449
- cls,
450
- topic: str,
451
- ) -> "LocationFixChannel": ...
452
- def id(self) -> int:
453
- """The unique ID of the channel."""
454
- ...
455
-
456
- def topic(self) -> str:
457
- """The topic name of the channel."""
458
- ...
459
-
460
- def schema_name(self) -> str | None:
461
- """The name of the schema for the channel."""
462
- ...
463
-
464
- def close(self) -> None:
465
- """Close the channel."""
466
- ...
467
-
468
- def log(
469
- self,
470
- message: "LocationFix",
471
- *,
472
- log_time: int | None = None,
473
- ) -> None:
474
- """Log a Foxglove LocationFix message on the channel."""
475
- ...
476
-
477
- class LogChannel:
478
- """
479
- A channel for logging Log messages
480
- """
481
-
482
- def __new__(
483
- cls,
484
- topic: str,
485
- ) -> "LogChannel": ...
486
- def id(self) -> int:
487
- """The unique ID of the channel."""
488
- ...
489
-
490
- def topic(self) -> str:
491
- """The topic name of the channel."""
492
- ...
493
-
494
- def schema_name(self) -> str | None:
495
- """The name of the schema for the channel."""
496
- ...
497
-
498
- def close(self) -> None:
499
- """Close the channel."""
500
- ...
501
-
502
- def log(
503
- self,
504
- message: "Log",
505
- *,
506
- log_time: int | None = None,
507
- ) -> None:
508
- """Log a Foxglove Log message on the channel."""
509
- ...
510
-
511
- class PackedElementFieldChannel:
512
- """
513
- A channel for logging PackedElementField messages
514
- """
515
-
516
- def __new__(
517
- cls,
518
- topic: str,
519
- ) -> "PackedElementFieldChannel": ...
520
- def id(self) -> int:
521
- """The unique ID of the channel."""
522
- ...
523
-
524
- def topic(self) -> str:
525
- """The topic name of the channel."""
526
- ...
527
-
528
- def schema_name(self) -> str | None:
529
- """The name of the schema for the channel."""
530
- ...
531
-
532
- def close(self) -> None:
533
- """Close the channel."""
534
- ...
535
-
536
- def log(
537
- self,
538
- message: "PackedElementField",
539
- *,
540
- log_time: int | None = None,
541
- ) -> None:
542
- """Log a Foxglove PackedElementField message on the channel."""
543
- ...
544
-
545
- class Point2Channel:
546
- """
547
- A channel for logging Point2 messages
548
- """
549
-
550
- def __new__(
551
- cls,
552
- topic: str,
553
- ) -> "Point2Channel": ...
554
- def id(self) -> int:
555
- """The unique ID of the channel."""
556
- ...
557
-
558
- def topic(self) -> str:
559
- """The topic name of the channel."""
560
- ...
561
-
562
- def schema_name(self) -> str | None:
563
- """The name of the schema for the channel."""
564
- ...
565
-
566
- def close(self) -> None:
567
- """Close the channel."""
568
- ...
569
-
570
- def log(
571
- self,
572
- message: "Point2",
573
- *,
574
- log_time: int | None = None,
575
- ) -> None:
576
- """Log a Foxglove Point2 message on the channel."""
577
- ...
578
-
579
- class Point3Channel:
580
- """
581
- A channel for logging Point3 messages
582
- """
583
-
584
- def __new__(
585
- cls,
586
- topic: str,
587
- ) -> "Point3Channel": ...
588
- def id(self) -> int:
589
- """The unique ID of the channel."""
590
- ...
591
-
592
- def topic(self) -> str:
593
- """The topic name of the channel."""
594
- ...
595
-
596
- def schema_name(self) -> str | None:
597
- """The name of the schema for the channel."""
598
- ...
599
-
600
- def close(self) -> None:
601
- """Close the channel."""
602
- ...
603
-
604
- def log(
605
- self,
606
- message: "Point3",
607
- *,
608
- log_time: int | None = None,
609
- ) -> None:
610
- """Log a Foxglove Point3 message on the channel."""
611
- ...
612
-
613
- class PointCloudChannel:
614
- """
615
- A channel for logging PointCloud messages
616
- """
617
-
618
- def __new__(
619
- cls,
620
- topic: str,
621
- ) -> "PointCloudChannel": ...
622
- def id(self) -> int:
623
- """The unique ID of the channel."""
624
- ...
625
-
626
- def topic(self) -> str:
627
- """The topic name of the channel."""
628
- ...
629
-
630
- def schema_name(self) -> str | None:
631
- """The name of the schema for the channel."""
632
- ...
633
-
634
- def close(self) -> None:
635
- """Close the channel."""
636
- ...
637
-
638
- def log(
639
- self,
640
- message: "PointCloud",
641
- *,
642
- log_time: int | None = None,
643
- ) -> None:
644
- """Log a Foxglove PointCloud message on the channel."""
645
- ...
646
-
647
- class PointsAnnotationChannel:
648
- """
649
- A channel for logging PointsAnnotation messages
650
- """
651
-
652
- def __new__(
653
- cls,
654
- topic: str,
655
- ) -> "PointsAnnotationChannel": ...
656
- def id(self) -> int:
657
- """The unique ID of the channel."""
658
- ...
659
-
660
- def topic(self) -> str:
661
- """The topic name of the channel."""
662
- ...
663
-
664
- def schema_name(self) -> str | None:
665
- """The name of the schema for the channel."""
666
- ...
667
-
668
- def close(self) -> None:
669
- """Close the channel."""
670
- ...
671
-
672
- def log(
673
- self,
674
- message: "PointsAnnotation",
675
- *,
676
- log_time: int | None = None,
677
- ) -> None:
678
- """Log a Foxglove PointsAnnotation message on the channel."""
679
- ...
680
-
681
- class PoseChannel:
682
- """
683
- A channel for logging Pose messages
684
- """
685
-
686
- def __new__(
687
- cls,
688
- topic: str,
689
- ) -> "PoseChannel": ...
690
- def id(self) -> int:
691
- """The unique ID of the channel."""
692
- ...
693
-
694
- def topic(self) -> str:
695
- """The topic name of the channel."""
696
- ...
697
-
698
- def schema_name(self) -> str | None:
699
- """The name of the schema for the channel."""
700
- ...
701
-
702
- def close(self) -> None:
703
- """Close the channel."""
704
- ...
705
-
706
- def log(
707
- self,
708
- message: "Pose",
709
- *,
710
- log_time: int | None = None,
711
- ) -> None:
712
- """Log a Foxglove Pose message on the channel."""
713
- ...
714
-
715
- class PoseInFrameChannel:
716
- """
717
- A channel for logging PoseInFrame messages
718
- """
719
-
720
- def __new__(
721
- cls,
722
- topic: str,
723
- ) -> "PoseInFrameChannel": ...
724
- def id(self) -> int:
725
- """The unique ID of the channel."""
726
- ...
727
-
728
- def topic(self) -> str:
729
- """The topic name of the channel."""
730
- ...
731
-
732
- def schema_name(self) -> str | None:
733
- """The name of the schema for the channel."""
734
- ...
735
-
736
- def close(self) -> None:
737
- """Close the channel."""
738
- ...
739
-
740
- def log(
741
- self,
742
- message: "PoseInFrame",
743
- *,
744
- log_time: int | None = None,
745
- ) -> None:
746
- """Log a Foxglove PoseInFrame message on the channel."""
747
- ...
748
-
749
- class PosesInFrameChannel:
750
- """
751
- A channel for logging PosesInFrame messages
752
- """
753
-
754
- def __new__(
755
- cls,
756
- topic: str,
757
- ) -> "PosesInFrameChannel": ...
758
- def id(self) -> int:
759
- """The unique ID of the channel."""
760
- ...
761
-
762
- def topic(self) -> str:
763
- """The topic name of the channel."""
764
- ...
765
-
766
- def schema_name(self) -> str | None:
767
- """The name of the schema for the channel."""
768
- ...
769
-
770
- def close(self) -> None:
771
- """Close the channel."""
772
- ...
773
-
774
- def log(
775
- self,
776
- message: "PosesInFrame",
777
- *,
778
- log_time: int | None = None,
779
- ) -> None:
780
- """Log a Foxglove PosesInFrame message on the channel."""
781
- ...
782
-
783
- class QuaternionChannel:
784
- """
785
- A channel for logging Quaternion messages
786
- """
787
-
788
- def __new__(
789
- cls,
790
- topic: str,
791
- ) -> "QuaternionChannel": ...
792
- def id(self) -> int:
793
- """The unique ID of the channel."""
794
- ...
795
-
796
- def topic(self) -> str:
797
- """The topic name of the channel."""
798
- ...
799
-
800
- def schema_name(self) -> str | None:
801
- """The name of the schema for the channel."""
802
- ...
803
-
804
- def close(self) -> None:
805
- """Close the channel."""
806
- ...
807
-
808
- def log(
809
- self,
810
- message: "Quaternion",
811
- *,
812
- log_time: int | None = None,
813
- ) -> None:
814
- """Log a Foxglove Quaternion message on the channel."""
815
- ...
816
-
817
- class RawImageChannel:
818
- """
819
- A channel for logging RawImage messages
820
- """
821
-
822
- def __new__(
823
- cls,
824
- topic: str,
825
- ) -> "RawImageChannel": ...
826
- def id(self) -> int:
827
- """The unique ID of the channel."""
828
- ...
829
-
830
- def topic(self) -> str:
831
- """The topic name of the channel."""
832
- ...
833
-
834
- def schema_name(self) -> str | None:
835
- """The name of the schema for the channel."""
836
- ...
837
-
838
- def close(self) -> None:
839
- """Close the channel."""
840
- ...
841
-
842
- def log(
843
- self,
844
- message: "RawImage",
845
- *,
846
- log_time: int | None = None,
847
- ) -> None:
848
- """Log a Foxglove RawImage message on the channel."""
849
- ...
850
-
851
- class SceneEntityChannel:
852
- """
853
- A channel for logging SceneEntity messages
854
- """
855
-
856
- def __new__(
857
- cls,
858
- topic: str,
859
- ) -> "SceneEntityChannel": ...
860
- def id(self) -> int:
861
- """The unique ID of the channel."""
862
- ...
863
-
864
- def topic(self) -> str:
865
- """The topic name of the channel."""
866
- ...
867
-
868
- def schema_name(self) -> str | None:
869
- """The name of the schema for the channel."""
870
- ...
871
-
872
- def close(self) -> None:
873
- """Close the channel."""
874
- ...
875
-
876
- def log(
877
- self,
878
- message: "SceneEntity",
879
- *,
880
- log_time: int | None = None,
881
- ) -> None:
882
- """Log a Foxglove SceneEntity message on the channel."""
883
- ...
884
-
885
- class SceneEntityDeletionChannel:
886
- """
887
- A channel for logging SceneEntityDeletion messages
888
- """
889
-
890
- def __new__(
891
- cls,
892
- topic: str,
893
- ) -> "SceneEntityDeletionChannel": ...
894
- def id(self) -> int:
895
- """The unique ID of the channel."""
896
- ...
897
-
898
- def topic(self) -> str:
899
- """The topic name of the channel."""
900
- ...
901
-
902
- def schema_name(self) -> str | None:
903
- """The name of the schema for the channel."""
904
- ...
905
-
906
- def close(self) -> None:
907
- """Close the channel."""
908
- ...
909
-
910
- def log(
911
- self,
912
- message: "SceneEntityDeletion",
913
- *,
914
- log_time: int | None = None,
915
- ) -> None:
916
- """Log a Foxglove SceneEntityDeletion message on the channel."""
917
- ...
918
-
919
- class SceneUpdateChannel:
920
- """
921
- A channel for logging SceneUpdate messages
922
- """
923
-
924
- def __new__(
925
- cls,
926
- topic: str,
927
- ) -> "SceneUpdateChannel": ...
928
- def id(self) -> int:
929
- """The unique ID of the channel."""
930
- ...
931
-
932
- def topic(self) -> str:
933
- """The topic name of the channel."""
934
- ...
935
-
936
- def schema_name(self) -> str | None:
937
- """The name of the schema for the channel."""
938
- ...
939
-
940
- def close(self) -> None:
941
- """Close the channel."""
942
- ...
943
-
944
- def log(
945
- self,
946
- message: "SceneUpdate",
947
- *,
948
- log_time: int | None = None,
949
- ) -> None:
950
- """Log a Foxglove SceneUpdate message on the channel."""
951
- ...
952
-
953
- class TextAnnotationChannel:
954
- """
955
- A channel for logging TextAnnotation messages
956
- """
957
-
958
- def __new__(
959
- cls,
960
- topic: str,
961
- ) -> "TextAnnotationChannel": ...
962
- def id(self) -> int:
963
- """The unique ID of the channel."""
964
- ...
965
-
966
- def topic(self) -> str:
967
- """The topic name of the channel."""
968
- ...
969
-
970
- def schema_name(self) -> str | None:
971
- """The name of the schema for the channel."""
972
- ...
973
-
974
- def close(self) -> None:
975
- """Close the channel."""
976
- ...
977
-
978
- def log(
979
- self,
980
- message: "TextAnnotation",
981
- *,
982
- log_time: int | None = None,
983
- ) -> None:
984
- """Log a Foxglove TextAnnotation message on the channel."""
985
- ...
986
-
987
- class Vector2Channel:
988
- """
989
- A channel for logging Vector2 messages
990
- """
991
-
992
- def __new__(
993
- cls,
994
- topic: str,
995
- ) -> "Vector2Channel": ...
996
- def id(self) -> int:
997
- """The unique ID of the channel."""
998
- ...
999
-
1000
- def topic(self) -> str:
1001
- """The topic name of the channel."""
1002
- ...
1003
-
1004
- def schema_name(self) -> str | None:
1005
- """The name of the schema for the channel."""
1006
- ...
1007
-
1008
- def close(self) -> None:
1009
- """Close the channel."""
1010
- ...
1011
-
1012
- def log(
1013
- self,
1014
- message: "Vector2",
1015
- *,
1016
- log_time: int | None = None,
1017
- ) -> None:
1018
- """Log a Foxglove Vector2 message on the channel."""
1019
- ...
1020
-
1021
- class Vector3Channel:
1022
- """
1023
- A channel for logging Vector3 messages
1024
- """
1025
-
1026
- def __new__(
1027
- cls,
1028
- topic: str,
1029
- ) -> "Vector3Channel": ...
1030
- def id(self) -> int:
1031
- """The unique ID of the channel."""
1032
- ...
1033
-
1034
- def topic(self) -> str:
1035
- """The topic name of the channel."""
1036
- ...
1037
-
1038
- def schema_name(self) -> str | None:
1039
- """The name of the schema for the channel."""
1040
- ...
1041
-
1042
- def close(self) -> None:
1043
- """Close the channel."""
1044
- ...
1045
-
1046
- def log(
1047
- self,
1048
- message: "Vector3",
1049
- *,
1050
- log_time: int | None = None,
1051
- ) -> None:
1052
- """Log a Foxglove Vector3 message on the channel."""
1053
- ...
1
+ # Generated by https://github.com/foxglove/foxglove-sdk
2
+ from . import Context, Schema
3
+ from .schemas import (
4
+ ArrowPrimitive,
5
+ CameraCalibration,
6
+ CircleAnnotation,
7
+ Color,
8
+ CompressedImage,
9
+ CompressedVideo,
10
+ CubePrimitive,
11
+ CylinderPrimitive,
12
+ FrameTransform,
13
+ FrameTransforms,
14
+ GeoJson,
15
+ Grid,
16
+ ImageAnnotations,
17
+ KeyValuePair,
18
+ LaserScan,
19
+ LinePrimitive,
20
+ LocationFix,
21
+ LocationFixes,
22
+ Log,
23
+ ModelPrimitive,
24
+ PackedElementField,
25
+ Point2,
26
+ Point3,
27
+ Point3InFrame,
28
+ PointCloud,
29
+ PointsAnnotation,
30
+ Pose,
31
+ PoseInFrame,
32
+ PosesInFrame,
33
+ Quaternion,
34
+ RawAudio,
35
+ RawImage,
36
+ SceneEntity,
37
+ SceneEntityDeletion,
38
+ SceneUpdate,
39
+ SpherePrimitive,
40
+ TextAnnotation,
41
+ TextPrimitive,
42
+ TriangleListPrimitive,
43
+ Vector2,
44
+ Vector3,
45
+ VoxelGrid,
46
+ )
47
+
48
+ class ArrowPrimitiveChannel:
49
+ """
50
+ A channel for logging ArrowPrimitive messages
51
+
52
+ You should choose a unique topic name per channel.
53
+ """
54
+
55
+ def __init__(
56
+ self,
57
+ topic: str,
58
+ *,
59
+ metadata: dict[str, str] | None = None,
60
+ context: Context | None = None,
61
+ ) -> None: ...
62
+ def id(self) -> int:
63
+ """The unique ID of the channel."""
64
+ ...
65
+
66
+ def topic(self) -> str:
67
+ """The topic name of the channel."""
68
+ ...
69
+
70
+ @property
71
+ def message_encoding(self) -> str:
72
+ """The message encoding for the channel"""
73
+ ...
74
+
75
+ def metadata(self) -> dict[str, str]:
76
+ """
77
+ Returns a copy of the channel's metadata.
78
+
79
+ Note that changes made to the returned dictionary will not be applied to
80
+ the channel's metadata.
81
+ """
82
+ ...
83
+
84
+ def schema(self) -> Schema | None:
85
+ """
86
+ Returns a copy of the channel's schema.
87
+
88
+ Note that changes made to the returned object will not be applied to
89
+ the channel's schema.
90
+ """
91
+ ...
92
+
93
+ def schema_name(self) -> str | None:
94
+ """The name of the schema for the channel."""
95
+ ...
96
+
97
+ def has_sinks(self) -> bool:
98
+ """Returns true if at least one sink is subscribed to this channel"""
99
+ ...
100
+
101
+ def close(self) -> None:
102
+ """Close the channel."""
103
+ ...
104
+
105
+ def log(
106
+ self,
107
+ message: "ArrowPrimitive",
108
+ *,
109
+ log_time: int | None = None,
110
+ sink_id: int | None = None,
111
+ ) -> None:
112
+ """Log a Foxglove ArrowPrimitive message on the channel."""
113
+ ...
114
+
115
+ class CameraCalibrationChannel:
116
+ """
117
+ A channel for logging CameraCalibration messages
118
+
119
+ You should choose a unique topic name per channel.
120
+ """
121
+
122
+ def __init__(
123
+ self,
124
+ topic: str,
125
+ *,
126
+ metadata: dict[str, str] | None = None,
127
+ context: Context | None = None,
128
+ ) -> None: ...
129
+ def id(self) -> int:
130
+ """The unique ID of the channel."""
131
+ ...
132
+
133
+ def topic(self) -> str:
134
+ """The topic name of the channel."""
135
+ ...
136
+
137
+ @property
138
+ def message_encoding(self) -> str:
139
+ """The message encoding for the channel"""
140
+ ...
141
+
142
+ def metadata(self) -> dict[str, str]:
143
+ """
144
+ Returns a copy of the channel's metadata.
145
+
146
+ Note that changes made to the returned dictionary will not be applied to
147
+ the channel's metadata.
148
+ """
149
+ ...
150
+
151
+ def schema(self) -> Schema | None:
152
+ """
153
+ Returns a copy of the channel's schema.
154
+
155
+ Note that changes made to the returned object will not be applied to
156
+ the channel's schema.
157
+ """
158
+ ...
159
+
160
+ def schema_name(self) -> str | None:
161
+ """The name of the schema for the channel."""
162
+ ...
163
+
164
+ def has_sinks(self) -> bool:
165
+ """Returns true if at least one sink is subscribed to this channel"""
166
+ ...
167
+
168
+ def close(self) -> None:
169
+ """Close the channel."""
170
+ ...
171
+
172
+ def log(
173
+ self,
174
+ message: "CameraCalibration",
175
+ *,
176
+ log_time: int | None = None,
177
+ sink_id: int | None = None,
178
+ ) -> None:
179
+ """Log a Foxglove CameraCalibration message on the channel."""
180
+ ...
181
+
182
+ class CircleAnnotationChannel:
183
+ """
184
+ A channel for logging CircleAnnotation messages
185
+
186
+ You should choose a unique topic name per channel.
187
+ """
188
+
189
+ def __init__(
190
+ self,
191
+ topic: str,
192
+ *,
193
+ metadata: dict[str, str] | None = None,
194
+ context: Context | None = None,
195
+ ) -> None: ...
196
+ def id(self) -> int:
197
+ """The unique ID of the channel."""
198
+ ...
199
+
200
+ def topic(self) -> str:
201
+ """The topic name of the channel."""
202
+ ...
203
+
204
+ @property
205
+ def message_encoding(self) -> str:
206
+ """The message encoding for the channel"""
207
+ ...
208
+
209
+ def metadata(self) -> dict[str, str]:
210
+ """
211
+ Returns a copy of the channel's metadata.
212
+
213
+ Note that changes made to the returned dictionary will not be applied to
214
+ the channel's metadata.
215
+ """
216
+ ...
217
+
218
+ def schema(self) -> Schema | None:
219
+ """
220
+ Returns a copy of the channel's schema.
221
+
222
+ Note that changes made to the returned object will not be applied to
223
+ the channel's schema.
224
+ """
225
+ ...
226
+
227
+ def schema_name(self) -> str | None:
228
+ """The name of the schema for the channel."""
229
+ ...
230
+
231
+ def has_sinks(self) -> bool:
232
+ """Returns true if at least one sink is subscribed to this channel"""
233
+ ...
234
+
235
+ def close(self) -> None:
236
+ """Close the channel."""
237
+ ...
238
+
239
+ def log(
240
+ self,
241
+ message: "CircleAnnotation",
242
+ *,
243
+ log_time: int | None = None,
244
+ sink_id: int | None = None,
245
+ ) -> None:
246
+ """Log a Foxglove CircleAnnotation message on the channel."""
247
+ ...
248
+
249
+ class ColorChannel:
250
+ """
251
+ A channel for logging Color messages
252
+
253
+ You should choose a unique topic name per channel.
254
+ """
255
+
256
+ def __init__(
257
+ self,
258
+ topic: str,
259
+ *,
260
+ metadata: dict[str, str] | None = None,
261
+ context: Context | None = None,
262
+ ) -> None: ...
263
+ def id(self) -> int:
264
+ """The unique ID of the channel."""
265
+ ...
266
+
267
+ def topic(self) -> str:
268
+ """The topic name of the channel."""
269
+ ...
270
+
271
+ @property
272
+ def message_encoding(self) -> str:
273
+ """The message encoding for the channel"""
274
+ ...
275
+
276
+ def metadata(self) -> dict[str, str]:
277
+ """
278
+ Returns a copy of the channel's metadata.
279
+
280
+ Note that changes made to the returned dictionary will not be applied to
281
+ the channel's metadata.
282
+ """
283
+ ...
284
+
285
+ def schema(self) -> Schema | None:
286
+ """
287
+ Returns a copy of the channel's schema.
288
+
289
+ Note that changes made to the returned object will not be applied to
290
+ the channel's schema.
291
+ """
292
+ ...
293
+
294
+ def schema_name(self) -> str | None:
295
+ """The name of the schema for the channel."""
296
+ ...
297
+
298
+ def has_sinks(self) -> bool:
299
+ """Returns true if at least one sink is subscribed to this channel"""
300
+ ...
301
+
302
+ def close(self) -> None:
303
+ """Close the channel."""
304
+ ...
305
+
306
+ def log(
307
+ self,
308
+ message: "Color",
309
+ *,
310
+ log_time: int | None = None,
311
+ sink_id: int | None = None,
312
+ ) -> None:
313
+ """Log a Foxglove Color message on the channel."""
314
+ ...
315
+
316
+ class CompressedImageChannel:
317
+ """
318
+ A channel for logging CompressedImage messages
319
+
320
+ You should choose a unique topic name per channel.
321
+ """
322
+
323
+ def __init__(
324
+ self,
325
+ topic: str,
326
+ *,
327
+ metadata: dict[str, str] | None = None,
328
+ context: Context | None = None,
329
+ ) -> None: ...
330
+ def id(self) -> int:
331
+ """The unique ID of the channel."""
332
+ ...
333
+
334
+ def topic(self) -> str:
335
+ """The topic name of the channel."""
336
+ ...
337
+
338
+ @property
339
+ def message_encoding(self) -> str:
340
+ """The message encoding for the channel"""
341
+ ...
342
+
343
+ def metadata(self) -> dict[str, str]:
344
+ """
345
+ Returns a copy of the channel's metadata.
346
+
347
+ Note that changes made to the returned dictionary will not be applied to
348
+ the channel's metadata.
349
+ """
350
+ ...
351
+
352
+ def schema(self) -> Schema | None:
353
+ """
354
+ Returns a copy of the channel's schema.
355
+
356
+ Note that changes made to the returned object will not be applied to
357
+ the channel's schema.
358
+ """
359
+ ...
360
+
361
+ def schema_name(self) -> str | None:
362
+ """The name of the schema for the channel."""
363
+ ...
364
+
365
+ def has_sinks(self) -> bool:
366
+ """Returns true if at least one sink is subscribed to this channel"""
367
+ ...
368
+
369
+ def close(self) -> None:
370
+ """Close the channel."""
371
+ ...
372
+
373
+ def log(
374
+ self,
375
+ message: "CompressedImage",
376
+ *,
377
+ log_time: int | None = None,
378
+ sink_id: int | None = None,
379
+ ) -> None:
380
+ """Log a Foxglove CompressedImage message on the channel."""
381
+ ...
382
+
383
+ class CompressedVideoChannel:
384
+ """
385
+ A channel for logging CompressedVideo messages
386
+
387
+ You should choose a unique topic name per channel.
388
+ """
389
+
390
+ def __init__(
391
+ self,
392
+ topic: str,
393
+ *,
394
+ metadata: dict[str, str] | None = None,
395
+ context: Context | None = None,
396
+ ) -> None: ...
397
+ def id(self) -> int:
398
+ """The unique ID of the channel."""
399
+ ...
400
+
401
+ def topic(self) -> str:
402
+ """The topic name of the channel."""
403
+ ...
404
+
405
+ @property
406
+ def message_encoding(self) -> str:
407
+ """The message encoding for the channel"""
408
+ ...
409
+
410
+ def metadata(self) -> dict[str, str]:
411
+ """
412
+ Returns a copy of the channel's metadata.
413
+
414
+ Note that changes made to the returned dictionary will not be applied to
415
+ the channel's metadata.
416
+ """
417
+ ...
418
+
419
+ def schema(self) -> Schema | None:
420
+ """
421
+ Returns a copy of the channel's schema.
422
+
423
+ Note that changes made to the returned object will not be applied to
424
+ the channel's schema.
425
+ """
426
+ ...
427
+
428
+ def schema_name(self) -> str | None:
429
+ """The name of the schema for the channel."""
430
+ ...
431
+
432
+ def has_sinks(self) -> bool:
433
+ """Returns true if at least one sink is subscribed to this channel"""
434
+ ...
435
+
436
+ def close(self) -> None:
437
+ """Close the channel."""
438
+ ...
439
+
440
+ def log(
441
+ self,
442
+ message: "CompressedVideo",
443
+ *,
444
+ log_time: int | None = None,
445
+ sink_id: int | None = None,
446
+ ) -> None:
447
+ """Log a Foxglove CompressedVideo message on the channel."""
448
+ ...
449
+
450
+ class CubePrimitiveChannel:
451
+ """
452
+ A channel for logging CubePrimitive messages
453
+
454
+ You should choose a unique topic name per channel.
455
+ """
456
+
457
+ def __init__(
458
+ self,
459
+ topic: str,
460
+ *,
461
+ metadata: dict[str, str] | None = None,
462
+ context: Context | None = None,
463
+ ) -> None: ...
464
+ def id(self) -> int:
465
+ """The unique ID of the channel."""
466
+ ...
467
+
468
+ def topic(self) -> str:
469
+ """The topic name of the channel."""
470
+ ...
471
+
472
+ @property
473
+ def message_encoding(self) -> str:
474
+ """The message encoding for the channel"""
475
+ ...
476
+
477
+ def metadata(self) -> dict[str, str]:
478
+ """
479
+ Returns a copy of the channel's metadata.
480
+
481
+ Note that changes made to the returned dictionary will not be applied to
482
+ the channel's metadata.
483
+ """
484
+ ...
485
+
486
+ def schema(self) -> Schema | None:
487
+ """
488
+ Returns a copy of the channel's schema.
489
+
490
+ Note that changes made to the returned object will not be applied to
491
+ the channel's schema.
492
+ """
493
+ ...
494
+
495
+ def schema_name(self) -> str | None:
496
+ """The name of the schema for the channel."""
497
+ ...
498
+
499
+ def has_sinks(self) -> bool:
500
+ """Returns true if at least one sink is subscribed to this channel"""
501
+ ...
502
+
503
+ def close(self) -> None:
504
+ """Close the channel."""
505
+ ...
506
+
507
+ def log(
508
+ self,
509
+ message: "CubePrimitive",
510
+ *,
511
+ log_time: int | None = None,
512
+ sink_id: int | None = None,
513
+ ) -> None:
514
+ """Log a Foxglove CubePrimitive message on the channel."""
515
+ ...
516
+
517
+ class CylinderPrimitiveChannel:
518
+ """
519
+ A channel for logging CylinderPrimitive messages
520
+
521
+ You should choose a unique topic name per channel.
522
+ """
523
+
524
+ def __init__(
525
+ self,
526
+ topic: str,
527
+ *,
528
+ metadata: dict[str, str] | None = None,
529
+ context: Context | None = None,
530
+ ) -> None: ...
531
+ def id(self) -> int:
532
+ """The unique ID of the channel."""
533
+ ...
534
+
535
+ def topic(self) -> str:
536
+ """The topic name of the channel."""
537
+ ...
538
+
539
+ @property
540
+ def message_encoding(self) -> str:
541
+ """The message encoding for the channel"""
542
+ ...
543
+
544
+ def metadata(self) -> dict[str, str]:
545
+ """
546
+ Returns a copy of the channel's metadata.
547
+
548
+ Note that changes made to the returned dictionary will not be applied to
549
+ the channel's metadata.
550
+ """
551
+ ...
552
+
553
+ def schema(self) -> Schema | None:
554
+ """
555
+ Returns a copy of the channel's schema.
556
+
557
+ Note that changes made to the returned object will not be applied to
558
+ the channel's schema.
559
+ """
560
+ ...
561
+
562
+ def schema_name(self) -> str | None:
563
+ """The name of the schema for the channel."""
564
+ ...
565
+
566
+ def has_sinks(self) -> bool:
567
+ """Returns true if at least one sink is subscribed to this channel"""
568
+ ...
569
+
570
+ def close(self) -> None:
571
+ """Close the channel."""
572
+ ...
573
+
574
+ def log(
575
+ self,
576
+ message: "CylinderPrimitive",
577
+ *,
578
+ log_time: int | None = None,
579
+ sink_id: int | None = None,
580
+ ) -> None:
581
+ """Log a Foxglove CylinderPrimitive message on the channel."""
582
+ ...
583
+
584
+ class FrameTransformChannel:
585
+ """
586
+ A channel for logging FrameTransform messages
587
+
588
+ You should choose a unique topic name per channel.
589
+ """
590
+
591
+ def __init__(
592
+ self,
593
+ topic: str,
594
+ *,
595
+ metadata: dict[str, str] | None = None,
596
+ context: Context | None = None,
597
+ ) -> None: ...
598
+ def id(self) -> int:
599
+ """The unique ID of the channel."""
600
+ ...
601
+
602
+ def topic(self) -> str:
603
+ """The topic name of the channel."""
604
+ ...
605
+
606
+ @property
607
+ def message_encoding(self) -> str:
608
+ """The message encoding for the channel"""
609
+ ...
610
+
611
+ def metadata(self) -> dict[str, str]:
612
+ """
613
+ Returns a copy of the channel's metadata.
614
+
615
+ Note that changes made to the returned dictionary will not be applied to
616
+ the channel's metadata.
617
+ """
618
+ ...
619
+
620
+ def schema(self) -> Schema | None:
621
+ """
622
+ Returns a copy of the channel's schema.
623
+
624
+ Note that changes made to the returned object will not be applied to
625
+ the channel's schema.
626
+ """
627
+ ...
628
+
629
+ def schema_name(self) -> str | None:
630
+ """The name of the schema for the channel."""
631
+ ...
632
+
633
+ def has_sinks(self) -> bool:
634
+ """Returns true if at least one sink is subscribed to this channel"""
635
+ ...
636
+
637
+ def close(self) -> None:
638
+ """Close the channel."""
639
+ ...
640
+
641
+ def log(
642
+ self,
643
+ message: "FrameTransform",
644
+ *,
645
+ log_time: int | None = None,
646
+ sink_id: int | None = None,
647
+ ) -> None:
648
+ """Log a Foxglove FrameTransform message on the channel."""
649
+ ...
650
+
651
+ class FrameTransformsChannel:
652
+ """
653
+ A channel for logging FrameTransforms messages
654
+
655
+ You should choose a unique topic name per channel.
656
+ """
657
+
658
+ def __init__(
659
+ self,
660
+ topic: str,
661
+ *,
662
+ metadata: dict[str, str] | None = None,
663
+ context: Context | None = None,
664
+ ) -> None: ...
665
+ def id(self) -> int:
666
+ """The unique ID of the channel."""
667
+ ...
668
+
669
+ def topic(self) -> str:
670
+ """The topic name of the channel."""
671
+ ...
672
+
673
+ @property
674
+ def message_encoding(self) -> str:
675
+ """The message encoding for the channel"""
676
+ ...
677
+
678
+ def metadata(self) -> dict[str, str]:
679
+ """
680
+ Returns a copy of the channel's metadata.
681
+
682
+ Note that changes made to the returned dictionary will not be applied to
683
+ the channel's metadata.
684
+ """
685
+ ...
686
+
687
+ def schema(self) -> Schema | None:
688
+ """
689
+ Returns a copy of the channel's schema.
690
+
691
+ Note that changes made to the returned object will not be applied to
692
+ the channel's schema.
693
+ """
694
+ ...
695
+
696
+ def schema_name(self) -> str | None:
697
+ """The name of the schema for the channel."""
698
+ ...
699
+
700
+ def has_sinks(self) -> bool:
701
+ """Returns true if at least one sink is subscribed to this channel"""
702
+ ...
703
+
704
+ def close(self) -> None:
705
+ """Close the channel."""
706
+ ...
707
+
708
+ def log(
709
+ self,
710
+ message: "FrameTransforms",
711
+ *,
712
+ log_time: int | None = None,
713
+ sink_id: int | None = None,
714
+ ) -> None:
715
+ """Log a Foxglove FrameTransforms message on the channel."""
716
+ ...
717
+
718
+ class GeoJsonChannel:
719
+ """
720
+ A channel for logging GeoJson messages
721
+
722
+ You should choose a unique topic name per channel.
723
+ """
724
+
725
+ def __init__(
726
+ self,
727
+ topic: str,
728
+ *,
729
+ metadata: dict[str, str] | None = None,
730
+ context: Context | None = None,
731
+ ) -> None: ...
732
+ def id(self) -> int:
733
+ """The unique ID of the channel."""
734
+ ...
735
+
736
+ def topic(self) -> str:
737
+ """The topic name of the channel."""
738
+ ...
739
+
740
+ @property
741
+ def message_encoding(self) -> str:
742
+ """The message encoding for the channel"""
743
+ ...
744
+
745
+ def metadata(self) -> dict[str, str]:
746
+ """
747
+ Returns a copy of the channel's metadata.
748
+
749
+ Note that changes made to the returned dictionary will not be applied to
750
+ the channel's metadata.
751
+ """
752
+ ...
753
+
754
+ def schema(self) -> Schema | None:
755
+ """
756
+ Returns a copy of the channel's schema.
757
+
758
+ Note that changes made to the returned object will not be applied to
759
+ the channel's schema.
760
+ """
761
+ ...
762
+
763
+ def schema_name(self) -> str | None:
764
+ """The name of the schema for the channel."""
765
+ ...
766
+
767
+ def has_sinks(self) -> bool:
768
+ """Returns true if at least one sink is subscribed to this channel"""
769
+ ...
770
+
771
+ def close(self) -> None:
772
+ """Close the channel."""
773
+ ...
774
+
775
+ def log(
776
+ self,
777
+ message: "GeoJson",
778
+ *,
779
+ log_time: int | None = None,
780
+ sink_id: int | None = None,
781
+ ) -> None:
782
+ """Log a Foxglove GeoJson message on the channel."""
783
+ ...
784
+
785
+ class GridChannel:
786
+ """
787
+ A channel for logging Grid messages
788
+
789
+ You should choose a unique topic name per channel.
790
+ """
791
+
792
+ def __init__(
793
+ self,
794
+ topic: str,
795
+ *,
796
+ metadata: dict[str, str] | None = None,
797
+ context: Context | None = None,
798
+ ) -> None: ...
799
+ def id(self) -> int:
800
+ """The unique ID of the channel."""
801
+ ...
802
+
803
+ def topic(self) -> str:
804
+ """The topic name of the channel."""
805
+ ...
806
+
807
+ @property
808
+ def message_encoding(self) -> str:
809
+ """The message encoding for the channel"""
810
+ ...
811
+
812
+ def metadata(self) -> dict[str, str]:
813
+ """
814
+ Returns a copy of the channel's metadata.
815
+
816
+ Note that changes made to the returned dictionary will not be applied to
817
+ the channel's metadata.
818
+ """
819
+ ...
820
+
821
+ def schema(self) -> Schema | None:
822
+ """
823
+ Returns a copy of the channel's schema.
824
+
825
+ Note that changes made to the returned object will not be applied to
826
+ the channel's schema.
827
+ """
828
+ ...
829
+
830
+ def schema_name(self) -> str | None:
831
+ """The name of the schema for the channel."""
832
+ ...
833
+
834
+ def has_sinks(self) -> bool:
835
+ """Returns true if at least one sink is subscribed to this channel"""
836
+ ...
837
+
838
+ def close(self) -> None:
839
+ """Close the channel."""
840
+ ...
841
+
842
+ def log(
843
+ self,
844
+ message: "Grid",
845
+ *,
846
+ log_time: int | None = None,
847
+ sink_id: int | None = None,
848
+ ) -> None:
849
+ """Log a Foxglove Grid message on the channel."""
850
+ ...
851
+
852
+ class ImageAnnotationsChannel:
853
+ """
854
+ A channel for logging ImageAnnotations messages
855
+
856
+ You should choose a unique topic name per channel.
857
+ """
858
+
859
+ def __init__(
860
+ self,
861
+ topic: str,
862
+ *,
863
+ metadata: dict[str, str] | None = None,
864
+ context: Context | None = None,
865
+ ) -> None: ...
866
+ def id(self) -> int:
867
+ """The unique ID of the channel."""
868
+ ...
869
+
870
+ def topic(self) -> str:
871
+ """The topic name of the channel."""
872
+ ...
873
+
874
+ @property
875
+ def message_encoding(self) -> str:
876
+ """The message encoding for the channel"""
877
+ ...
878
+
879
+ def metadata(self) -> dict[str, str]:
880
+ """
881
+ Returns a copy of the channel's metadata.
882
+
883
+ Note that changes made to the returned dictionary will not be applied to
884
+ the channel's metadata.
885
+ """
886
+ ...
887
+
888
+ def schema(self) -> Schema | None:
889
+ """
890
+ Returns a copy of the channel's schema.
891
+
892
+ Note that changes made to the returned object will not be applied to
893
+ the channel's schema.
894
+ """
895
+ ...
896
+
897
+ def schema_name(self) -> str | None:
898
+ """The name of the schema for the channel."""
899
+ ...
900
+
901
+ def has_sinks(self) -> bool:
902
+ """Returns true if at least one sink is subscribed to this channel"""
903
+ ...
904
+
905
+ def close(self) -> None:
906
+ """Close the channel."""
907
+ ...
908
+
909
+ def log(
910
+ self,
911
+ message: "ImageAnnotations",
912
+ *,
913
+ log_time: int | None = None,
914
+ sink_id: int | None = None,
915
+ ) -> None:
916
+ """Log a Foxglove ImageAnnotations message on the channel."""
917
+ ...
918
+
919
+ class KeyValuePairChannel:
920
+ """
921
+ A channel for logging KeyValuePair messages
922
+
923
+ You should choose a unique topic name per channel.
924
+ """
925
+
926
+ def __init__(
927
+ self,
928
+ topic: str,
929
+ *,
930
+ metadata: dict[str, str] | None = None,
931
+ context: Context | None = None,
932
+ ) -> None: ...
933
+ def id(self) -> int:
934
+ """The unique ID of the channel."""
935
+ ...
936
+
937
+ def topic(self) -> str:
938
+ """The topic name of the channel."""
939
+ ...
940
+
941
+ @property
942
+ def message_encoding(self) -> str:
943
+ """The message encoding for the channel"""
944
+ ...
945
+
946
+ def metadata(self) -> dict[str, str]:
947
+ """
948
+ Returns a copy of the channel's metadata.
949
+
950
+ Note that changes made to the returned dictionary will not be applied to
951
+ the channel's metadata.
952
+ """
953
+ ...
954
+
955
+ def schema(self) -> Schema | None:
956
+ """
957
+ Returns a copy of the channel's schema.
958
+
959
+ Note that changes made to the returned object will not be applied to
960
+ the channel's schema.
961
+ """
962
+ ...
963
+
964
+ def schema_name(self) -> str | None:
965
+ """The name of the schema for the channel."""
966
+ ...
967
+
968
+ def has_sinks(self) -> bool:
969
+ """Returns true if at least one sink is subscribed to this channel"""
970
+ ...
971
+
972
+ def close(self) -> None:
973
+ """Close the channel."""
974
+ ...
975
+
976
+ def log(
977
+ self,
978
+ message: "KeyValuePair",
979
+ *,
980
+ log_time: int | None = None,
981
+ sink_id: int | None = None,
982
+ ) -> None:
983
+ """Log a Foxglove KeyValuePair message on the channel."""
984
+ ...
985
+
986
+ class LaserScanChannel:
987
+ """
988
+ A channel for logging LaserScan messages
989
+
990
+ You should choose a unique topic name per channel.
991
+ """
992
+
993
+ def __init__(
994
+ self,
995
+ topic: str,
996
+ *,
997
+ metadata: dict[str, str] | None = None,
998
+ context: Context | None = None,
999
+ ) -> None: ...
1000
+ def id(self) -> int:
1001
+ """The unique ID of the channel."""
1002
+ ...
1003
+
1004
+ def topic(self) -> str:
1005
+ """The topic name of the channel."""
1006
+ ...
1007
+
1008
+ @property
1009
+ def message_encoding(self) -> str:
1010
+ """The message encoding for the channel"""
1011
+ ...
1012
+
1013
+ def metadata(self) -> dict[str, str]:
1014
+ """
1015
+ Returns a copy of the channel's metadata.
1016
+
1017
+ Note that changes made to the returned dictionary will not be applied to
1018
+ the channel's metadata.
1019
+ """
1020
+ ...
1021
+
1022
+ def schema(self) -> Schema | None:
1023
+ """
1024
+ Returns a copy of the channel's schema.
1025
+
1026
+ Note that changes made to the returned object will not be applied to
1027
+ the channel's schema.
1028
+ """
1029
+ ...
1030
+
1031
+ def schema_name(self) -> str | None:
1032
+ """The name of the schema for the channel."""
1033
+ ...
1034
+
1035
+ def has_sinks(self) -> bool:
1036
+ """Returns true if at least one sink is subscribed to this channel"""
1037
+ ...
1038
+
1039
+ def close(self) -> None:
1040
+ """Close the channel."""
1041
+ ...
1042
+
1043
+ def log(
1044
+ self,
1045
+ message: "LaserScan",
1046
+ *,
1047
+ log_time: int | None = None,
1048
+ sink_id: int | None = None,
1049
+ ) -> None:
1050
+ """Log a Foxglove LaserScan message on the channel."""
1051
+ ...
1052
+
1053
+ class LinePrimitiveChannel:
1054
+ """
1055
+ A channel for logging LinePrimitive messages
1056
+
1057
+ You should choose a unique topic name per channel.
1058
+ """
1059
+
1060
+ def __init__(
1061
+ self,
1062
+ topic: str,
1063
+ *,
1064
+ metadata: dict[str, str] | None = None,
1065
+ context: Context | None = None,
1066
+ ) -> None: ...
1067
+ def id(self) -> int:
1068
+ """The unique ID of the channel."""
1069
+ ...
1070
+
1071
+ def topic(self) -> str:
1072
+ """The topic name of the channel."""
1073
+ ...
1074
+
1075
+ @property
1076
+ def message_encoding(self) -> str:
1077
+ """The message encoding for the channel"""
1078
+ ...
1079
+
1080
+ def metadata(self) -> dict[str, str]:
1081
+ """
1082
+ Returns a copy of the channel's metadata.
1083
+
1084
+ Note that changes made to the returned dictionary will not be applied to
1085
+ the channel's metadata.
1086
+ """
1087
+ ...
1088
+
1089
+ def schema(self) -> Schema | None:
1090
+ """
1091
+ Returns a copy of the channel's schema.
1092
+
1093
+ Note that changes made to the returned object will not be applied to
1094
+ the channel's schema.
1095
+ """
1096
+ ...
1097
+
1098
+ def schema_name(self) -> str | None:
1099
+ """The name of the schema for the channel."""
1100
+ ...
1101
+
1102
+ def has_sinks(self) -> bool:
1103
+ """Returns true if at least one sink is subscribed to this channel"""
1104
+ ...
1105
+
1106
+ def close(self) -> None:
1107
+ """Close the channel."""
1108
+ ...
1109
+
1110
+ def log(
1111
+ self,
1112
+ message: "LinePrimitive",
1113
+ *,
1114
+ log_time: int | None = None,
1115
+ sink_id: int | None = None,
1116
+ ) -> None:
1117
+ """Log a Foxglove LinePrimitive message on the channel."""
1118
+ ...
1119
+
1120
+ class LocationFixChannel:
1121
+ """
1122
+ A channel for logging LocationFix messages
1123
+
1124
+ You should choose a unique topic name per channel.
1125
+ """
1126
+
1127
+ def __init__(
1128
+ self,
1129
+ topic: str,
1130
+ *,
1131
+ metadata: dict[str, str] | None = None,
1132
+ context: Context | None = None,
1133
+ ) -> None: ...
1134
+ def id(self) -> int:
1135
+ """The unique ID of the channel."""
1136
+ ...
1137
+
1138
+ def topic(self) -> str:
1139
+ """The topic name of the channel."""
1140
+ ...
1141
+
1142
+ @property
1143
+ def message_encoding(self) -> str:
1144
+ """The message encoding for the channel"""
1145
+ ...
1146
+
1147
+ def metadata(self) -> dict[str, str]:
1148
+ """
1149
+ Returns a copy of the channel's metadata.
1150
+
1151
+ Note that changes made to the returned dictionary will not be applied to
1152
+ the channel's metadata.
1153
+ """
1154
+ ...
1155
+
1156
+ def schema(self) -> Schema | None:
1157
+ """
1158
+ Returns a copy of the channel's schema.
1159
+
1160
+ Note that changes made to the returned object will not be applied to
1161
+ the channel's schema.
1162
+ """
1163
+ ...
1164
+
1165
+ def schema_name(self) -> str | None:
1166
+ """The name of the schema for the channel."""
1167
+ ...
1168
+
1169
+ def has_sinks(self) -> bool:
1170
+ """Returns true if at least one sink is subscribed to this channel"""
1171
+ ...
1172
+
1173
+ def close(self) -> None:
1174
+ """Close the channel."""
1175
+ ...
1176
+
1177
+ def log(
1178
+ self,
1179
+ message: "LocationFix",
1180
+ *,
1181
+ log_time: int | None = None,
1182
+ sink_id: int | None = None,
1183
+ ) -> None:
1184
+ """Log a Foxglove LocationFix message on the channel."""
1185
+ ...
1186
+
1187
+ class LocationFixesChannel:
1188
+ """
1189
+ A channel for logging LocationFixes messages
1190
+
1191
+ You should choose a unique topic name per channel.
1192
+ """
1193
+
1194
+ def __init__(
1195
+ self,
1196
+ topic: str,
1197
+ *,
1198
+ metadata: dict[str, str] | None = None,
1199
+ context: Context | None = None,
1200
+ ) -> None: ...
1201
+ def id(self) -> int:
1202
+ """The unique ID of the channel."""
1203
+ ...
1204
+
1205
+ def topic(self) -> str:
1206
+ """The topic name of the channel."""
1207
+ ...
1208
+
1209
+ @property
1210
+ def message_encoding(self) -> str:
1211
+ """The message encoding for the channel"""
1212
+ ...
1213
+
1214
+ def metadata(self) -> dict[str, str]:
1215
+ """
1216
+ Returns a copy of the channel's metadata.
1217
+
1218
+ Note that changes made to the returned dictionary will not be applied to
1219
+ the channel's metadata.
1220
+ """
1221
+ ...
1222
+
1223
+ def schema(self) -> Schema | None:
1224
+ """
1225
+ Returns a copy of the channel's schema.
1226
+
1227
+ Note that changes made to the returned object will not be applied to
1228
+ the channel's schema.
1229
+ """
1230
+ ...
1231
+
1232
+ def schema_name(self) -> str | None:
1233
+ """The name of the schema for the channel."""
1234
+ ...
1235
+
1236
+ def has_sinks(self) -> bool:
1237
+ """Returns true if at least one sink is subscribed to this channel"""
1238
+ ...
1239
+
1240
+ def close(self) -> None:
1241
+ """Close the channel."""
1242
+ ...
1243
+
1244
+ def log(
1245
+ self,
1246
+ message: "LocationFixes",
1247
+ *,
1248
+ log_time: int | None = None,
1249
+ sink_id: int | None = None,
1250
+ ) -> None:
1251
+ """Log a Foxglove LocationFixes message on the channel."""
1252
+ ...
1253
+
1254
+ class LogChannel:
1255
+ """
1256
+ A channel for logging Log messages
1257
+
1258
+ You should choose a unique topic name per channel.
1259
+ """
1260
+
1261
+ def __init__(
1262
+ self,
1263
+ topic: str,
1264
+ *,
1265
+ metadata: dict[str, str] | None = None,
1266
+ context: Context | None = None,
1267
+ ) -> None: ...
1268
+ def id(self) -> int:
1269
+ """The unique ID of the channel."""
1270
+ ...
1271
+
1272
+ def topic(self) -> str:
1273
+ """The topic name of the channel."""
1274
+ ...
1275
+
1276
+ @property
1277
+ def message_encoding(self) -> str:
1278
+ """The message encoding for the channel"""
1279
+ ...
1280
+
1281
+ def metadata(self) -> dict[str, str]:
1282
+ """
1283
+ Returns a copy of the channel's metadata.
1284
+
1285
+ Note that changes made to the returned dictionary will not be applied to
1286
+ the channel's metadata.
1287
+ """
1288
+ ...
1289
+
1290
+ def schema(self) -> Schema | None:
1291
+ """
1292
+ Returns a copy of the channel's schema.
1293
+
1294
+ Note that changes made to the returned object will not be applied to
1295
+ the channel's schema.
1296
+ """
1297
+ ...
1298
+
1299
+ def schema_name(self) -> str | None:
1300
+ """The name of the schema for the channel."""
1301
+ ...
1302
+
1303
+ def has_sinks(self) -> bool:
1304
+ """Returns true if at least one sink is subscribed to this channel"""
1305
+ ...
1306
+
1307
+ def close(self) -> None:
1308
+ """Close the channel."""
1309
+ ...
1310
+
1311
+ def log(
1312
+ self,
1313
+ message: "Log",
1314
+ *,
1315
+ log_time: int | None = None,
1316
+ sink_id: int | None = None,
1317
+ ) -> None:
1318
+ """Log a Foxglove Log message on the channel."""
1319
+ ...
1320
+
1321
+ class ModelPrimitiveChannel:
1322
+ """
1323
+ A channel for logging ModelPrimitive messages
1324
+
1325
+ You should choose a unique topic name per channel.
1326
+ """
1327
+
1328
+ def __init__(
1329
+ self,
1330
+ topic: str,
1331
+ *,
1332
+ metadata: dict[str, str] | None = None,
1333
+ context: Context | None = None,
1334
+ ) -> None: ...
1335
+ def id(self) -> int:
1336
+ """The unique ID of the channel."""
1337
+ ...
1338
+
1339
+ def topic(self) -> str:
1340
+ """The topic name of the channel."""
1341
+ ...
1342
+
1343
+ @property
1344
+ def message_encoding(self) -> str:
1345
+ """The message encoding for the channel"""
1346
+ ...
1347
+
1348
+ def metadata(self) -> dict[str, str]:
1349
+ """
1350
+ Returns a copy of the channel's metadata.
1351
+
1352
+ Note that changes made to the returned dictionary will not be applied to
1353
+ the channel's metadata.
1354
+ """
1355
+ ...
1356
+
1357
+ def schema(self) -> Schema | None:
1358
+ """
1359
+ Returns a copy of the channel's schema.
1360
+
1361
+ Note that changes made to the returned object will not be applied to
1362
+ the channel's schema.
1363
+ """
1364
+ ...
1365
+
1366
+ def schema_name(self) -> str | None:
1367
+ """The name of the schema for the channel."""
1368
+ ...
1369
+
1370
+ def has_sinks(self) -> bool:
1371
+ """Returns true if at least one sink is subscribed to this channel"""
1372
+ ...
1373
+
1374
+ def close(self) -> None:
1375
+ """Close the channel."""
1376
+ ...
1377
+
1378
+ def log(
1379
+ self,
1380
+ message: "ModelPrimitive",
1381
+ *,
1382
+ log_time: int | None = None,
1383
+ sink_id: int | None = None,
1384
+ ) -> None:
1385
+ """Log a Foxglove ModelPrimitive message on the channel."""
1386
+ ...
1387
+
1388
+ class PackedElementFieldChannel:
1389
+ """
1390
+ A channel for logging PackedElementField messages
1391
+
1392
+ You should choose a unique topic name per channel.
1393
+ """
1394
+
1395
+ def __init__(
1396
+ self,
1397
+ topic: str,
1398
+ *,
1399
+ metadata: dict[str, str] | None = None,
1400
+ context: Context | None = None,
1401
+ ) -> None: ...
1402
+ def id(self) -> int:
1403
+ """The unique ID of the channel."""
1404
+ ...
1405
+
1406
+ def topic(self) -> str:
1407
+ """The topic name of the channel."""
1408
+ ...
1409
+
1410
+ @property
1411
+ def message_encoding(self) -> str:
1412
+ """The message encoding for the channel"""
1413
+ ...
1414
+
1415
+ def metadata(self) -> dict[str, str]:
1416
+ """
1417
+ Returns a copy of the channel's metadata.
1418
+
1419
+ Note that changes made to the returned dictionary will not be applied to
1420
+ the channel's metadata.
1421
+ """
1422
+ ...
1423
+
1424
+ def schema(self) -> Schema | None:
1425
+ """
1426
+ Returns a copy of the channel's schema.
1427
+
1428
+ Note that changes made to the returned object will not be applied to
1429
+ the channel's schema.
1430
+ """
1431
+ ...
1432
+
1433
+ def schema_name(self) -> str | None:
1434
+ """The name of the schema for the channel."""
1435
+ ...
1436
+
1437
+ def has_sinks(self) -> bool:
1438
+ """Returns true if at least one sink is subscribed to this channel"""
1439
+ ...
1440
+
1441
+ def close(self) -> None:
1442
+ """Close the channel."""
1443
+ ...
1444
+
1445
+ def log(
1446
+ self,
1447
+ message: "PackedElementField",
1448
+ *,
1449
+ log_time: int | None = None,
1450
+ sink_id: int | None = None,
1451
+ ) -> None:
1452
+ """Log a Foxglove PackedElementField message on the channel."""
1453
+ ...
1454
+
1455
+ class Point2Channel:
1456
+ """
1457
+ A channel for logging Point2 messages
1458
+
1459
+ You should choose a unique topic name per channel.
1460
+ """
1461
+
1462
+ def __init__(
1463
+ self,
1464
+ topic: str,
1465
+ *,
1466
+ metadata: dict[str, str] | None = None,
1467
+ context: Context | None = None,
1468
+ ) -> None: ...
1469
+ def id(self) -> int:
1470
+ """The unique ID of the channel."""
1471
+ ...
1472
+
1473
+ def topic(self) -> str:
1474
+ """The topic name of the channel."""
1475
+ ...
1476
+
1477
+ @property
1478
+ def message_encoding(self) -> str:
1479
+ """The message encoding for the channel"""
1480
+ ...
1481
+
1482
+ def metadata(self) -> dict[str, str]:
1483
+ """
1484
+ Returns a copy of the channel's metadata.
1485
+
1486
+ Note that changes made to the returned dictionary will not be applied to
1487
+ the channel's metadata.
1488
+ """
1489
+ ...
1490
+
1491
+ def schema(self) -> Schema | None:
1492
+ """
1493
+ Returns a copy of the channel's schema.
1494
+
1495
+ Note that changes made to the returned object will not be applied to
1496
+ the channel's schema.
1497
+ """
1498
+ ...
1499
+
1500
+ def schema_name(self) -> str | None:
1501
+ """The name of the schema for the channel."""
1502
+ ...
1503
+
1504
+ def has_sinks(self) -> bool:
1505
+ """Returns true if at least one sink is subscribed to this channel"""
1506
+ ...
1507
+
1508
+ def close(self) -> None:
1509
+ """Close the channel."""
1510
+ ...
1511
+
1512
+ def log(
1513
+ self,
1514
+ message: "Point2",
1515
+ *,
1516
+ log_time: int | None = None,
1517
+ sink_id: int | None = None,
1518
+ ) -> None:
1519
+ """Log a Foxglove Point2 message on the channel."""
1520
+ ...
1521
+
1522
+ class Point3Channel:
1523
+ """
1524
+ A channel for logging Point3 messages
1525
+
1526
+ You should choose a unique topic name per channel.
1527
+ """
1528
+
1529
+ def __init__(
1530
+ self,
1531
+ topic: str,
1532
+ *,
1533
+ metadata: dict[str, str] | None = None,
1534
+ context: Context | None = None,
1535
+ ) -> None: ...
1536
+ def id(self) -> int:
1537
+ """The unique ID of the channel."""
1538
+ ...
1539
+
1540
+ def topic(self) -> str:
1541
+ """The topic name of the channel."""
1542
+ ...
1543
+
1544
+ @property
1545
+ def message_encoding(self) -> str:
1546
+ """The message encoding for the channel"""
1547
+ ...
1548
+
1549
+ def metadata(self) -> dict[str, str]:
1550
+ """
1551
+ Returns a copy of the channel's metadata.
1552
+
1553
+ Note that changes made to the returned dictionary will not be applied to
1554
+ the channel's metadata.
1555
+ """
1556
+ ...
1557
+
1558
+ def schema(self) -> Schema | None:
1559
+ """
1560
+ Returns a copy of the channel's schema.
1561
+
1562
+ Note that changes made to the returned object will not be applied to
1563
+ the channel's schema.
1564
+ """
1565
+ ...
1566
+
1567
+ def schema_name(self) -> str | None:
1568
+ """The name of the schema for the channel."""
1569
+ ...
1570
+
1571
+ def has_sinks(self) -> bool:
1572
+ """Returns true if at least one sink is subscribed to this channel"""
1573
+ ...
1574
+
1575
+ def close(self) -> None:
1576
+ """Close the channel."""
1577
+ ...
1578
+
1579
+ def log(
1580
+ self,
1581
+ message: "Point3",
1582
+ *,
1583
+ log_time: int | None = None,
1584
+ sink_id: int | None = None,
1585
+ ) -> None:
1586
+ """Log a Foxglove Point3 message on the channel."""
1587
+ ...
1588
+
1589
+ class Point3InFrameChannel:
1590
+ """
1591
+ A channel for logging Point3InFrame messages
1592
+
1593
+ You should choose a unique topic name per channel.
1594
+ """
1595
+
1596
+ def __init__(
1597
+ self,
1598
+ topic: str,
1599
+ *,
1600
+ metadata: dict[str, str] | None = None,
1601
+ context: Context | None = None,
1602
+ ) -> None: ...
1603
+ def id(self) -> int:
1604
+ """The unique ID of the channel."""
1605
+ ...
1606
+
1607
+ def topic(self) -> str:
1608
+ """The topic name of the channel."""
1609
+ ...
1610
+
1611
+ @property
1612
+ def message_encoding(self) -> str:
1613
+ """The message encoding for the channel"""
1614
+ ...
1615
+
1616
+ def metadata(self) -> dict[str, str]:
1617
+ """
1618
+ Returns a copy of the channel's metadata.
1619
+
1620
+ Note that changes made to the returned dictionary will not be applied to
1621
+ the channel's metadata.
1622
+ """
1623
+ ...
1624
+
1625
+ def schema(self) -> Schema | None:
1626
+ """
1627
+ Returns a copy of the channel's schema.
1628
+
1629
+ Note that changes made to the returned object will not be applied to
1630
+ the channel's schema.
1631
+ """
1632
+ ...
1633
+
1634
+ def schema_name(self) -> str | None:
1635
+ """The name of the schema for the channel."""
1636
+ ...
1637
+
1638
+ def has_sinks(self) -> bool:
1639
+ """Returns true if at least one sink is subscribed to this channel"""
1640
+ ...
1641
+
1642
+ def close(self) -> None:
1643
+ """Close the channel."""
1644
+ ...
1645
+
1646
+ def log(
1647
+ self,
1648
+ message: "Point3InFrame",
1649
+ *,
1650
+ log_time: int | None = None,
1651
+ sink_id: int | None = None,
1652
+ ) -> None:
1653
+ """Log a Foxglove Point3InFrame message on the channel."""
1654
+ ...
1655
+
1656
+ class PointCloudChannel:
1657
+ """
1658
+ A channel for logging PointCloud messages
1659
+
1660
+ You should choose a unique topic name per channel.
1661
+ """
1662
+
1663
+ def __init__(
1664
+ self,
1665
+ topic: str,
1666
+ *,
1667
+ metadata: dict[str, str] | None = None,
1668
+ context: Context | None = None,
1669
+ ) -> None: ...
1670
+ def id(self) -> int:
1671
+ """The unique ID of the channel."""
1672
+ ...
1673
+
1674
+ def topic(self) -> str:
1675
+ """The topic name of the channel."""
1676
+ ...
1677
+
1678
+ @property
1679
+ def message_encoding(self) -> str:
1680
+ """The message encoding for the channel"""
1681
+ ...
1682
+
1683
+ def metadata(self) -> dict[str, str]:
1684
+ """
1685
+ Returns a copy of the channel's metadata.
1686
+
1687
+ Note that changes made to the returned dictionary will not be applied to
1688
+ the channel's metadata.
1689
+ """
1690
+ ...
1691
+
1692
+ def schema(self) -> Schema | None:
1693
+ """
1694
+ Returns a copy of the channel's schema.
1695
+
1696
+ Note that changes made to the returned object will not be applied to
1697
+ the channel's schema.
1698
+ """
1699
+ ...
1700
+
1701
+ def schema_name(self) -> str | None:
1702
+ """The name of the schema for the channel."""
1703
+ ...
1704
+
1705
+ def has_sinks(self) -> bool:
1706
+ """Returns true if at least one sink is subscribed to this channel"""
1707
+ ...
1708
+
1709
+ def close(self) -> None:
1710
+ """Close the channel."""
1711
+ ...
1712
+
1713
+ def log(
1714
+ self,
1715
+ message: "PointCloud",
1716
+ *,
1717
+ log_time: int | None = None,
1718
+ sink_id: int | None = None,
1719
+ ) -> None:
1720
+ """Log a Foxglove PointCloud message on the channel."""
1721
+ ...
1722
+
1723
+ class PointsAnnotationChannel:
1724
+ """
1725
+ A channel for logging PointsAnnotation messages
1726
+
1727
+ You should choose a unique topic name per channel.
1728
+ """
1729
+
1730
+ def __init__(
1731
+ self,
1732
+ topic: str,
1733
+ *,
1734
+ metadata: dict[str, str] | None = None,
1735
+ context: Context | None = None,
1736
+ ) -> None: ...
1737
+ def id(self) -> int:
1738
+ """The unique ID of the channel."""
1739
+ ...
1740
+
1741
+ def topic(self) -> str:
1742
+ """The topic name of the channel."""
1743
+ ...
1744
+
1745
+ @property
1746
+ def message_encoding(self) -> str:
1747
+ """The message encoding for the channel"""
1748
+ ...
1749
+
1750
+ def metadata(self) -> dict[str, str]:
1751
+ """
1752
+ Returns a copy of the channel's metadata.
1753
+
1754
+ Note that changes made to the returned dictionary will not be applied to
1755
+ the channel's metadata.
1756
+ """
1757
+ ...
1758
+
1759
+ def schema(self) -> Schema | None:
1760
+ """
1761
+ Returns a copy of the channel's schema.
1762
+
1763
+ Note that changes made to the returned object will not be applied to
1764
+ the channel's schema.
1765
+ """
1766
+ ...
1767
+
1768
+ def schema_name(self) -> str | None:
1769
+ """The name of the schema for the channel."""
1770
+ ...
1771
+
1772
+ def has_sinks(self) -> bool:
1773
+ """Returns true if at least one sink is subscribed to this channel"""
1774
+ ...
1775
+
1776
+ def close(self) -> None:
1777
+ """Close the channel."""
1778
+ ...
1779
+
1780
+ def log(
1781
+ self,
1782
+ message: "PointsAnnotation",
1783
+ *,
1784
+ log_time: int | None = None,
1785
+ sink_id: int | None = None,
1786
+ ) -> None:
1787
+ """Log a Foxglove PointsAnnotation message on the channel."""
1788
+ ...
1789
+
1790
+ class PoseChannel:
1791
+ """
1792
+ A channel for logging Pose messages
1793
+
1794
+ You should choose a unique topic name per channel.
1795
+ """
1796
+
1797
+ def __init__(
1798
+ self,
1799
+ topic: str,
1800
+ *,
1801
+ metadata: dict[str, str] | None = None,
1802
+ context: Context | None = None,
1803
+ ) -> None: ...
1804
+ def id(self) -> int:
1805
+ """The unique ID of the channel."""
1806
+ ...
1807
+
1808
+ def topic(self) -> str:
1809
+ """The topic name of the channel."""
1810
+ ...
1811
+
1812
+ @property
1813
+ def message_encoding(self) -> str:
1814
+ """The message encoding for the channel"""
1815
+ ...
1816
+
1817
+ def metadata(self) -> dict[str, str]:
1818
+ """
1819
+ Returns a copy of the channel's metadata.
1820
+
1821
+ Note that changes made to the returned dictionary will not be applied to
1822
+ the channel's metadata.
1823
+ """
1824
+ ...
1825
+
1826
+ def schema(self) -> Schema | None:
1827
+ """
1828
+ Returns a copy of the channel's schema.
1829
+
1830
+ Note that changes made to the returned object will not be applied to
1831
+ the channel's schema.
1832
+ """
1833
+ ...
1834
+
1835
+ def schema_name(self) -> str | None:
1836
+ """The name of the schema for the channel."""
1837
+ ...
1838
+
1839
+ def has_sinks(self) -> bool:
1840
+ """Returns true if at least one sink is subscribed to this channel"""
1841
+ ...
1842
+
1843
+ def close(self) -> None:
1844
+ """Close the channel."""
1845
+ ...
1846
+
1847
+ def log(
1848
+ self,
1849
+ message: "Pose",
1850
+ *,
1851
+ log_time: int | None = None,
1852
+ sink_id: int | None = None,
1853
+ ) -> None:
1854
+ """Log a Foxglove Pose message on the channel."""
1855
+ ...
1856
+
1857
+ class PoseInFrameChannel:
1858
+ """
1859
+ A channel for logging PoseInFrame messages
1860
+
1861
+ You should choose a unique topic name per channel.
1862
+ """
1863
+
1864
+ def __init__(
1865
+ self,
1866
+ topic: str,
1867
+ *,
1868
+ metadata: dict[str, str] | None = None,
1869
+ context: Context | None = None,
1870
+ ) -> None: ...
1871
+ def id(self) -> int:
1872
+ """The unique ID of the channel."""
1873
+ ...
1874
+
1875
+ def topic(self) -> str:
1876
+ """The topic name of the channel."""
1877
+ ...
1878
+
1879
+ @property
1880
+ def message_encoding(self) -> str:
1881
+ """The message encoding for the channel"""
1882
+ ...
1883
+
1884
+ def metadata(self) -> dict[str, str]:
1885
+ """
1886
+ Returns a copy of the channel's metadata.
1887
+
1888
+ Note that changes made to the returned dictionary will not be applied to
1889
+ the channel's metadata.
1890
+ """
1891
+ ...
1892
+
1893
+ def schema(self) -> Schema | None:
1894
+ """
1895
+ Returns a copy of the channel's schema.
1896
+
1897
+ Note that changes made to the returned object will not be applied to
1898
+ the channel's schema.
1899
+ """
1900
+ ...
1901
+
1902
+ def schema_name(self) -> str | None:
1903
+ """The name of the schema for the channel."""
1904
+ ...
1905
+
1906
+ def has_sinks(self) -> bool:
1907
+ """Returns true if at least one sink is subscribed to this channel"""
1908
+ ...
1909
+
1910
+ def close(self) -> None:
1911
+ """Close the channel."""
1912
+ ...
1913
+
1914
+ def log(
1915
+ self,
1916
+ message: "PoseInFrame",
1917
+ *,
1918
+ log_time: int | None = None,
1919
+ sink_id: int | None = None,
1920
+ ) -> None:
1921
+ """Log a Foxglove PoseInFrame message on the channel."""
1922
+ ...
1923
+
1924
+ class PosesInFrameChannel:
1925
+ """
1926
+ A channel for logging PosesInFrame messages
1927
+
1928
+ You should choose a unique topic name per channel.
1929
+ """
1930
+
1931
+ def __init__(
1932
+ self,
1933
+ topic: str,
1934
+ *,
1935
+ metadata: dict[str, str] | None = None,
1936
+ context: Context | None = None,
1937
+ ) -> None: ...
1938
+ def id(self) -> int:
1939
+ """The unique ID of the channel."""
1940
+ ...
1941
+
1942
+ def topic(self) -> str:
1943
+ """The topic name of the channel."""
1944
+ ...
1945
+
1946
+ @property
1947
+ def message_encoding(self) -> str:
1948
+ """The message encoding for the channel"""
1949
+ ...
1950
+
1951
+ def metadata(self) -> dict[str, str]:
1952
+ """
1953
+ Returns a copy of the channel's metadata.
1954
+
1955
+ Note that changes made to the returned dictionary will not be applied to
1956
+ the channel's metadata.
1957
+ """
1958
+ ...
1959
+
1960
+ def schema(self) -> Schema | None:
1961
+ """
1962
+ Returns a copy of the channel's schema.
1963
+
1964
+ Note that changes made to the returned object will not be applied to
1965
+ the channel's schema.
1966
+ """
1967
+ ...
1968
+
1969
+ def schema_name(self) -> str | None:
1970
+ """The name of the schema for the channel."""
1971
+ ...
1972
+
1973
+ def has_sinks(self) -> bool:
1974
+ """Returns true if at least one sink is subscribed to this channel"""
1975
+ ...
1976
+
1977
+ def close(self) -> None:
1978
+ """Close the channel."""
1979
+ ...
1980
+
1981
+ def log(
1982
+ self,
1983
+ message: "PosesInFrame",
1984
+ *,
1985
+ log_time: int | None = None,
1986
+ sink_id: int | None = None,
1987
+ ) -> None:
1988
+ """Log a Foxglove PosesInFrame message on the channel."""
1989
+ ...
1990
+
1991
+ class QuaternionChannel:
1992
+ """
1993
+ A channel for logging Quaternion messages
1994
+
1995
+ You should choose a unique topic name per channel.
1996
+ """
1997
+
1998
+ def __init__(
1999
+ self,
2000
+ topic: str,
2001
+ *,
2002
+ metadata: dict[str, str] | None = None,
2003
+ context: Context | None = None,
2004
+ ) -> None: ...
2005
+ def id(self) -> int:
2006
+ """The unique ID of the channel."""
2007
+ ...
2008
+
2009
+ def topic(self) -> str:
2010
+ """The topic name of the channel."""
2011
+ ...
2012
+
2013
+ @property
2014
+ def message_encoding(self) -> str:
2015
+ """The message encoding for the channel"""
2016
+ ...
2017
+
2018
+ def metadata(self) -> dict[str, str]:
2019
+ """
2020
+ Returns a copy of the channel's metadata.
2021
+
2022
+ Note that changes made to the returned dictionary will not be applied to
2023
+ the channel's metadata.
2024
+ """
2025
+ ...
2026
+
2027
+ def schema(self) -> Schema | None:
2028
+ """
2029
+ Returns a copy of the channel's schema.
2030
+
2031
+ Note that changes made to the returned object will not be applied to
2032
+ the channel's schema.
2033
+ """
2034
+ ...
2035
+
2036
+ def schema_name(self) -> str | None:
2037
+ """The name of the schema for the channel."""
2038
+ ...
2039
+
2040
+ def has_sinks(self) -> bool:
2041
+ """Returns true if at least one sink is subscribed to this channel"""
2042
+ ...
2043
+
2044
+ def close(self) -> None:
2045
+ """Close the channel."""
2046
+ ...
2047
+
2048
+ def log(
2049
+ self,
2050
+ message: "Quaternion",
2051
+ *,
2052
+ log_time: int | None = None,
2053
+ sink_id: int | None = None,
2054
+ ) -> None:
2055
+ """Log a Foxglove Quaternion message on the channel."""
2056
+ ...
2057
+
2058
+ class RawAudioChannel:
2059
+ """
2060
+ A channel for logging RawAudio messages
2061
+
2062
+ You should choose a unique topic name per channel.
2063
+ """
2064
+
2065
+ def __init__(
2066
+ self,
2067
+ topic: str,
2068
+ *,
2069
+ metadata: dict[str, str] | None = None,
2070
+ context: Context | None = None,
2071
+ ) -> None: ...
2072
+ def id(self) -> int:
2073
+ """The unique ID of the channel."""
2074
+ ...
2075
+
2076
+ def topic(self) -> str:
2077
+ """The topic name of the channel."""
2078
+ ...
2079
+
2080
+ @property
2081
+ def message_encoding(self) -> str:
2082
+ """The message encoding for the channel"""
2083
+ ...
2084
+
2085
+ def metadata(self) -> dict[str, str]:
2086
+ """
2087
+ Returns a copy of the channel's metadata.
2088
+
2089
+ Note that changes made to the returned dictionary will not be applied to
2090
+ the channel's metadata.
2091
+ """
2092
+ ...
2093
+
2094
+ def schema(self) -> Schema | None:
2095
+ """
2096
+ Returns a copy of the channel's schema.
2097
+
2098
+ Note that changes made to the returned object will not be applied to
2099
+ the channel's schema.
2100
+ """
2101
+ ...
2102
+
2103
+ def schema_name(self) -> str | None:
2104
+ """The name of the schema for the channel."""
2105
+ ...
2106
+
2107
+ def has_sinks(self) -> bool:
2108
+ """Returns true if at least one sink is subscribed to this channel"""
2109
+ ...
2110
+
2111
+ def close(self) -> None:
2112
+ """Close the channel."""
2113
+ ...
2114
+
2115
+ def log(
2116
+ self,
2117
+ message: "RawAudio",
2118
+ *,
2119
+ log_time: int | None = None,
2120
+ sink_id: int | None = None,
2121
+ ) -> None:
2122
+ """Log a Foxglove RawAudio message on the channel."""
2123
+ ...
2124
+
2125
+ class RawImageChannel:
2126
+ """
2127
+ A channel for logging RawImage messages
2128
+
2129
+ You should choose a unique topic name per channel.
2130
+ """
2131
+
2132
+ def __init__(
2133
+ self,
2134
+ topic: str,
2135
+ *,
2136
+ metadata: dict[str, str] | None = None,
2137
+ context: Context | None = None,
2138
+ ) -> None: ...
2139
+ def id(self) -> int:
2140
+ """The unique ID of the channel."""
2141
+ ...
2142
+
2143
+ def topic(self) -> str:
2144
+ """The topic name of the channel."""
2145
+ ...
2146
+
2147
+ @property
2148
+ def message_encoding(self) -> str:
2149
+ """The message encoding for the channel"""
2150
+ ...
2151
+
2152
+ def metadata(self) -> dict[str, str]:
2153
+ """
2154
+ Returns a copy of the channel's metadata.
2155
+
2156
+ Note that changes made to the returned dictionary will not be applied to
2157
+ the channel's metadata.
2158
+ """
2159
+ ...
2160
+
2161
+ def schema(self) -> Schema | None:
2162
+ """
2163
+ Returns a copy of the channel's schema.
2164
+
2165
+ Note that changes made to the returned object will not be applied to
2166
+ the channel's schema.
2167
+ """
2168
+ ...
2169
+
2170
+ def schema_name(self) -> str | None:
2171
+ """The name of the schema for the channel."""
2172
+ ...
2173
+
2174
+ def has_sinks(self) -> bool:
2175
+ """Returns true if at least one sink is subscribed to this channel"""
2176
+ ...
2177
+
2178
+ def close(self) -> None:
2179
+ """Close the channel."""
2180
+ ...
2181
+
2182
+ def log(
2183
+ self,
2184
+ message: "RawImage",
2185
+ *,
2186
+ log_time: int | None = None,
2187
+ sink_id: int | None = None,
2188
+ ) -> None:
2189
+ """Log a Foxglove RawImage message on the channel."""
2190
+ ...
2191
+
2192
+ class SceneEntityChannel:
2193
+ """
2194
+ A channel for logging SceneEntity messages
2195
+
2196
+ You should choose a unique topic name per channel.
2197
+ """
2198
+
2199
+ def __init__(
2200
+ self,
2201
+ topic: str,
2202
+ *,
2203
+ metadata: dict[str, str] | None = None,
2204
+ context: Context | None = None,
2205
+ ) -> None: ...
2206
+ def id(self) -> int:
2207
+ """The unique ID of the channel."""
2208
+ ...
2209
+
2210
+ def topic(self) -> str:
2211
+ """The topic name of the channel."""
2212
+ ...
2213
+
2214
+ @property
2215
+ def message_encoding(self) -> str:
2216
+ """The message encoding for the channel"""
2217
+ ...
2218
+
2219
+ def metadata(self) -> dict[str, str]:
2220
+ """
2221
+ Returns a copy of the channel's metadata.
2222
+
2223
+ Note that changes made to the returned dictionary will not be applied to
2224
+ the channel's metadata.
2225
+ """
2226
+ ...
2227
+
2228
+ def schema(self) -> Schema | None:
2229
+ """
2230
+ Returns a copy of the channel's schema.
2231
+
2232
+ Note that changes made to the returned object will not be applied to
2233
+ the channel's schema.
2234
+ """
2235
+ ...
2236
+
2237
+ def schema_name(self) -> str | None:
2238
+ """The name of the schema for the channel."""
2239
+ ...
2240
+
2241
+ def has_sinks(self) -> bool:
2242
+ """Returns true if at least one sink is subscribed to this channel"""
2243
+ ...
2244
+
2245
+ def close(self) -> None:
2246
+ """Close the channel."""
2247
+ ...
2248
+
2249
+ def log(
2250
+ self,
2251
+ message: "SceneEntity",
2252
+ *,
2253
+ log_time: int | None = None,
2254
+ sink_id: int | None = None,
2255
+ ) -> None:
2256
+ """Log a Foxglove SceneEntity message on the channel."""
2257
+ ...
2258
+
2259
+ class SceneEntityDeletionChannel:
2260
+ """
2261
+ A channel for logging SceneEntityDeletion messages
2262
+
2263
+ You should choose a unique topic name per channel.
2264
+ """
2265
+
2266
+ def __init__(
2267
+ self,
2268
+ topic: str,
2269
+ *,
2270
+ metadata: dict[str, str] | None = None,
2271
+ context: Context | None = None,
2272
+ ) -> None: ...
2273
+ def id(self) -> int:
2274
+ """The unique ID of the channel."""
2275
+ ...
2276
+
2277
+ def topic(self) -> str:
2278
+ """The topic name of the channel."""
2279
+ ...
2280
+
2281
+ @property
2282
+ def message_encoding(self) -> str:
2283
+ """The message encoding for the channel"""
2284
+ ...
2285
+
2286
+ def metadata(self) -> dict[str, str]:
2287
+ """
2288
+ Returns a copy of the channel's metadata.
2289
+
2290
+ Note that changes made to the returned dictionary will not be applied to
2291
+ the channel's metadata.
2292
+ """
2293
+ ...
2294
+
2295
+ def schema(self) -> Schema | None:
2296
+ """
2297
+ Returns a copy of the channel's schema.
2298
+
2299
+ Note that changes made to the returned object will not be applied to
2300
+ the channel's schema.
2301
+ """
2302
+ ...
2303
+
2304
+ def schema_name(self) -> str | None:
2305
+ """The name of the schema for the channel."""
2306
+ ...
2307
+
2308
+ def has_sinks(self) -> bool:
2309
+ """Returns true if at least one sink is subscribed to this channel"""
2310
+ ...
2311
+
2312
+ def close(self) -> None:
2313
+ """Close the channel."""
2314
+ ...
2315
+
2316
+ def log(
2317
+ self,
2318
+ message: "SceneEntityDeletion",
2319
+ *,
2320
+ log_time: int | None = None,
2321
+ sink_id: int | None = None,
2322
+ ) -> None:
2323
+ """Log a Foxglove SceneEntityDeletion message on the channel."""
2324
+ ...
2325
+
2326
+ class SceneUpdateChannel:
2327
+ """
2328
+ A channel for logging SceneUpdate messages
2329
+
2330
+ You should choose a unique topic name per channel.
2331
+ """
2332
+
2333
+ def __init__(
2334
+ self,
2335
+ topic: str,
2336
+ *,
2337
+ metadata: dict[str, str] | None = None,
2338
+ context: Context | None = None,
2339
+ ) -> None: ...
2340
+ def id(self) -> int:
2341
+ """The unique ID of the channel."""
2342
+ ...
2343
+
2344
+ def topic(self) -> str:
2345
+ """The topic name of the channel."""
2346
+ ...
2347
+
2348
+ @property
2349
+ def message_encoding(self) -> str:
2350
+ """The message encoding for the channel"""
2351
+ ...
2352
+
2353
+ def metadata(self) -> dict[str, str]:
2354
+ """
2355
+ Returns a copy of the channel's metadata.
2356
+
2357
+ Note that changes made to the returned dictionary will not be applied to
2358
+ the channel's metadata.
2359
+ """
2360
+ ...
2361
+
2362
+ def schema(self) -> Schema | None:
2363
+ """
2364
+ Returns a copy of the channel's schema.
2365
+
2366
+ Note that changes made to the returned object will not be applied to
2367
+ the channel's schema.
2368
+ """
2369
+ ...
2370
+
2371
+ def schema_name(self) -> str | None:
2372
+ """The name of the schema for the channel."""
2373
+ ...
2374
+
2375
+ def has_sinks(self) -> bool:
2376
+ """Returns true if at least one sink is subscribed to this channel"""
2377
+ ...
2378
+
2379
+ def close(self) -> None:
2380
+ """Close the channel."""
2381
+ ...
2382
+
2383
+ def log(
2384
+ self,
2385
+ message: "SceneUpdate",
2386
+ *,
2387
+ log_time: int | None = None,
2388
+ sink_id: int | None = None,
2389
+ ) -> None:
2390
+ """Log a Foxglove SceneUpdate message on the channel."""
2391
+ ...
2392
+
2393
+ class SpherePrimitiveChannel:
2394
+ """
2395
+ A channel for logging SpherePrimitive messages
2396
+
2397
+ You should choose a unique topic name per channel.
2398
+ """
2399
+
2400
+ def __init__(
2401
+ self,
2402
+ topic: str,
2403
+ *,
2404
+ metadata: dict[str, str] | None = None,
2405
+ context: Context | None = None,
2406
+ ) -> None: ...
2407
+ def id(self) -> int:
2408
+ """The unique ID of the channel."""
2409
+ ...
2410
+
2411
+ def topic(self) -> str:
2412
+ """The topic name of the channel."""
2413
+ ...
2414
+
2415
+ @property
2416
+ def message_encoding(self) -> str:
2417
+ """The message encoding for the channel"""
2418
+ ...
2419
+
2420
+ def metadata(self) -> dict[str, str]:
2421
+ """
2422
+ Returns a copy of the channel's metadata.
2423
+
2424
+ Note that changes made to the returned dictionary will not be applied to
2425
+ the channel's metadata.
2426
+ """
2427
+ ...
2428
+
2429
+ def schema(self) -> Schema | None:
2430
+ """
2431
+ Returns a copy of the channel's schema.
2432
+
2433
+ Note that changes made to the returned object will not be applied to
2434
+ the channel's schema.
2435
+ """
2436
+ ...
2437
+
2438
+ def schema_name(self) -> str | None:
2439
+ """The name of the schema for the channel."""
2440
+ ...
2441
+
2442
+ def has_sinks(self) -> bool:
2443
+ """Returns true if at least one sink is subscribed to this channel"""
2444
+ ...
2445
+
2446
+ def close(self) -> None:
2447
+ """Close the channel."""
2448
+ ...
2449
+
2450
+ def log(
2451
+ self,
2452
+ message: "SpherePrimitive",
2453
+ *,
2454
+ log_time: int | None = None,
2455
+ sink_id: int | None = None,
2456
+ ) -> None:
2457
+ """Log a Foxglove SpherePrimitive message on the channel."""
2458
+ ...
2459
+
2460
+ class TextAnnotationChannel:
2461
+ """
2462
+ A channel for logging TextAnnotation messages
2463
+
2464
+ You should choose a unique topic name per channel.
2465
+ """
2466
+
2467
+ def __init__(
2468
+ self,
2469
+ topic: str,
2470
+ *,
2471
+ metadata: dict[str, str] | None = None,
2472
+ context: Context | None = None,
2473
+ ) -> None: ...
2474
+ def id(self) -> int:
2475
+ """The unique ID of the channel."""
2476
+ ...
2477
+
2478
+ def topic(self) -> str:
2479
+ """The topic name of the channel."""
2480
+ ...
2481
+
2482
+ @property
2483
+ def message_encoding(self) -> str:
2484
+ """The message encoding for the channel"""
2485
+ ...
2486
+
2487
+ def metadata(self) -> dict[str, str]:
2488
+ """
2489
+ Returns a copy of the channel's metadata.
2490
+
2491
+ Note that changes made to the returned dictionary will not be applied to
2492
+ the channel's metadata.
2493
+ """
2494
+ ...
2495
+
2496
+ def schema(self) -> Schema | None:
2497
+ """
2498
+ Returns a copy of the channel's schema.
2499
+
2500
+ Note that changes made to the returned object will not be applied to
2501
+ the channel's schema.
2502
+ """
2503
+ ...
2504
+
2505
+ def schema_name(self) -> str | None:
2506
+ """The name of the schema for the channel."""
2507
+ ...
2508
+
2509
+ def has_sinks(self) -> bool:
2510
+ """Returns true if at least one sink is subscribed to this channel"""
2511
+ ...
2512
+
2513
+ def close(self) -> None:
2514
+ """Close the channel."""
2515
+ ...
2516
+
2517
+ def log(
2518
+ self,
2519
+ message: "TextAnnotation",
2520
+ *,
2521
+ log_time: int | None = None,
2522
+ sink_id: int | None = None,
2523
+ ) -> None:
2524
+ """Log a Foxglove TextAnnotation message on the channel."""
2525
+ ...
2526
+
2527
+ class TextPrimitiveChannel:
2528
+ """
2529
+ A channel for logging TextPrimitive messages
2530
+
2531
+ You should choose a unique topic name per channel.
2532
+ """
2533
+
2534
+ def __init__(
2535
+ self,
2536
+ topic: str,
2537
+ *,
2538
+ metadata: dict[str, str] | None = None,
2539
+ context: Context | None = None,
2540
+ ) -> None: ...
2541
+ def id(self) -> int:
2542
+ """The unique ID of the channel."""
2543
+ ...
2544
+
2545
+ def topic(self) -> str:
2546
+ """The topic name of the channel."""
2547
+ ...
2548
+
2549
+ @property
2550
+ def message_encoding(self) -> str:
2551
+ """The message encoding for the channel"""
2552
+ ...
2553
+
2554
+ def metadata(self) -> dict[str, str]:
2555
+ """
2556
+ Returns a copy of the channel's metadata.
2557
+
2558
+ Note that changes made to the returned dictionary will not be applied to
2559
+ the channel's metadata.
2560
+ """
2561
+ ...
2562
+
2563
+ def schema(self) -> Schema | None:
2564
+ """
2565
+ Returns a copy of the channel's schema.
2566
+
2567
+ Note that changes made to the returned object will not be applied to
2568
+ the channel's schema.
2569
+ """
2570
+ ...
2571
+
2572
+ def schema_name(self) -> str | None:
2573
+ """The name of the schema for the channel."""
2574
+ ...
2575
+
2576
+ def has_sinks(self) -> bool:
2577
+ """Returns true if at least one sink is subscribed to this channel"""
2578
+ ...
2579
+
2580
+ def close(self) -> None:
2581
+ """Close the channel."""
2582
+ ...
2583
+
2584
+ def log(
2585
+ self,
2586
+ message: "TextPrimitive",
2587
+ *,
2588
+ log_time: int | None = None,
2589
+ sink_id: int | None = None,
2590
+ ) -> None:
2591
+ """Log a Foxglove TextPrimitive message on the channel."""
2592
+ ...
2593
+
2594
+ class TriangleListPrimitiveChannel:
2595
+ """
2596
+ A channel for logging TriangleListPrimitive messages
2597
+
2598
+ You should choose a unique topic name per channel.
2599
+ """
2600
+
2601
+ def __init__(
2602
+ self,
2603
+ topic: str,
2604
+ *,
2605
+ metadata: dict[str, str] | None = None,
2606
+ context: Context | None = None,
2607
+ ) -> None: ...
2608
+ def id(self) -> int:
2609
+ """The unique ID of the channel."""
2610
+ ...
2611
+
2612
+ def topic(self) -> str:
2613
+ """The topic name of the channel."""
2614
+ ...
2615
+
2616
+ @property
2617
+ def message_encoding(self) -> str:
2618
+ """The message encoding for the channel"""
2619
+ ...
2620
+
2621
+ def metadata(self) -> dict[str, str]:
2622
+ """
2623
+ Returns a copy of the channel's metadata.
2624
+
2625
+ Note that changes made to the returned dictionary will not be applied to
2626
+ the channel's metadata.
2627
+ """
2628
+ ...
2629
+
2630
+ def schema(self) -> Schema | None:
2631
+ """
2632
+ Returns a copy of the channel's schema.
2633
+
2634
+ Note that changes made to the returned object will not be applied to
2635
+ the channel's schema.
2636
+ """
2637
+ ...
2638
+
2639
+ def schema_name(self) -> str | None:
2640
+ """The name of the schema for the channel."""
2641
+ ...
2642
+
2643
+ def has_sinks(self) -> bool:
2644
+ """Returns true if at least one sink is subscribed to this channel"""
2645
+ ...
2646
+
2647
+ def close(self) -> None:
2648
+ """Close the channel."""
2649
+ ...
2650
+
2651
+ def log(
2652
+ self,
2653
+ message: "TriangleListPrimitive",
2654
+ *,
2655
+ log_time: int | None = None,
2656
+ sink_id: int | None = None,
2657
+ ) -> None:
2658
+ """Log a Foxglove TriangleListPrimitive message on the channel."""
2659
+ ...
2660
+
2661
+ class Vector2Channel:
2662
+ """
2663
+ A channel for logging Vector2 messages
2664
+
2665
+ You should choose a unique topic name per channel.
2666
+ """
2667
+
2668
+ def __init__(
2669
+ self,
2670
+ topic: str,
2671
+ *,
2672
+ metadata: dict[str, str] | None = None,
2673
+ context: Context | None = None,
2674
+ ) -> None: ...
2675
+ def id(self) -> int:
2676
+ """The unique ID of the channel."""
2677
+ ...
2678
+
2679
+ def topic(self) -> str:
2680
+ """The topic name of the channel."""
2681
+ ...
2682
+
2683
+ @property
2684
+ def message_encoding(self) -> str:
2685
+ """The message encoding for the channel"""
2686
+ ...
2687
+
2688
+ def metadata(self) -> dict[str, str]:
2689
+ """
2690
+ Returns a copy of the channel's metadata.
2691
+
2692
+ Note that changes made to the returned dictionary will not be applied to
2693
+ the channel's metadata.
2694
+ """
2695
+ ...
2696
+
2697
+ def schema(self) -> Schema | None:
2698
+ """
2699
+ Returns a copy of the channel's schema.
2700
+
2701
+ Note that changes made to the returned object will not be applied to
2702
+ the channel's schema.
2703
+ """
2704
+ ...
2705
+
2706
+ def schema_name(self) -> str | None:
2707
+ """The name of the schema for the channel."""
2708
+ ...
2709
+
2710
+ def has_sinks(self) -> bool:
2711
+ """Returns true if at least one sink is subscribed to this channel"""
2712
+ ...
2713
+
2714
+ def close(self) -> None:
2715
+ """Close the channel."""
2716
+ ...
2717
+
2718
+ def log(
2719
+ self,
2720
+ message: "Vector2",
2721
+ *,
2722
+ log_time: int | None = None,
2723
+ sink_id: int | None = None,
2724
+ ) -> None:
2725
+ """Log a Foxglove Vector2 message on the channel."""
2726
+ ...
2727
+
2728
+ class Vector3Channel:
2729
+ """
2730
+ A channel for logging Vector3 messages
2731
+
2732
+ You should choose a unique topic name per channel.
2733
+ """
2734
+
2735
+ def __init__(
2736
+ self,
2737
+ topic: str,
2738
+ *,
2739
+ metadata: dict[str, str] | None = None,
2740
+ context: Context | None = None,
2741
+ ) -> None: ...
2742
+ def id(self) -> int:
2743
+ """The unique ID of the channel."""
2744
+ ...
2745
+
2746
+ def topic(self) -> str:
2747
+ """The topic name of the channel."""
2748
+ ...
2749
+
2750
+ @property
2751
+ def message_encoding(self) -> str:
2752
+ """The message encoding for the channel"""
2753
+ ...
2754
+
2755
+ def metadata(self) -> dict[str, str]:
2756
+ """
2757
+ Returns a copy of the channel's metadata.
2758
+
2759
+ Note that changes made to the returned dictionary will not be applied to
2760
+ the channel's metadata.
2761
+ """
2762
+ ...
2763
+
2764
+ def schema(self) -> Schema | None:
2765
+ """
2766
+ Returns a copy of the channel's schema.
2767
+
2768
+ Note that changes made to the returned object will not be applied to
2769
+ the channel's schema.
2770
+ """
2771
+ ...
2772
+
2773
+ def schema_name(self) -> str | None:
2774
+ """The name of the schema for the channel."""
2775
+ ...
2776
+
2777
+ def has_sinks(self) -> bool:
2778
+ """Returns true if at least one sink is subscribed to this channel"""
2779
+ ...
2780
+
2781
+ def close(self) -> None:
2782
+ """Close the channel."""
2783
+ ...
2784
+
2785
+ def log(
2786
+ self,
2787
+ message: "Vector3",
2788
+ *,
2789
+ log_time: int | None = None,
2790
+ sink_id: int | None = None,
2791
+ ) -> None:
2792
+ """Log a Foxglove Vector3 message on the channel."""
2793
+ ...
2794
+
2795
+ class VoxelGridChannel:
2796
+ """
2797
+ A channel for logging VoxelGrid messages
2798
+
2799
+ You should choose a unique topic name per channel.
2800
+ """
2801
+
2802
+ def __init__(
2803
+ self,
2804
+ topic: str,
2805
+ *,
2806
+ metadata: dict[str, str] | None = None,
2807
+ context: Context | None = None,
2808
+ ) -> None: ...
2809
+ def id(self) -> int:
2810
+ """The unique ID of the channel."""
2811
+ ...
2812
+
2813
+ def topic(self) -> str:
2814
+ """The topic name of the channel."""
2815
+ ...
2816
+
2817
+ @property
2818
+ def message_encoding(self) -> str:
2819
+ """The message encoding for the channel"""
2820
+ ...
2821
+
2822
+ def metadata(self) -> dict[str, str]:
2823
+ """
2824
+ Returns a copy of the channel's metadata.
2825
+
2826
+ Note that changes made to the returned dictionary will not be applied to
2827
+ the channel's metadata.
2828
+ """
2829
+ ...
2830
+
2831
+ def schema(self) -> Schema | None:
2832
+ """
2833
+ Returns a copy of the channel's schema.
2834
+
2835
+ Note that changes made to the returned object will not be applied to
2836
+ the channel's schema.
2837
+ """
2838
+ ...
2839
+
2840
+ def schema_name(self) -> str | None:
2841
+ """The name of the schema for the channel."""
2842
+ ...
2843
+
2844
+ def has_sinks(self) -> bool:
2845
+ """Returns true if at least one sink is subscribed to this channel"""
2846
+ ...
2847
+
2848
+ def close(self) -> None:
2849
+ """Close the channel."""
2850
+ ...
2851
+
2852
+ def log(
2853
+ self,
2854
+ message: "VoxelGrid",
2855
+ *,
2856
+ log_time: int | None = None,
2857
+ sink_id: int | None = None,
2858
+ ) -> None:
2859
+ """Log a Foxglove VoxelGrid message on the channel."""
2860
+ ...