Arm class abstract Components
Arm represents a physical robot arm that exists in three-dimensional space.
For more information, see Arm component.
Constructors
- Arm()
Properties
Methods
-
calculateMaxReach(
Arm arm) → Future< double> - Calculates the maximum reach of an arm by summing all link lengths. Returns the max reach in mm.
-
doCommand(
Map< String, dynamic> command) → Future<Map< String, dynamic> > -
Send/Receive arbitrary commands to the Resource
inherited
-
endPosition(
{Map< String, dynamic> ? extra}) → Future<Pose> - Get the current Pose of the end of the arm.
-
get3DModels(
{Map< String, dynamic> ? extra}) → Future<Map< String, Mesh> > - Get the Map of 3D models associated with the component.
-
getGeometries(
{Map< String, dynamic> ? extra}) → Future<List< Geometry> > - Get all geometries associated with the Arm
-
getKinematics(
{Map< String, dynamic> ? extra}) → Future<Kinematics> - Get the kinematics data associated with the Arm
-
getStatus(
) → Future< Map< String, dynamic> > -
Get the status of the Resource
inherited
-
isMoving(
) → Future< bool> - Whether the arm is currently moving
-
jointPositions(
{Map< String, dynamic> ? extra}) → Future<List< double> > - Get the List of current joint angles of each arm joint
-
manualMode(
{Map< String, dynamic> ? extra}) → Future<bool> - Whether the arm is currently in manual mode.
-
moveToJointPositions(
List< double> positions, {Map<String, dynamic> ? extra}) → Future<void> -
Move each joint on the arm to the corresponding position specified in
positions. -
moveToPosition(
Pose pose, {Map< String, dynamic> ? extra}) → Future<void> - Move the end of the arm to the Pose specified.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
properties(
{Map< String, dynamic> ? extra}) → Future<ArmProperties> - Report which optional features this arm supports.
-
setManualMode(
bool manualMode, {Duration enabledFor = Duration.zero, Map< String, dynamic> ? extra}) → Future<void> -
Enter or exit manual mode for an arm that supports it.
enabledForlimits how long the arm stays in manual mode; Duration.zero means no time limit. -
stop(
{Map< String, dynamic> ? extra}) → Future<void> - Stop all motion of the arm. It is assumed that the arm stops immediately.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
fromRobot(
RobotClient robot, String name) → Arm -
Get the Arm named
namefrom the provided robot. -
getResourceName(
String name) → ResourceName -
Get the ResourceName for this Arm with the given
name.