Main Content

simscape.multibody.Multibody class

Package: simscape.multibody
Superclasses: simscape.multibody.Component

Specify structure of multibody system

Description

Use an object of the simscape.multibody.Multibody class to construct a multibody system. A Multibody object is a hierarchical container that can have any type of component object, and each component object represents a part or a subsystem of the multibody system. See simscape.multibody.Component for more information about different component objects.

By default, a newly created Multibody object is empty. You can use the methods of the Multibody object to construct a multibody system, prepare the Multibody object for analyses, or create a corresponding Simulink® model. See the More About section for more information about the Multibody class.

The simscape.multibody.Multibody class is a handle class.

Class Attributes

Sealed
true
ConstructOnLoad
true
HandleCompatible
true
RestrictsSubclassing
true

For information on class attributes, see Class Attributes.

Creation

Description

mb = simscape.multibody.Multibody creates an empty simscape.multibody.Multibody object.

Properties

expand all

Names of the component objects at the top level of the simscape.multibody.Multibody object, returned as a string array.

Example: "Base_Bar"

Attributes:

GetAccess
public
SetAccess
Restricts access
NonCopyable
true
Transient
true

Gravitational acceleration in the multibody system, specified as a simscape.Value object that represents a 3-by-1 or 1-by-3 vector with a unit of linear acceleration. The elements of the vector specify the gravity in the x, y, and z directions of the world frame. In a hierarchical simscape.multibody.Multibody object, the Gravity property of the higher-level Multibody object overrides the Gravity property of its contained Multibody objects.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true
Transient
true

Methods

expand all

More About

expand all

Version History

Introduced in R2022a