Download Joint

Quick Facts

Quick Start

# Boilerplate Example
downloadJoint = ...  # obtained from the runtime context
result = downloadJoint.GetName()

Method Index

Query Methods

GetName

def GetName() -> str

Gets the joint name.

Returns: str — returns the joint name as string

GetDofNumber

def GetDofNumber() -> int

Gets the DOF index.

Returns: int — returns the dof number

GetJointIndex

def GetJointIndex() -> int

Gets the joint index starting from base 1.

Returns: int — returns the joint index as int

GetJointGroupIndex

def GetJointGroupIndex() -> int

Gets joint group index.

Returns: int — returns the joint group index as int

GetJointType

def GetJointType() -> JointKinematicType

Gets the joint type.

Returns: JointKinematicType — returns the joint type

GetUnit

def GetUnit() -> str

Gets the joint unit.

Returns: str — returns the joint unit as string

GetPortName

def GetPortName() -> str

Gets joint port name.

Returns: str — returns the joint part name as string

IsExternal

def IsExternal() -> bool

Gets the information whether or not the joint is an external one.

Returns: bool — returns True if joint is external, False otherwise.

GetJointRole

def GetJointRole() -> JointConstellationRole

Gets the role of this joint

Returns: JointConstellationRole — returns what role the joint has. See JointConstellationRole for details.

Related Types

• Joint Kinematic Type
• Joint Constellation Role

Version Notes

This class is documented as of release R2025.2.4.