pycatia.dnb_robot_interfaces.generic_motion_profile

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dnb_robot_interfaces.generic_motion_profile.GenericMotionProfile(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

GenericMotionProfile

Interface to manage Generic Motion Profile of Robot

controller.

Role: This interface provides methods to get/set data related to Accuracy

Profile.

get_acceleration_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetAccelerationValue(double value)

Retrieves acceleration value of the Profile.

Parameters:

value

This out parameter contains motion acceleration of the Profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

get_angular_acceleration_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetAngularAccelerationValue(double value)

Get Angular acceleration value of the Profile.

Parameters:

value

Percentage of max angular acceleration of robot. The value is used

when robot TCP rotate against a axis.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

get_angular_speed_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetAngularSpeedValue(double value)

Retrieves Angular Speed value of the Profile.

Parameters:

value

This out parameter contains Angular Speed of the Profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

get_controller(o_controller: RobGenericController) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetController(RobGenericController oController)

Retrieves controller owning the profile.

Parameters:

oController

This parameter contains pointer to controller.

Returns:

An HRESULT.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

o_controller (RobGenericController) –

Return type:

None

get_motion_basis(basis: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetMotionBasis(MotionBasis basis)

Retrieves motion basis of the Profile.

Parameters:

basis

motion basis, one of following: MOTION_ABSOLUTE, MOTION_PERCENT,

MOTION_TIME

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

basis (int) – enum motion_basis

Return type:

None

get_name(o_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetName(CATBSTR oName)

Gets name of the Motion Profile.

Parameters:

oName

Name of the required Motion Profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

o_name (str) –

Return type:

None

get_speed_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetSpeedValue(double value)

Retrieves speed value of the Profile.

Parameters:

value

This out parameter contains motion speed of the Profile.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

set_acceleration_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetAccelerationValue(double value)

Set acceleration value of the Profile.

Parameters:

value

meaning of the value is based on the motion basis:

MOTION_ABSOLUTE : absolute acceleration value. MOTION_PERCENT : 0-1, percent of

max acceleration of the device MOTION_TIME : percent of total move time used on

acceleration/deceleration

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

set_angular_acceleration_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetAngularAccelerationValue(double value)

Set Angular acceleration value of the Profile.

Parameters:

value

Percentage of max angular acceleration of robot. The value is used

when robot TCP rotate against a axis.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

set_angular_speed_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetAngularSpeedValue(double value)

Set Angular Speed value of the Profile.

Parameters:

value

Percentage of max angular speed of robot. The value is used when

robot TCP rotate against a axis.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None

set_motion_basis(basis: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetMotionBasis(MotionBasis basis)

Set motion basis of the Profile.

Parameters:

basis

motion basis, one of following: MOTION_ABSOLUTE, MOTION_PERCENT,

MOTION_TIME

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

basis (int) – enum motion_basis

Return type:

None

set_name(i_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetName(CATBSTR iName)

Set name of the Motion Profile.

Parameters:

iName

Name of the Motion Profile to be set.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

i_name (str) –

Return type:

None

set_speed_value(value: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetSpeedValue(double value)

Set speed value of the Profile.

Parameters:

value

meaning of the value is based on the motion basis: MOTION_ABSOLUTE : absolute

speed value. MOTION_PERCENT : 0-1, percent of max speed of the device

MOTION_TIME : in seconds

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Parameters:

value (float) –

Return type:

None