simscape.multibody.PrismaticPrimitiveActuationForce Class

Namespace: simscape.multibody

Construct actuation force for prismatic joint primitive

Since R2024a

Description

Use an object of the simscape.multibody.PrismaticPrimitiveActuationForce class to construct an actuation force to apply to a prismatic joint primitive in a compiled multibody system.

Class Attributes

Sealed	true
ConstructOnLoad	true
RestrictsSubclassing	true

For information on class attributes, see Class Attributes.

Creation

Description

force = simscape.multibody.PrismaticPrimitiveActuationForce constructs an actuation force of 0 N.

force = simscape.multibody.PrismaticPrimitiveActuationForce("Computed") constructs a prismatic primitive that computes the actuation force required to satisfy the motion inputs to the compiled multibody system.

force = simscape.multibody.PrismaticPrimitiveActuationForce(value) constructs an actuation force with the specified value.

Input Arguments

value — Actuation force

simscape.Value

Actuation force, specified as a simscape.Value object that scalar with a unit of force.

Examples

Create Actuation Force for Prismatic Joint Primitive

Create an actuation force and specify its value as 5 N.

force = simscape.multibody.PrismaticPrimitiveActuationForce(...
                                      simscape.Value(5,"N"))

force = 

  PrismaticPrimitiveActuationForce

  Value: 5 : N

Version History

Introduced in R2024a