pycatia.dnb_simulation_interfaces.analysis_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_simulation_interfaces.analysis_setting_att.AnalysisSettingAtt(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

AnalysisSettingAtt

Interface to handle parameters of DELMIA Analysis Tools Options Tab page Role:

This interface is implemented by a component which represents the controller of

Analysis Tools Options parameter settings.

Methods to set value of each parameter

Methods to get value of each parameter

Methods to get information on each parameter

Methods to lock/unlock value of each parameter

get_analysis_level_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnalysisLevel

parameter.

Role:Retrieves the state of the AnalysisLevel 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_anl_accel_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlAccelLimit

parameter.

Role:Retrieves the state of the AnlAccelLimit 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_anl_caution_zone_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlCautionZone

parameter.

Role:Retrieves the state of the AnlCautionZone 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_anl_int_dist_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlIntDist

parameter.

Role:Retrieves the state of the AnlIntDist 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_anl_intf_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlIntf

parameter.

Role:Retrieves the state of the AnlIntf 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_anl_io_analysis_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlIOAnalysis

parameter.

Role:Retrieves the state of the AnlIOAnalysis 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_anl_lin_accel_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlLinAccelLimit

parameter.

Role:Retrieves the state of the AnlLinAccelLimit 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_anl_lin_speed_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlLinSpeedLimit

parameter.

Role:Retrieves the state of the AnlLinSpeedLimit 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_anl_measure_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlMeasure

parameter.

Role:Retrieves the state of the AnlMeasure 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_anl_rot_accel_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlRotAccelLimit

parameter.

Role:Retrieves the state of the AnlRotAccelLimit 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_anl_rot_speed_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlRotSpeedLimit

parameter.

Role:Retrieves the state of the AnlRotSpeedLimit 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_anl_travel_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlTravelLimit

parameter.

Role:Retrieves the state of the AnlTravelLimit 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_anl_velocity_limit_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnlVelocityLimit

parameter.

Role:Retrieves the state of the AnlVelocityLimit 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_ask_anl_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AskAnlMode

parameter.

Role:Retrieves the state of the AskAnlMode 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_beep_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the BeepMode

parameter.

Role:Retrieves the state of the BeepMode 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_clash_colour_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ClashColor

parameter.

Role:Retrieves the state of the ClashColor 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_clearance_colour_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ClearanceColor

parameter.

Role:Retrieves the state of the ClearanceColor 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_colour_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ColorMode

parameter.

Role:Retrieves the state of the ColorMode 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_display_anl_status_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisplayAnlStatus

parameter.

Role:Retrieves the state of the DisplayAnlStatus 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_enable_anl_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the EnableAnlMode

parameter.

Role:Retrieves the state of the EnableAnlMode 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_sync_anl_specs_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SyncAnlSpecs

parameter.

Role:Retrieves the state of the SyncAnlSpecs 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_visualization_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the VisualizationMode

parameter.

Role:Retrieves the state of the VisualizationMode 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_voxel_static_anl_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the VoxelStaticAnl

parameter.

Role:Retrieves the state of the VoxelStaticAnl 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_white_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WhiteMode

parameter.

Role:Retrieves the state of the WhiteMode 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_analysis_level_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnalysisLevel parameter.

Role:Locks or unlocks the AnalysisLevel 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_anl_accel_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlAccelLimit parameter.

Role:Locks or unlocks the AnlAccelLimit 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_anl_caution_zone_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlCautionZone parameter.

Role:Locks or unlocks the AnlCautionZone 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_anl_int_dist_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlIntDist parameter.

Role:Locks or unlocks the AnlIntDist 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_anl_intf_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlIntf parameter.

Role:Locks or unlocks the AnlIntf 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_anl_io_analysis_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlIOAnalysis parameter.

Role:Locks or unlocks the AnlIOAnalysis 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_anl_lin_accel_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlLinAccelLimit parameter.

Role:Locks or unlocks the AnlLinAccelLimit 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_anl_lin_speed_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlLinSpeedLimit parameter.

Role:Locks or unlocks the AnlLinSpeedLimit 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_anl_measure_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlMeasure parameter.

Role:Locks or unlocks the AnlMeasure 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_anl_rot_accel_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlRotAccelLimit parameter.

Role:Locks or unlocks the AnlRotAccelLimit 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_anl_rot_speed_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlRotSpeedLimit parameter.

Role:Locks or unlocks the AnlRotSpeedLimit 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_anl_travel_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlTravelLimit parameter.

Role:Locks or unlocks the AnlTravelLimit 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_anl_velocity_limit_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnlVelocityLimit parameter.

Role:Locks or unlocks the AnlVelocityLimit 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_ask_anl_mode_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AskAnlMode parameter.

Role:Locks or unlocks the AskAnlMode 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_beep_mode_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the BeepMode parameter.

Role:Locks or unlocks the BeepMode 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_clash_colour_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the ClashColor parameter.

Role:Locks or unlocks the ClashColor 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_clearance_colour_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the ClearanceColor parameter.

Role:Locks or unlocks the ClearanceColor 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_colour_mode_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the ColorMode parameter.

Role:Locks or unlocks the ColorMode 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_display_anl_status_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the DisplayAnlStatus parameter.

Role:Locks or unlocks the DisplayAnlStatus 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_enable_anl_mode_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the EnableAnlMode parameter.

Role:Locks or unlocks the EnableAnlMode 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_sync_anl_specs_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the SyncAnlSpecs parameter.

Role:Locks or unlocks the SyncAnlSpecs 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_visualization_mode_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the VisualizationMode parameter.

Role:Locks or unlocks the VisualizationMode 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_voxel_static_anl_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the VoxelStaticAnl parameter.

Role:Locks or unlocks the VoxelStaticAnl 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_white_mode_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the WhiteMode parameter.

Role:Locks or unlocks the WhiteMode 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

pycatia.dnb_simulation_interfaces.analysis_setting_att¶

Navigation

Related Topics