joint_type

package

v0.1.4 Latest Latest Go to latest Published: Dec 18, 2025 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/WrenchRobotics/urdf-go

Links

Open Source Insights

Documentation ¶

Overview ¶

This package is used to define a form of enum with the internal type JointType.

Index ¶

type JointType
- func (jt *JointType) UnmarshalXMLAttr(attr xml.Attr) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type JointType ¶

type JointType string

A form of an "enum" that defines the many types of joints that are possible aaccording to the URDF specification.

const (
	RevoluteJoint   JointType = "revolute"
	ContinuousJoint JointType = "continuous"
	PrismaticJoint  JointType = "prismatic"
	FixedJoint      JointType = "fixed"
	FloatingJoint   JointType = "floating"
	PlanarJoint     JointType = "planar"
	UnknownJoint    JointType = "unknown"
)

func (*JointType) UnmarshalXMLAttr ¶

func (jt *JointType) UnmarshalXMLAttr(attr xml.Attr) error

UnmarshalXMLAttr allows for JointType objects to be decoded from the "attributes" of a tag.

For example, consider the following tag from a gripper URDF:

<joint name="finger_joint" type="revolute">

It assigns the "revolute" joint type using the attribute `type`.

This should not normally be called by the user. It is used to implement an interface from the xml package and do efficient decoding when we use `xml.Unmarshal`.

Source Files ¶

View all Source files

type.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL