pycatia.dnb_device_interfaces.device_joint_relations

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_device_interfaces.device_joint_relations.DeviceJointRelations(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
DeviceJointRelations

INTERFACE : DNBIADeviceJointRelations
DESCRIPTION This interface allows to assign symbolic kinematic relations to
Mechanism joints
get_joint_relation_expression(joint: Joint, expr: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetJointRelationExpression(Joint joint,
CATBSTR expr)

Get Kin expression of the given Joint.

Parameters:

joint
This input parameter specify CATIAJoint interface.

expr
This out parameter contains kin expression assigned to ‘joint’.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise
.
Parameters:

  • joint (Joint) –

  • expr (str) –

Return type:

None

set_joint_relation_expression(joint: Joint, expr: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetJointRelationExpression(Joint joint,
CATBSTR expr)

Set Kin expression for the given Joint.

Parameters:

joint
This input parameter specifies CATIAJoint interface.

profile
This input parameter contains kin expression to be assigned for
‘joint’.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise
.
Parameters:

  • joint (Joint) –

  • expr (str) –

Return type:

None

set_user_variable_expr(user_expr: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetUserVariableExpr(CATBSTR user_expr)

Add the user-variable expression to the mechanism

Parameters:

user_expr
This input parameter is an user-variable expression.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise
.
Parameters:

user_expr (str) –

Return type:

None