component

Class: simscape.multibody.Multibody
Namespace: simscape.multibody

Extract component object from Multibody object

Since R2022a

Syntax

C = component(mb,path)

Description

C = component(mb,path) extracts a component object, C, from the simscape.multibody.Multibody object, mb. The path argument is the path of the component object in the mb object and can have more than one elements. In other words, the component method can extract an object from any hierarchical level of the mb object.

The extracted object is a copy of the original component object. Therefore, any subsequent changes to the extracted copy do not affect the original component object.

Input Arguments

mb — Multibody system

simscape.multibody.Multibody object

Multibody system, specified as a simscape.multibody.Multibody object.

path — Path of component object

string scalar | character vector

Path of the component object, specified as a string scalar or character vector. The length of the path depends on the hierarchical level of the component object in the Multibody object. If the object is at the top level, the path has one element. If the component object is in an inner object that is at the top level hierarchy, the path has two elements separated by a forward slash. The first element is the name of the inner object, and the second element is the name of desired component object.

Example: "Suspension/Front_Left/Shock/Prismatic_Joint"

Output Arguments

C — Copy of component object

object of subclass of simscape.multibody.Component class

Copy of the component object, returned as an object of a subclass of simscape.multibody.Component abstract class. Modifying the extracted component object does not affect the original component object.

Attributes

Access

public

To learn about attributes of methods, see Method Attributes.

Version History

Introduced in R2022a