Package com.viam.common.v1

Interface Common.KinematicJointOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Common.KinematicJoint, Common.KinematicJoint.Builder
Enclosing class:
Common
public static interface Common.KinematicJointOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Common.Vector3
    getAxis()
    .viam.common.v1.Vector3 axis = 4 [json_name = "axis"];
    Common.Geometry
    getGeometry()
    Only meaningful for prismatic joints
    String
    getId()
    string id = 1 [json_name = "id"];
    com.google.protobuf.ByteString
    getIdBytes()
    string id = 1 [json_name = "id"];
    Common.JointLimits
    getLimits()
    Effective limits the component serves
    Common.MimicJoint
    getMimic()
    .viam.common.v1.MimicJoint mimic = 6 [json_name = "mimic"];
    String
    getParent()
    Parent link id
    com.google.protobuf.ByteString
    getParentBytes()
    Parent link id
    Common.JointType
    getType()
    .viam.common.v1.JointType type = 3 [json_name = "type"];
    int
    getTypeValue()
    .viam.common.v1.JointType type = 3 [json_name = "type"];
    boolean
    hasAxis()
    .viam.common.v1.Vector3 axis = 4 [json_name = "axis"];
    boolean
    hasGeometry()
    Only meaningful for prismatic joints
    boolean
    hasLimits()
    Effective limits the component serves
    boolean
    hasMimic()
    .viam.common.v1.MimicJoint mimic = 6 [json_name = "mimic"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getId

      String getId()
      string id = 1 [json_name = "id"];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      string id = 1 [json_name = "id"];
      Returns:
      The bytes for id.

    • getParent

      String getParent()
       Parent link id
      string parent = 2 [json_name = "parent"];
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Parent link id
      string parent = 2 [json_name = "parent"];
      Returns:
      The bytes for parent.

    • getTypeValue

      int getTypeValue()
      .viam.common.v1.JointType type = 3 [json_name = "type"];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Common.JointType getType()
      .viam.common.v1.JointType type = 3 [json_name = "type"];
      Returns:
      The type.

    • hasAxis

      boolean hasAxis()
      .viam.common.v1.Vector3 axis = 4 [json_name = "axis"];
      Returns:
      Whether the axis field is set.

    • getAxis

      Common.Vector3 getAxis()
      .viam.common.v1.Vector3 axis = 4 [json_name = "axis"];
      Returns:
      The axis.

    • hasLimits

      boolean hasLimits()
       Effective limits the component serves
      .viam.common.v1.JointLimits limits = 5 [json_name = "limits"];
      Returns:
      Whether the limits field is set.

    • getLimits

      Common.JointLimits getLimits()
       Effective limits the component serves
      .viam.common.v1.JointLimits limits = 5 [json_name = "limits"];
      Returns:
      The limits.

    • hasMimic

      boolean hasMimic()
      .viam.common.v1.MimicJoint mimic = 6 [json_name = "mimic"];
      Returns:
      Whether the mimic field is set.

    • getMimic

      Common.MimicJoint getMimic()
      .viam.common.v1.MimicJoint mimic = 6 [json_name = "mimic"];
      Returns:
      The mimic.

    • hasGeometry

      boolean hasGeometry()
       Only meaningful for prismatic joints
      .viam.common.v1.Geometry geometry = 7 [json_name = "geometry"];
      Returns:
      Whether the geometry field is set.

    • getGeometry

      Common.Geometry getGeometry()
       Only meaningful for prismatic joints
      .viam.common.v1.Geometry geometry = 7 [json_name = "geometry"];
      Returns:
      The geometry.