Class MechanicalUnit
Defines a mechanical unit object.
Inherited Members
Namespace: ABB.Robotics.Controllers.MotionDomain
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public class MechanicalUnit : SDKControllerBoundBase, IComparable, INamedObject, IDisposable
Properties
DriveModule
Gets the current drive module for the mechanical unit.
Declaration
public int DriveModule { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
IsCalibrated
Checks if the mech is calibrated.
Declaration
public bool IsCalibrated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Model
Gets the model of the mechanical unit, or string.Empty if no model is available.
Declaration
public string Model { get; }
Property Value
Type | Description |
---|---|
System.String |
NumberOfAxes
Gets the number of axes for the mechanical unit.
Declaration
public int NumberOfAxes { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
PayLoad
Gets the current payload object.
Declaration
public PayLoad PayLoad { get; }
Property Value
Type | Description |
---|---|
PayLoad |
SerialNumber
Gets the serial number from the mech if it is a robot, otherwise it will return an empty string.
Declaration
public string SerialNumber { get; }
Property Value
Type | Description |
---|---|
System.String |
ServiceInfo
Gets service info for this unit. This property is not valid for a Virtual Controller.
Declaration
public MechanicalUnitServiceInfo ServiceInfo { get; }
Property Value
Type | Description |
---|---|
MechanicalUnitServiceInfo |
Task
Gets the task for this mech unit
Declaration
public Task Task { get; }
Property Value
Type | Description |
---|---|
Task |
Tool
Gets the current tool object.
Declaration
public Tool Tool { get; }
Property Value
Type | Description |
---|---|
Tool |
Type
Gets the type of mechanical unit.
Declaration
public MechanicalUnitType Type { get; }
Property Value
Type | Description |
---|---|
MechanicalUnitType |
WorkObject
Gets the current work object for the mechanical unit.
Declaration
public WorkObject WorkObject { get; }
Property Value
Type | Description |
---|---|
WorkObject |
Methods
FineCalibrate(Int32)
Fine calibrate specified TCP mechanical unit and axis. The current position of the axis will be the new calibration value.
Declaration
public void FineCalibrate(int axis)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | axis | Axis to calibrate |
GetMechanicalUnitStatus()
Get status of all mechanical unit axis
Declaration
public MechanicalUnitStatus GetMechanicalUnitStatus()
Returns
Type | Description |
---|---|
MechanicalUnitStatus |
GetPosition()
Gets the jointtarget position of the mechanical unit.
Declaration
public JointTarget GetPosition()
Returns
Type | Description |
---|---|
JointTarget | The position of the mechanical unit as a JointTarget. |
Remarks
Supports all mechanical unit types, including external axis.
GetPosition(CoordinateSystemType)
Gets the robtarget position of the mechanical unit.
Declaration
public RobTarget GetPosition(CoordinateSystemType coordinateSystem)
Parameters
Type | Name | Description |
---|---|---|
CoordinateSystemType | coordinateSystem |
Returns
Type | Description |
---|---|
RobTarget | The position of the mechanical unit as a RobTarget. |
Remarks
Supports mechanical unit type TCP Robot only.
GetSingleAxisStatus(Int32)
Get status for mechanical unit axis
Declaration
public MechanicalUnitStatus GetSingleAxisStatus(int axis)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | axis |
Returns
Type | Description |
---|---|
MechanicalUnitStatus |
SetRevolutionCounter(Int32)
Set revolution counter on a specified TCP mechanical unit and axis.
Declaration
public void SetRevolutionCounter(int axis)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | axis |