simscape.multibody.LeadScrewPrimitive Class

Namespace: simscape.multibody
Superclasses: simscape.multibody.JointPrimitive

Construct lead-screw primitive

Since R2022a

Description

Use an object of the simscape.multibody.LeadScrewPrimitive class to construct a lead-screw joint primitive. A lead-screw joint primitive has one degree of freedom and models a pair of coupled rotation and translation. The rotation is about the z-axis of the LeadScrewPrimitive object, and the translation is along the z-axis. A helpful mental model is how a nut moves along a threaded screw.

To fully characterize the kinematics of a lead-screw joint primitive, use the Lead and Direction properties of the primitive to specify the relationship between the rotation and translation.

Class Attributes

Sealed	true
ConstructOnLoad	true
RestrictsSubclassing	true

For information on class attributes, see Class Attributes.

Creation

Description

lsp = simscape.multibody.LeadScrewPrimitive constructs a lead-screw joint primitive with default values.

Properties

Lead — Lead of lead-screw primitive

simscape.Value(1,"mm/rev") (default) | simscape.Value(ratio,"Length/angle unit")

Lead of the lead-screw primitive, specified as a simscape.Value object that represents a scalar with a unit of length/angle. The scalar must be positive and specifies the axial translation the follower frame makes with respect to the base frame per unit of revolution of the follower frame.

Example: simscape.Value(0.5,"mm/rev")

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Direction — Handedness of lead-screw primitive

simscape.multibody.Handedness.RightHand member (default) | simscape.multibody.Handedness.LeftHand member

Handedness of the lead-screw primitive, specified as a member of the simscape.multibody.Handedness class. When you set the property to the RightHand member, the angular position of the primitive increases as the translational position increases. When you set this property to the LeftHand member, the angular position of the primitive increases as the translational position decreases.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Version History

Introduced in R2022a