pycatia.assembly_interfaces.assembly_general_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.assembly_interfaces.assembly_general_setting_att.AssemblyGeneralSettingAtt(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
AsmGeneralSettingAtt

Represents the Assembly General setting controller object.
Role: the Assembly General setting controller object deals with the setting
parameters displayed in the Assembly General property page. To access this
property page:

Click the Options command in the Tools menu
Click + left of Mechanical Design to unfold the workbench
list
Click Assembly Design: General tab
property auto_switch_to_design_mode: int

Note

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

Returns or sets the implicit switch from visualization mode to design mode
setting parameter .
Role: The implicit switch from visualization mode to design mode setting
parameter manages the loading of necessayr data whenever they are needed. Note
that this option is useful only when the Cache option is
activated
Legal values:
catAutoSwitchUnavailable Automatic switch to design mode
unavailable
catAutoSwitchAvailable Automatic switch to design mode
available

Example:
The following example retrieves the implicit switch setting parameter
of AsmGeneralSettingAtt1 in SwitchMode and enables the
switch

Set SwitchMode = AsmGeneralSettingAtt1.AutoSwitchToDesignMode
AsmGeneralSettingAtt1.AutoSwitchToDesignMode = catAutoSwitchAvailable
Returns:

enum cat_asm_auto_switch_to_design_mode

Return type:

int

property auto_update_mode: int

Note

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

Returns or sets the automatic update setting parameter.
Role: The automatic update setting parameter manages the automatic
launching of the Update command.
Legal values:
catManualUpdate Manual update mode
catAutomaticUpdate Automatic update mode

Example:
The following example retrieves the automatic update setting parameter
of AsmGeneralSettingAtt1 in UpdateMode and sets the mode to manual
update.

Set UpdateMode = AsmGeneralSettingAtt1.AutoUpdateMode
AsmGeneralSettingAtt1.AutoUpdateMode = catManualUpdate
Returns:

enum cat_asm_update_mode

Return type:

int

get_auto_switch_to_design_mode_info(admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAutoSwitchToDesignModeInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves the state of the implicit switch from visualization mode to
design mode setting parameter.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_auto_update_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 GetAutoUpdateModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves informations about the automatic update setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_move_with_fix_t_extend_mode_info(admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetMoveWithFixTExtendModeInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves the state of the setting parameter managing the extension of a
move to the components involved in a FixTogether.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_update_status_mode_info(admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetUpdateStatusModeInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves informations about the update status computation setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Return type:

bool

property move_with_fix_t_extend_mode: int

Note

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

Returns or sets the setting parameter managing the extension of a move to
the components involved in a FixTogether.
Role: This setting parameter manages whether the components involved in a
FixTogether will be moved or not.
Legal values:
catNeverExtendMoveToFixT Never extend move to all component involved in a
FixTogether
catAskIfExtendMoveToFixT Ask question to extend move to all component
involved in a FixTogether
catAlwaysExtendMoveToFixT Always extend move to all component involved in
a FixTogether

Example:
The following example retrieves the move setting parameter of
AsmGeneralSettingAtt1 in MoveMode and sets it to
Always

Set MoveMode = AsmGeneralSettingAtt1.MoveWithFixTExtendMode
AsmGeneralSettingAtt1.MoveWithFixTExtendMode = catAlwaysExtendMoveToFixT
Returns:

enum cat_asm_extend_move_to_fix_t

Return type:

int

set_auto_switch_to_design_mode_lock(i_locked: bool) → None

Note

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

Locks or unlocks the implicit switch from visualization mode to design mode
setting parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_auto_update_mode_lock(i_locked: bool) → None

Note

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

Locks or unlocks the automatic update setting parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_move_with_fix_t_extend_mode_lock(i_locked: bool) → None

Note

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

Locks or unlocks the setting parameter managing the extension of a move to
the components involved in a FixTogether.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

set_update_status_mode_lock(i_locked: bool) → None

Note

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

Locks or unlocks the update status computation setting
parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Return type:

None

property update_status_mode: int

Note

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

Returns or sets the update status computation setting
parameter.
Role: The update status computation setting parameter manages the loading
at open of the data necessary to the exact update status computation. Note that
this option is useful only when the Cache option is
activated
Legal values:
catManualCompute At open the update status is unknown
catAutomaticCompute Additional data are being loaded at open to compute an
exact Update status

Example:
The following example retrieves the update status computation setting
parameter of AsmGeneralSettingAtt1 in StatusMode and sets the mode to automatic
computation.

Set StatusMode = AsmGeneralSettingAtt1.UpdateStatusMode
AsmGeneralSettingAtt1.UpdateStatusMode = catAutomaticCompute
Returns:

enum cat_asm_update_status_compute_mode

Return type:

int