1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
// The content of this file has the Apache 2.0 licence due to its origin in the rclrust repo (https://github.com/rclrust/rclrust). The licence of that repo is included below.
//
// Apache License
// Version 2.0, January 2004
// http://www.apache.org/licenses/
//
// TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
//
// 1. Definitions.
//
// "License" shall mean the terms and conditions for use, reproduction,
// and distribution as defined by Sections 1 through 9 of this document.
//
// "Licensor" shall mean the copyright owner or entity authorized by
// the copyright owner that is granting the License.
//
// "Legal Entity" shall mean the union of the acting entity and all
// other entities that control, are controlled by, or are under common
// control with that entity. For the purposes of this definition,
// "control" means (i) the power, direct or indirect, to cause the
// direction or management of such entity, whether by contract or
// otherwise, or (ii) ownership of fifty percent (50%) or more of the
// outstanding shares, or (iii) beneficial ownership of such entity.
//
// "You" (or "Your") shall mean an individual or Legal Entity
// exercising permissions granted by this License.
//
// "Source" form shall mean the preferred form for making modifications,
// including but not limited to software source code, documentation
// source, and configuration files.
//
// "Object" form shall mean any form resulting from mechanical
// transformation or translation of a Source form, including but
// not limited to compiled object code, generated documentation,
// and conversions to other media types.
//
// "Work" shall mean the work of authorship, whether in Source or
// Object form, made available under the License, as indicated by a
// copyright notice that is included in or attached to the work
// (an example is provided in the Appendix below).
//
// "Derivative Works" shall mean any work, whether in Source or Object
// form, that is based on (or derived from) the Work and for which the
// editorial revisions, annotations, elaborations, or other modifications
// represent, as a whole, an original work of authorship. For the purposes
// of this License, Derivative Works shall not include works that remain
// separable from, or merely link (or bind by name) to the interfaces of,
// the Work and Derivative Works thereof.
//
// "Contribution" shall mean any work of authorship, including
// the original version of the Work and any modifications or additions
// to that Work or Derivative Works thereof, that is intentionally
// submitted to Licensor for inclusion in the Work by the copyright owner
// or by an individual or Legal Entity authorized to submit on behalf of
// the copyright owner. For the purposes of this definition, "submitted"
// means any form of electronic, verbal, or written communication sent
// to the Licensor or its representatives, including but not limited to
// communication on electronic mailing lists, source code control systems,
// and issue tracking systems that are managed by, or on behalf of, the
// Licensor for the purpose of discussing and improving the Work, but
// excluding communication that is conspicuously marked or otherwise
// designated in writing by the copyright owner as "Not a Contribution."
//
// "Contributor" shall mean Licensor and any individual or Legal Entity
// on behalf of whom a Contribution has been received by Licensor and
// subsequently incorporated within the Work.
//
// 2. Grant of Copyright License. Subject to the terms and conditions of
// this License, each Contributor hereby grants to You a perpetual,
// worldwide, non-exclusive, no-charge, royalty-free, irrevocable
// copyright license to reproduce, prepare Derivative Works of,
// publicly display, publicly perform, sublicense, and distribute the
// Work and such Derivative Works in Source or Object form.
//
// 3. Grant of Patent License. Subject to the terms and conditions of
// this License, each Contributor hereby grants to You a perpetual,
// worldwide, non-exclusive, no-charge, royalty-free, irrevocable
// (except as stated in this section) patent license to make, have made,
// use, offer to sell, sell, import, and otherwise transfer the Work,
// where such license applies only to those patent claims licensable
// by such Contributor that are necessarily infringed by their
// Contribution(s) alone or by combination of their Contribution(s)
// with the Work to which such Contribution(s) was submitted. If You
// institute patent litigation against any entity (including a
// cross-claim or counterclaim in a lawsuit) alleging that the Work
// or a Contribution incorporated within the Work constitutes direct
// or contributory patent infringement, then any patent licenses
// granted to You under this License for that Work shall terminate
// as of the date such litigation is filed.
//
// 4. Redistribution. You may reproduce and distribute copies of the
// Work or Derivative Works thereof in any medium, with or without
// modifications, and in Source or Object form, provided that You
// meet the following conditions:
//
// (a) You must give any other recipients of the Work or
// Derivative Works a copy of this License; and
//
// (b) You must cause any modified files to carry prominent notices
// stating that You changed the files; and
//
// (c) You must retain, in the Source form of any Derivative Works
// that You distribute, all copyright, patent, trademark, and
// attribution notices from the Source form of the Work,
// excluding those notices that do not pertain to any part of
// the Derivative Works; and
//
// (d) If the Work includes a "NOTICE" text file as part of its
// distribution, then any Derivative Works that You distribute must
// include a readable copy of the attribution notices contained
// within such NOTICE file, excluding those notices that do not
// pertain to any part of the Derivative Works, in at least one
// of the following places: within a NOTICE text file distributed
// as part of the Derivative Works; within the Source form or
// documentation, if provided along with the Derivative Works; or,
// within a display generated by the Derivative Works, if and
// wherever such third-party notices normally appear. The contents
// of the NOTICE file are for informational purposes only and
// do not modify the License. You may add Your own attribution
// notices within Derivative Works that You distribute, alongside
// or as an addendum to the NOTICE text from the Work, provided
// that such additional attribution notices cannot be construed
// as modifying the License.
//
// You may add Your own copyright statement to Your modifications and
// may provide additional or different license terms and conditions
// for use, reproduction, or distribution of Your modifications, or
// for any such Derivative Works as a whole, provided Your use,
// reproduction, and distribution of the Work otherwise complies with
// the conditions stated in this License.
//
// 5. Submission of Contributions. Unless You explicitly state otherwise,
// any Contribution intentionally submitted for inclusion in the Work
// by You to the Licensor shall be under the terms and conditions of
// this License, without any additional terms or conditions.
// Notwithstanding the above, nothing herein shall supersede or modify
// the terms of any separate license agreement you may have executed
// with Licensor regarding such Contributions.
//
// 6. Trademarks. This License does not grant permission to use the trade
// names, trademarks, service marks, or product names of the Licensor,
// except as required for reasonable and customary use in describing the
// origin of the Work and reproducing the content of the NOTICE file.
//
// 7. Disclaimer of Warranty. Unless required by applicable law or
// agreed to in writing, Licensor provides the Work (and each
// Contributor provides its Contributions) on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied, including, without limitation, any warranties or conditions
// of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
// PARTICULAR PURPOSE. You are solely responsible for determining the
// appropriateness of using or redistributing the Work and assume any
// risks associated with Your exercise of permissions under this License.
//
// 8. Limitation of Liability. In no event and under no legal theory,
// whether in tort (including negligence), contract, or otherwise,
// unless required by applicable law (such as deliberate and grossly
// negligent acts) or agreed to in writing, shall any Contributor be
// liable to You for damages, including any direct, indirect, special,
// incidental, or consequential damages of any character arising as a
// result of this License or out of the use or inability to use the
// Work (including but not limited to damages for loss of goodwill,
// work stoppage, computer failure or malfunction, or any and all
// other commercial damages or losses), even if such Contributor
// has been advised of the possibility of such damages.
//
// 9. Accepting Warranty or Additional Liability. While redistributing
// the Work or Derivative Works thereof, You may choose to offer,
// and charge a fee for, acceptance of support, warranty, indemnity,
// or other liability obligations and/or rights consistent with this
// License. However, in accepting such obligations, You may act only
// on Your own behalf and on Your sole responsibility, not on behalf
// of any other Contributor, and only if You agree to indemnify,
// defend, and hold each Contributor harmless for any liability
// incurred by, or claims asserted against, such Contributor by reason
// of your accepting any such warranty or additional liability.
//
// END OF TERMS AND CONDITIONS
//
// APPENDIX: How to apply the Apache License to your work.
//
// To apply the Apache License to your work, attach the following
// boilerplate notice, with the fields enclosed by brackets "[]"
// replaced with your own identifying information. (Don't include
// the brackets!) The text should be enclosed in the appropriate
// comment syntax for the file format. We also recommend that a
// file or class name and description of purpose be included on the
// same "printed page" as the copyright notice for easier
// identification within third-party archives.
//
// Copyright [yyyy] [name of copyright owner]
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! QoS (Quality of Service)
//! full credit goes to <https://github.com/rclrust/rclrust/blob/main/rclrust/src/qos.rs>
use std::time::Duration;
use r2r_rcl::{
rmw_qos_durability_policy_t, rmw_qos_history_policy_t, rmw_qos_liveliness_policy_t,
rmw_qos_reliability_policy_t, rmw_time_t,
};
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum HistoryPolicy {
KeepAll,
KeepLast,
SystemDefault,
Unknown,
}
impl From<HistoryPolicy> for rmw_qos_history_policy_t {
fn from(history_policy: HistoryPolicy) -> Self {
match history_policy {
HistoryPolicy::KeepAll => rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_KEEP_ALL,
HistoryPolicy::KeepLast => rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_KEEP_LAST,
HistoryPolicy::SystemDefault => {
rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT
}
HistoryPolicy::Unknown => rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_UNKNOWN,
}
}
}
impl From<rmw_qos_history_policy_t> for HistoryPolicy {
fn from(rmw_history_policy: rmw_qos_history_policy_t) -> Self {
match rmw_history_policy {
rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_KEEP_ALL => HistoryPolicy::KeepAll,
rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_KEEP_LAST => HistoryPolicy::KeepLast,
rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT => {
HistoryPolicy::SystemDefault
}
rmw_qos_history_policy_t::RMW_QOS_POLICY_HISTORY_UNKNOWN => HistoryPolicy::Unknown,
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ReliabilityPolicy {
BestEffort,
Reliable,
SystemDefault,
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
BestAvailable,
Unknown,
}
impl From<ReliabilityPolicy> for rmw_qos_reliability_policy_t {
fn from(reliability_policy: ReliabilityPolicy) -> Self {
match reliability_policy {
ReliabilityPolicy::BestEffort => {
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT
}
ReliabilityPolicy::Reliable => {
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_RELIABLE
}
ReliabilityPolicy::SystemDefault => {
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT
}
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
ReliabilityPolicy::BestAvailable => {
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_BEST_AVAILABLE
}
ReliabilityPolicy::Unknown => {
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_UNKNOWN
}
}
}
}
impl From<rmw_qos_reliability_policy_t> for ReliabilityPolicy {
fn from(rmw_reliability_policy: rmw_qos_reliability_policy_t) -> Self {
match rmw_reliability_policy {
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT => {
ReliabilityPolicy::BestEffort
}
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_RELIABLE => {
ReliabilityPolicy::Reliable
}
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT => {
ReliabilityPolicy::SystemDefault
}
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_BEST_AVAILABLE => {
ReliabilityPolicy::BestAvailable
}
rmw_qos_reliability_policy_t::RMW_QOS_POLICY_RELIABILITY_UNKNOWN => {
ReliabilityPolicy::Unknown
}
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum DurabilityPolicy {
TransientLocal,
Volatile,
SystemDefault,
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
BestAvailable,
Unknown,
}
impl From<DurabilityPolicy> for rmw_qos_durability_policy_t {
fn from(durability_policy: DurabilityPolicy) -> Self {
match durability_policy {
DurabilityPolicy::TransientLocal => {
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL
}
DurabilityPolicy::Volatile => {
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_VOLATILE
}
DurabilityPolicy::SystemDefault => {
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT
}
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
DurabilityPolicy::BestAvailable => {
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_BEST_AVAILABLE
}
DurabilityPolicy::Unknown => {
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_UNKNOWN
}
}
}
}
impl From<rmw_qos_durability_policy_t> for DurabilityPolicy {
fn from(rmw_durability_policy: rmw_qos_durability_policy_t) -> Self {
match rmw_durability_policy {
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL => {
DurabilityPolicy::TransientLocal
}
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_VOLATILE => {
DurabilityPolicy::Volatile
}
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT => {
DurabilityPolicy::SystemDefault
}
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_BEST_AVAILABLE => {
DurabilityPolicy::BestAvailable
}
rmw_qos_durability_policy_t::RMW_QOS_POLICY_DURABILITY_UNKNOWN => {
DurabilityPolicy::Unknown
}
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum LivelinessPolicy {
Automatic,
ManualByNode,
ManualByTopic,
SystemDefault,
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
BestAvailable,
Unknown,
}
impl From<LivelinessPolicy> for rmw_qos_liveliness_policy_t {
fn from(liveliness_policy: LivelinessPolicy) -> Self {
match liveliness_policy {
LivelinessPolicy::Automatic => {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_AUTOMATIC
}
LivelinessPolicy::ManualByNode => {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_MANUAL_BY_NODE
}
LivelinessPolicy::ManualByTopic => {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_MANUAL_BY_TOPIC
}
LivelinessPolicy::SystemDefault => {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_SYSTEM_DEFAULT
}
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
LivelinessPolicy::BestAvailable => {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_BEST_AVAILABLE
}
LivelinessPolicy::Unknown => {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_UNKNOWN
}
}
}
}
impl From<rmw_qos_liveliness_policy_t> for LivelinessPolicy {
fn from(rmw_liveliness_policy: rmw_qos_liveliness_policy_t) -> Self {
match rmw_liveliness_policy {
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_AUTOMATIC => {
LivelinessPolicy::Automatic
}
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_MANUAL_BY_NODE => {
LivelinessPolicy::ManualByNode
}
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_MANUAL_BY_TOPIC => {
LivelinessPolicy::ManualByTopic
}
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_SYSTEM_DEFAULT => {
LivelinessPolicy::SystemDefault
}
#[cfg(any(r2r__ros__distro__iron, r2r__ros__distro__jazzy, r2r__ros__distro__rolling))]
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_BEST_AVAILABLE => {
LivelinessPolicy::BestAvailable
}
rmw_qos_liveliness_policy_t::RMW_QOS_POLICY_LIVELINESS_UNKNOWN => {
LivelinessPolicy::Unknown
}
}
}
}
/// QoS profile
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct QosProfile {
/// History QoS policy setting.
pub history: HistoryPolicy,
/// Size of the message queue.
pub depth: usize,
/// Reliabiilty QoS policy setting.
pub reliability: ReliabilityPolicy,
/// Durability QoS policy setting.
pub durability: DurabilityPolicy,
/// The period at which messages are expected to be sent/received.
pub deadline: Duration,
/// The age at which messages are considered expired and no longer valid.
pub lifespan: Duration,
/// Liveliness QoS policy setting.
pub liveliness: LivelinessPolicy,
/// The time within which the RMW node or publisher must show that it is alive.
pub liveliness_lease_duration: Duration,
/// If true, any ROS specific namespacing conventions will be circumvented.
///
/// In the case of DDS and topics, for example, this means the typical ROS specific prefix of rt
/// would not be applied as described here:
///
/// <http://design.ros2.org/articles/topic_and_service_names.html#ros-specific-namespace-prefix>
///
/// This might be useful when trying to directly connect a native DDS topic with a ROS 2 topic.
pub avoid_ros_namespace_conventions: bool,
}
impl QosProfile {
/// Sensor Data QoS class
/// - History: Keep last,
/// - Depth: 5,
/// - Reliability: Best effort,
/// - Durability: Volatile,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: System default,
/// - Liveliness lease duration: Default,
/// - avoid ros namespace conventions: false
pub const fn sensor_data() -> Self {
Self {
history: HistoryPolicy::KeepLast,
depth: 5,
reliability: ReliabilityPolicy::BestEffort,
durability: DurabilityPolicy::Volatile,
..Self::common()
}
}
/// Parameters QoS class
/// - History: Keep last,
/// - Depth: 1000,
/// - Reliability: Reliable,
/// - Durability: Volatile,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: System default,
/// - Liveliness lease duration: Default,
/// - Avoid ros namespace conventions: false
pub const fn parameters() -> Self {
Self {
history: HistoryPolicy::KeepLast,
depth: 1000,
reliability: ReliabilityPolicy::Reliable,
durability: DurabilityPolicy::Volatile,
..Self::common()
}
}
/// Default QoS class
/// - History: Keep last,
/// - Depth: 10,
/// - Reliability: Reliable,
/// - Durability: Volatile,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: System default,
/// - Liveliness lease duration: Default,
/// - Avoid ros namespace conventions: false
pub const fn default() -> Self {
Self {
history: HistoryPolicy::KeepLast,
depth: 10,
reliability: ReliabilityPolicy::Reliable,
durability: DurabilityPolicy::Volatile,
..Self::common()
}
}
/// Services QoS class
/// - History: Keep last,
/// - Depth: 10,
/// - Reliability: Reliable,
/// - Durability: Volatile,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: System default,
/// - Liveliness lease duration: Default,
/// - Avoid ros namespace conventions: false
pub const fn services_default() -> Self {
Self {
history: HistoryPolicy::KeepLast,
depth: 10,
reliability: ReliabilityPolicy::Reliable,
durability: DurabilityPolicy::Volatile,
..Self::common()
}
}
/// Parameter events QoS class
/// - History: Keep last,
/// - Depth: 1000,
/// - Reliability: Reliable,
/// - Durability: Volatile,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: System default,
/// - Liveliness lease duration: Default,
/// - Avoid ros namespace conventions: false
pub const fn parameter_events() -> Self {
Self {
history: HistoryPolicy::KeepLast,
depth: 1000,
reliability: ReliabilityPolicy::Reliable,
durability: DurabilityPolicy::Volatile,
..Self::common()
}
}
/// System defaults QoS class
/// - History: System default,
/// - Depth: System default,
/// - Reliability: System default,
/// - Durability: System default,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: System default,
/// - Liveliness lease duration: Default,
/// - Avoid ros namespace conventions: false
pub const fn system_default() -> Self {
Self::common()
}
/// Unknow QoS class
/// - History: Unknown,
/// - Depth: System default,
/// - Reliability: Unknown,
/// - Durability: Unknown,
/// - Deadline: Default,
/// - Lifespan: Default,
/// - Liveliness: Unknown,
/// - Liveliness lease duration: Default,
/// - Avoid ros namespace conventions: false
pub const fn unknown() -> Self {
Self {
history: HistoryPolicy::Unknown,
reliability: ReliabilityPolicy::Unknown,
durability: DurabilityPolicy::Unknown,
liveliness: LivelinessPolicy::Unknown,
..Self::common()
}
}
const fn common() -> Self {
Self {
history: HistoryPolicy::SystemDefault,
depth: r2r_rcl::RMW_QOS_POLICY_DEPTH_SYSTEM_DEFAULT as usize,
reliability: ReliabilityPolicy::SystemDefault,
durability: DurabilityPolicy::SystemDefault,
deadline: Duration::ZERO,
lifespan: Duration::ZERO,
liveliness: LivelinessPolicy::SystemDefault,
liveliness_lease_duration: Duration::ZERO,
avoid_ros_namespace_conventions: false,
}
}
/// Set the history policy.
///
/// # Examples
///
/// ```
/// # use r2r::qos::{HistoryPolicy, QosProfile};
/// #
/// let qos = QosProfile::default().history(HistoryPolicy::KeepAll);
/// ```
pub const fn history(self, history: HistoryPolicy) -> Self {
Self { history, ..self }
}
/// Set the history to keep last.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().keep_last(10);
/// ```
pub const fn keep_last(self, depth: usize) -> Self {
Self {
history: HistoryPolicy::KeepLast,
depth,
..self
}
}
/// Set the history to keep all.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().keep_all();
/// ```
pub const fn keep_all(self) -> Self {
Self {
history: HistoryPolicy::KeepAll,
depth: 0,
..self
}
}
/// Set the reliability setting.
///
/// # Examples
///
/// ```
/// # use r2r::qos::{QosProfile, ReliabilityPolicy};
/// #
/// let qos = QosProfile::default().reliability(ReliabilityPolicy::Reliable);
/// ```
pub const fn reliability(self, reliability: ReliabilityPolicy) -> Self {
Self {
reliability,
..self
}
}
/// Set the reliability setting to reliable.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().reliable();
/// ```
pub const fn reliable(self) -> Self {
self.reliability(ReliabilityPolicy::Reliable)
}
/// Set the reliability setting to best effort.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().best_effort();
/// ```
pub const fn best_effort(self) -> Self {
self.reliability(ReliabilityPolicy::BestEffort)
}
/// Set the durability setting.
///
/// # Examples
///
/// ```
/// # use r2r::qos::{DurabilityPolicy, QosProfile};
/// #
/// let qos = QosProfile::default().durability(DurabilityPolicy::Volatile);
/// ```
pub const fn durability(self, durability: DurabilityPolicy) -> Self {
Self { durability, ..self }
}
/// Set the durability setting to volatile.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().volatile();
/// ```
pub const fn volatile(self) -> Self {
self.durability(DurabilityPolicy::Volatile)
}
/// Set the durability setting to transient local.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().transient_local();
/// ```
pub const fn transient_local(self) -> Self {
self.durability(DurabilityPolicy::TransientLocal)
}
/// Set the deadline setting.
///
/// # Examples
///
/// ```
/// # use std::time::Duration;
/// #
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().deadline(Duration::from_secs(5));
/// ```
pub const fn deadline(self, deadline: Duration) -> Self {
Self { deadline, ..self }
}
/// Set the lifespan setting.
///
/// # Examples
///
/// ```
/// # use std::time::Duration;
/// #
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().lifespan(Duration::from_secs(5));
/// ```
pub const fn lifespan(self, lifespan: Duration) -> Self {
Self { lifespan, ..self }
}
/// Set the liveliness setting.
///
/// # Examples
///
/// ```
/// # use r2r::qos::{LivelinessPolicy, QosProfile};
/// #
/// let qos = QosProfile::default().liveliness(LivelinessPolicy::Automatic);
/// ```
pub const fn liveliness(self, liveliness: LivelinessPolicy) -> Self {
Self { liveliness, ..self }
}
/// Set the liveliness_lease_duration setting.
///
/// # Examples
///
/// ```
/// # use std::time::Duration;
/// #
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().liveliness_lease_duration(Duration::from_secs(5));
/// ```
pub const fn liveliness_lease_duration(self, liveliness_lease_duration: Duration) -> Self {
Self {
liveliness_lease_duration,
..self
}
}
/// Set the avoid_ros_namespace_conventions setting.
///
/// # Examples
///
/// ```
/// # use r2r::qos::QosProfile;
/// #
/// let qos = QosProfile::default().avoid_ros_namespace_conventions(true);
/// ```
pub const fn avoid_ros_namespace_conventions(
self, avoid_ros_namespace_conventions: bool,
) -> Self {
Self {
avoid_ros_namespace_conventions,
..self
}
}
}
impl From<QosProfile> for r2r_rcl::rmw_qos_profile_t {
fn from(qos: QosProfile) -> Self {
Self {
history: qos.history.into(),
depth: qos.depth,
reliability: qos.reliability.into(),
durability: qos.durability.into(),
deadline: qos.deadline.to_rmw_time_t(),
lifespan: qos.lifespan.to_rmw_time_t(),
liveliness: qos.liveliness.into(),
liveliness_lease_duration: qos.liveliness_lease_duration.to_rmw_time_t(),
avoid_ros_namespace_conventions: qos.avoid_ros_namespace_conventions,
}
}
}
impl From<r2r_rcl::rmw_qos_profile_t> for QosProfile {
fn from(rmw_qos: r2r_rcl::rmw_qos_profile_t) -> Self {
QosProfile {
history: rmw_qos.history.into(),
depth: rmw_qos.depth,
reliability: rmw_qos.reliability.into(),
durability: rmw_qos.durability.into(),
deadline: Duration::from_rmw_time_t(&rmw_qos.deadline),
lifespan: Duration::from_rmw_time_t(&rmw_qos.lifespan),
liveliness: rmw_qos.liveliness.into(),
liveliness_lease_duration: Duration::from_rmw_time_t(
&rmw_qos.liveliness_lease_duration,
),
avoid_ros_namespace_conventions: rmw_qos.avoid_ros_namespace_conventions,
}
}
}
pub(crate) trait RclDurationT {
fn to_rmw_time_t(&self) -> rmw_time_t;
fn from_rmw_time_t(rmw_time: &rmw_time_t) -> Self;
}
impl RclDurationT for Duration {
fn to_rmw_time_t(&self) -> rmw_time_t {
rmw_time_t {
sec: self.as_secs(),
nsec: self.subsec_nanos().into(),
}
}
fn from_rmw_time_t(rmw_time: &rmw_time_t) -> Self {
#[cfg(not(r2r__ros__distro__foxy))]
{
assert!(
rmw_time.nsec < 1_000_000_000,
"nsec part of rmw_time_t should be less than 1 billion"
);
}
#[cfg(r2r__ros__distro__foxy)]
{
// FIXME: In foxy, duration data obtained from publisher with default qos profile is
// sec: 7FFFFFFF (2147483647), nsec: FFFFFFFF (4294967295)
if rmw_time.nsec == 4294967295 {
// 0s indicates deadline policies are not tracked or enforced in foxy
return Duration::new(0, 0);
} else if rmw_time.nsec > 1_000_000_000 {
panic!("nsec part of rmw_time_t should be less than 1 billion");
}
}
Duration::new(rmw_time.sec, rmw_time.nsec as u32)
}
}