Universal Robots TypeScript API - v10.12.0
    Preparing search index...

    The quality of service profile for ROS2 communication.

    Index

    Constructors

    • Create a QosProfile for ROS2 communication.

      Parameters

      • Optionalhistory: HistoryPolicy

        HistoryPolicy The history value, default value is HistoryPolicy.KEEP_LAST.

      • Optionaldepth: number

        number The depth value, default value is depth=10.

      • Optionalreliability: ReliabilityPolicy

        ReliabilityPolicy The reliability value, default value is ReliabilityPolicy.RELIABLE.

      • Optionaldurability: DurabilityPolicy

        DurabilityPolicy The durability value, default value is DurabilityPolicy.VOLATILE.

      • Optionaldeadline: Duration

        The deadline value, default value is DurationUnspecified.

      • Optionallifespan: Duration

        The lifespan value, default value is DurationUnspecified.

      • Optionalliveliness: LivelinessPolicy

        LivelinessPolicy The liveliness value, default value is LivelinessPolicy.SYSTEM_DEFAULT.

      • Optionalliveliness_lease_duration: Duration

        The liveliness_lease_duration value, default values is DurationUnspecified.

      • Optionalavoid_ros_namespace_conventions: boolean

        The avoid_ros_namespace_conventions value, default value=false.

      Returns QoSProfile

    Properties

    avoid_ros_namespace_conventions: boolean
    deadline: Duration
    depth: number
    durability: DurabilityPolicy
    history: HistoryPolicy
    lifespan: Duration
    liveliness: LivelinessPolicy
    liveliness_lease_duration: Duration
    reliability: ReliabilityPolicy
    DurabilityPolicy: typeof DurabilityPolicy

    Get DurabilityPolicy enum.

    DurabilityPolicy

    HistoryPolicy: typeof HistoryPolicy

    Get HistoryPolicy enum.

    HistoryPolicy

    LivelinessPolicy: typeof LivelinessPolicy

    Get LivelinessPolicy enum

    LivelinessPolicy

    ReliabilityPolicy: typeof ReliabilityPolicy

    Get ReliabilityPolicy enum.

    ReliabilityPolicy

    Accessors

    • get compatible(): QoSProfile

      Get most compatible QoS profile with Reliability set to BEST_EFFORT. Values are: HistoryPolicy = KEEP_LAST, depth = 10, ReliabilityPolicy = BEST_EFFORT, DurabilityPolicy = VOLATILE, deadline = QoSProfile.DurationUnspecified, lifespan = QoSProfile.DurationUnspecified, LivelinessPolicy = SYSTEM_DEFAULT, liveliness_lease_duration = QoSProfile.DurationUnspecified, avoid_ros_namespace_conventions = false

      Returns QoSProfile

      QoSProfile

    • get default(): QoSProfile

      Get default profile. Default values are: HistoryPolicy = KEEP_LAST, depth = 10, ReliabilityPolicy = RELIABLE, DurabilityPolicy = VOLATILE, deadline = QoSProfile.DurationUnspecified, lifespan = QoSProfile.DurationUnspecified, LivelinessPolicy = SYSTEM_DEFAULT, liveliness_lease_duration = QoSProfile.DurationUnspecified, avoid_ros_namespace_conventions = false

      Returns QoSProfile

      QoSProfile

    • get DurationInfinite(): Duration

      Default duration is duration unspecified

      Returns Duration

    • get DurationUnspecified(): Duration

      Default duration is duration unspecified

      Returns Duration