pycatia.dnb_robot_interfaces.rob_analysis_heart_beat_usage_setting_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_robot_interfaces.rob_analysis_heart_beat_usage_setting_att.RobAnalysisHeartBeatUsageSettingAtt(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
RobAnalysisHeartBeatUsageSettingAtt

Interface to handle the parameter used to set as an option, to either enable or
disable robot heart beat rate while motion planning, in the
Infrastructure-DELMIA Infrastructure-Robot Analysis Tools Options Tab
page.
Role: This interface is implemented by a component which is one among the
controller properties of Robot Analysis Tools Options parameter settings. Here
is the parameter to use and its meaning:

EnableHeartBeat: defines whether to enable robot motion planning based on
robot heart beat rate
property enable_heart_beat: bool

Note

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


Role:Enables or Disables the Heart Beat Rate while the robot motion is
planned return E_FAIL.

Parameters:

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

bool

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

Note

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

Retrieves environment informations for the SingularColor
parameter.
Role:Retrieves the state of the SingularColor 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

set_enable_heart_beat_lock(i_locked: bool) → None

Note

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

Locks or unlocks the SingularColor parameter.
Role:Locks or unlocks the SingularColor 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