addFrameVariables

Create kinematic variables from select frame pair in KinematicsSolver object

Syntax

addFrameVariables(ks,groupName,type,base,follower)

addFrameVariables(ks,groupName,type,base,follower,Name,Value)

Description

addFrameVariables(ks,groupName,type,base,follower) creates a set of frame variables for a pair of frames. One of the frames serves as the follower and the other serves as the base. These frame variables share a group name, which must be a valid MATLAB^® variable name, and correspond to a position or velocity relationship between the base and follower frames.

Use the type argument to specify the relationship for frame variables. There are four types: Translation, Rotation, LinearVelocity, and AngularVelocity. The base and follower arguments must be full paths to frame ports in the model.

The function outputs a table that includes all frame variables. Each row of the table includes ID, path from the root to the base and follower frames, and unit for its numerical value of a frame variable. The IDs of the frame variables have the form groupName.type.primitiveComponent.

addFrameVariables(ks,groupName,type,base,follower,Name,Value) creates a set of frame variables for a pair of frames that represents a position-based or velocity-based relationship. Use the Name-Value Arguments to specify the unit of the frame variables.

Input Arguments

ks — Kinematics solver object

KinematicsSolver object

Kinematics solver object, specified as a KinematicsSolver object that is the representation of the Simscape™ Multibody™ model used for kinematic analysis.

Example: ks = simscape.multibody.KinematicsSolver("DoublePendulumExample​'​')

groupName — Name of group in which to place new variables

string scalar or character array

Name of the group in which to place the new frame variables. If adding variables to an existing group, use the name of that group.

Example: 'wrist_position'

Data Types: char | string

type — Type of relationship to represent between frames

'Translation' | 'Rotation' | 'LinearVelocity' | 'AngularVelocity'

Type of relationship that the new frame variables are to represent, specified as one of the following options:

• The Translation variables represent to the x-, y-, z-components of the linear position of the follower frame with respect to the base frame.

• The Rotation variables represent the three angles of the xyz intrinsic rotation sequence specifying the angular position of the follower frame with respect to the base frame.

• The LinearVelocity variables represent to the x-, y-, z-components of the linear velocity of the follower frame with respect to the base frame.

• The AngularVelocity variables represent to the x-, y-, z-components of the angular velocity of the follower frame with respect to the base frame.

Note

The Translation, Rotation, and LinearVelocity variables are resolved in the base frame coordinates, but the AngularVelocity variables are resolved in the follower frame coordinates.

Example: 'Translation'

Data Types: char | string

base — Simulink path from model root to block port for base frame

string scalar or character array

Simulink path from the root of the model to the frame port from which to obtain the base frame. Frame variables each derive from a frame pair, one serving as base, the other as follower.

Example: 'ImportedURDFExample​/World/W'

Data Types: char | string

follower — Simulink path from model root to block port for follower frame

string scalar or character array

Simulink path from the root of the model to the frame port from which to obtain the follower frame. Frame variables each derive from a frame pair, one serving as base, the other as follower.

Example: 'ImportedURDFExample​/left_hand/F'

Data Types: char | string

Name-Value Arguments

Example: addFrameVariables('ks','Link','Rotation','FourBarExample​​/'World Frame/W','sm_four_bar/Connector Link/Left End Cap/R','AngleUnit','rad');

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

AngleUnit — Unit to replace default angular unit

string scalar | character array

Unit to replace the default angular unit, specified as the comma-separated pair consisting of 'AngleUnit' and a string scalar or character array. Use this argument when the type is 'Rotation'.

Example: rad

Data Types: char | string

LengthUnit — Unit to replace default length unit

string scalar | character array

Unit to replace the default length unit, specified as the comma-separated pair consisting of 'LengthUnit' and a string scalar or character array. Use this argument when the type is 'Translation'.

Example: in

Data Types: char | string

LinearVelocityUnit — Unit to replace default linear velocity unit

string scalar | character array

Unit to replace the default linear velocity unit, specified as the comma-separated pair consisting of 'LinearVelocityUnit' and a string scalar or character array. Use this argument when the type is 'LinearVelocity'.

Example: in/s

Data Types: char | string

AngularVelocityUnit — Unit to replace default angular velocity unit

string scalar | character array

Unit to replace the default angular velocity unit, specified as the comma-separated pair consisting of 'AngularVelocityUnit' and a string scalar or character array. Use this argument when the type is 'AngularVelocity'.

Example: rad/s

Data Types: char | string

Version History

Introduced in R2019a