All Frameworks  Object Hierarchy  This Framework  Indexes

RobAnalysisHeartBeatUsageSettingAtt (Object)

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:

Property Index

EnableHeartBeat

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

Method Index

GetEnableHeartBeatInfo
Retrieves environment informations for the SingularColor parameter.
SetEnableHeartBeatLock
Locks or unlocks the SingularColor parameter.

Properties


o Property EnableHeartBeat() As

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.

Methods


o Func GetEnableHeartBeatInfo( ioAdminLevel,
ioLocked) As
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.
o Sub SetEnableHeartBeatLock( 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.

Copyright © 2003, Dassault Systèmes. All rights reserved.