pycatia.dnb_human_sim_interfaces.hts_joint_speed_settings_att

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_human_sim_interfaces.hts_joint_speed_settings_att.HtsJointSpeedSettingsAtt(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
System.SettingController
HtsJointSpeedSettingsAtt

Interface representing xxx.

Role: Components that implement DNBIAHtsJointSpeedSettingAtt are
…

Do not use the DNBIAHtsJointSpeedSettingAtt interface for such and such
ClassReference, Class#MethodReference, #InternalMethod…
property all_joints_speed: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AllJointsSpeed() As CATBSTR

Returns or sets the JointSpeed parameter.

Ensure consistency with the C++ interface to which the work is delegated.
Return type:

str

get_all_joints_speed_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAllJointsSpeedInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the JointSpeed parameter.
Role:Retrieves the state of the JointSpeed parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_rating_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetRatingInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the Rating
parameter.
Role:Retrieves the state of the Rating parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

property rating: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Rating() As CATBSTR

Returns or sets the Rating parameter.

Ensure consistency with the C++ interface to which the work is delegated.
Return type:

str

set_all_joints_speed_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAllJointsSpeedLock(boolean iLocked)

Locks or unlocks the JointSpeed parameter.
Role:Locks or unlocks the JointSpeed parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_rating_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetRatingLock(boolean iLocked)

Locks or unlocks the Rating parameter.
Role:Locks or unlocks the Rating parameter if it is possible in the current
administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None