pycatia.mec_mod_interfaces.part_infrastructure_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.mec_mod_interfaces.part_infrastructure_setting_att.PartInfrastructureSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

PartInfrastructureSettingAtt

Setting controller for all the Part Infrastructure property tab

pages.

Role: This interface is implemented by a component representing the controller

for the Part Infrastructure settings.

property also_delete_exclusive_parents: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property AlsoDeleteExclusiveParents() As boolean

Returns or sets the “AlsoDeleteExclusiveParents”

parameter.

Role: This parameter defines if a exclusive parents of an object will also

be deleted when the object is deleted.

This option is effective only when the “Deletion warning box” is

displayed.

Parameters:

oDeleted

Current “AlsoDeleteExclusiveParents” parameter’s

value:

TRUE or 1 if exclusive parents are also

deleted,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property axis_system_size: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property AxisSystemSize() As short

Returns or sets the “AxisSystemSize” parameter.

Role: This parameter determines the size of axis systems.

Parameters:

oSize

Current size of axis systems

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: int

property bodies_under_operations_in_tree: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property BodiesUnderOperationsInTree() As boolean

Returns or sets the “BodiesUnderOperationsInTree”

parameter.

Role: This parameter determines if a Body node is displayed when it is

being aggregated under a boolean operation (Add, Assemble, Remove, Intersect,

Union Trim).

Its value can be changed even after a boolean operation has been created.

Simply collapse and expand the federating boolean operation node for the

specification tree to be refreshed.

Parameters:

oNodeDisplayed

Current “BodiesUnderOperationsInTree” parameter’s

value:

TRUE or 1 if such a node is displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property color_synchronization_editability: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ColorSynchronizationEditability() As boolean

Returns or sets the “ColorSynchronizationEditability”

parameter.

Role: This parameter determines whether color synchronization property on

Part is editable or not.

Color synchronization editability defines whether the property of

synchronization on Part can be interactively editable If it is valuated to 1,

user will be able to interactively modify the Part property of Color management

tab for synchronization. If it is defined to 0, user will not be able to

interactively modify the Part property of Color management tab for

synchronization. This option cannot be changed after a document has been

opened.

Parameters:

oActivated

Current “ColorSynchronizationEditability” parameter’s

value:

TRUE or 1, Part property option for synchronization is

editable

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property color_synchronization_mode: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ColorSynchronizationMode() As boolean

Returns or sets the “ColorSynchronizationMode” parameter.

Role: This parameter determines color synchronization mode for imported

features in a part.

Color synchronization mode defines whether the imported feature, created

through copy/paste as result with link mechanism, copies reference feature

colors on its faces or not. If it is valuated to 1, synchronization will be

effective and referece feature colors will be reported. If it is defined to 0,

nothing will be copied(default mode). This option cannot be changed after a

document has been opened.

Parameters:

oActivated

Current “ColorSynchronizationMode” parameter’s

value:

TRUE or 1 if reference feature colors are reported on imported

feature,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property color_synchronization_mode_manage: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ColorSynchronizationModeManage() As boolean

Returns or sets the “ColorSynchronizationModeManage”

parameter.

Role: This parameter determines access to specific color synchronization

mode for imported features in a part.

Color synchronization mode Manage defines if access is granted to color

synchronization suboptions “on feature” and “on subelements”. If it is valuated

to 1, access will be granted. If it is defined to 0, no acces to color on

feature & color on subelements options

Parameters:

oActivated

Current “ColorSynchronizationModeManage” parameter’s

value:

TRUE or 1 if possibility to chose specific color copy

parameters

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property color_synchronization_mode_on_feature: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ColorSynchronizationModeOnFeature() As boolean

Returns or sets the “ColorSynchronizationModeOnFeature”

parameter.

Role: This parameter determines graphic properties synchronization mode on

feature for imported features in a part.

Color synchronization mode defines whether the imported feature, created

through copy/paste as result with link mechanism, copies reference feature

graphic properties or not. If it is valuated to 1, synchronization will be

effective and referece feature graphic properties will be reported. If it is

defined to 0, nothing will be copied(default mode).

Parameters:

oActivated

Current “ColorSynchronizationModeOnFeature” parameter’s

value:

TRUE or 1 if reference feature graphic properties are reported

on imported feature,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property color_synchronization_mode_on_sub_elements: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ColorSynchronizationModeOnSubElements() As boolean

Returns or sets the “ColorSynchronizationModeOnSubElements”

parameter.

Role: This parameter determines color synchronization mode for imported

features in a part.

Color synchronization mode OnSubElements defines whether the imported

feature, created through copy/paste as result with link mechanism, copies

reference feature colors on his overloaded faces or not. If it is valuated to

1, synchronization will be effective and reference subelements colors will be

reported. If it is defined to 0, nothing will be copied(default

mode).

Parameters:

oActivated

Current “ColorSynchronizationModeOnSubElements” parameter’s

value:

TRUE or 1 if reference subelements colors are reported on

imported feature,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property colors3_d_experience_management: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property Colors3DExperienceManagement() As boolean

Returns or sets the “Colors3DExperienceManagement”

parameter.

Role: This parameter determines whether color synchronization property on

Part is editable or not.

Color synchronization editability defines whether the property of

synchronization on Part can be interactively editable If it is valuated to 1,

user will be able to interactively modify the Part property of Color management

tab for synchronization. If it is defined to 0, user will not be able to

interactively modify the Part property of Color management tab for

synchronization. This option cannot be changed after a document has been

opened.

Parameters:

oActivated

Current “Colors3DExperienceManagement” parameter’s

value:

TRUE or 1, Part property option for synchronization is

editable

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property constraints_in_geometry: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ConstraintsInGeometry() As boolean

Returns or sets the “ConstraintsInGeometry” parameter.

Role: This parameter enables constraints to be visualized in the 3D

view.

Parameters:

oDisplayed

Current “Display constraints within 3D” parameter’s

value:

TRUE or 1 if constraints are displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property constraints_node_in_tree: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ConstraintsNodeInTree() As boolean

Returns or sets the “ConstraintsNodeInTree” parameter.

Role: This parameter determines if a node called “Constraints” is created

to contain all constraints.

Its value can be changed even after constraints have been created. The

result is that the specification tree node display status will be

affected.

Parameters:

oNodeDisplayed

Current “ConstraintsNodeInTree” parameter’s value:

TRUE or 1 if such a node is displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property contextual_features_selectable_at_creation: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ContextualFeaturesSelectableAtCreation() As

boolean

Returns or sets the “ContextualFeaturesSelectableAtCreation”

parameter.

Role: This parameter determines if contextual features can be selected

during the creation of an other feature.

Parameters:

oContextualFeaturesSelectable

Current “ContextualFeaturesSelectableAtCreation” parameter’s

value:

TRUE or 1 if contextual features can be

selected,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property default_colors_editability: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property DefaultColorsEditability() As boolean

Returns or sets the “DefaultColorsEditability” parameter.

Role: This parameter determines whether color synchronization property on

Part is editable or not.

Color synchronization editability defines whether the property of

synchronization on Part can be interactively editable If it is valuated to 1,

user will be able to interactively modify the Part property of Color management

tab for synchronization. If it is defined to 0, user will not be able to

interactively modify the Part property of Color management tab for

synchronization. This option cannot be changed after a document has been

opened.

Parameters:

oActivated

Current “DefaultColorsEditability” parameter’s

value:

TRUE or 1, Part property option for synchronization is

editable

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property delete_warning_box: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property DeleteWarningBox() As boolean

Returns or sets the “DeleteWarningBox” parameter.

Role: This parameter defines if a warning box is displayed when an element

is deleted.

Parameters:

oDisplayed

Current “DeleteWarningBox” parameter’s value:

TRUE or 1 if a warning box is displayed at

deletion,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property display_geometry_after_current: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property DisplayGeometryAfterCurrent() As boolean

Returns or sets the “DisplayGeometryAfterCurrent”

parameter.

Role: This parameter enables to visualize in the 3D features after the

current object in O.G.S. and “solid and surface set”.

Parameters:

oDisplayed

Current “DisplayGeometryAfterCurrent” parameter’s

value:

TRUE or 1 if such is the visualization,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property expand_sketch_based_features_node_at_creation: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ExpandSketchBasedFeaturesNodeAtCreation() As

boolean

Returns or sets the “ExpandSketchBasedFeaturesNodeAtCreation”

parameter.

Role: This parameter determines if specification tree nodes for

sketch-based features are expanded when such elements are created. This will

enable to view their sketch node.

Parameters:

oNodeExpanded

Current “ExpandSketchBasedFeaturesNodeAtCreation” parameter’s

value:

TRUE or 1 if such nodes are expanded,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property external_references_as_visible: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ExternalReferencesAsVisible() As boolean

Returns or sets the “ExternalReferencesAsVisible”

parameter.

Role: This parameter defines if an external reference is visible when being

created.

Parameters:

oVisible

Current “ExternalReferencesAsVisible” parameter’s

value:

TRUE or 1 if external references are visible when being

created,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property external_references_assembly_root_context: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ExternalReferencesAssemblyRootContext() As boolean

Returns or sets the “ExternalReferencesAssemblyRootContext”

parameter.

Role: This parameter defines if external references are created using the

root context of an assembly.

Parameters:

oRootContextUsed

Current “ExternalReferencesAssemblyRootContext” parameter’s

value:

TRUE or 1 if external references are created using the root

context of an assembly,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property external_references_node_in_tree: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ExternalReferencesNodeInTree() As boolean

Returns or sets the “ExternalReferencesNodeInTree”

parameter.

Role: This parameter determines if a node called “External Reference” is

created to contain all linked external references.

Its value can be changed even after linked external references have been

created. The result is that the specification tree node display status will be

affected.

Parameters:

oNodeDisplayed

Current “ExternalReferencesNodeInTree” parameter’s

value:

TRUE or 1 if such a node is displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetAlsoDeleteExclusiveParentsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “AlsoDeleteExclusiveParents”

parameter.

Role:Retrieves the state of the “AlsoDeleteExclusiveParents” 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_axis_system_size_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetAxisSystemSizeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “AxisSystemSize”

parameter.

Role:Retrieves the state of the “AxisSystemSize” 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_bodies_under_operations_in_tree_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetBodiesUnderOperationsInTreeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “BodiesUnderOperationsInTree”

parameter.

Role:Retrieves the state of the “BodiesUnderOperationsInTree” 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_color_synchronization_editability_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetColorSynchronizationEditabilityInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“ColorSynchronizationEditability” parameter.

Role:Retrieves the state of the “ColorSynchronizationEditability” 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_color_synchronization_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetColorSynchronizationModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ColorSynchronizationMode”

parameter.

Role:Retrieves the state of the “ColorSynchronizationMode” 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_color_synchronization_mode_manage_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetColorSynchronizationModeManageInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ColorSynchronizationModeManage”

parameter.

Role:Retrieves the state of the “ColorSynchronizationModeManage” 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_color_synchronization_mode_on_feature_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetColorSynchronizationModeOnFeatureInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“ColorSynchronizationModeOnFeature” parameter.

Role:Retrieves the state of the “ColorSynchronizationModeOnFeature”

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_color_synchronization_mode_on_sub_elements_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetColorSynchronizationModeOnSubElementsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“ColorSynchronizationModeOnSubElements” parameter.

Role:Retrieves the state of the “ColorSynchronizationModeOnSubElements”

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_colors3_d_experience_management_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetColors3DExperienceManagementInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Colors3DExperienceManagement”

parameter.

Role:Retrieves the state of the “Colors3DExperienceManagement” 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_constraints_in_geometry_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetConstraintsInGeometryInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ConstraintsInGeometry”

parameter.

Role:Retrieves the state of the “ConstraintsInGeometry” 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_constraints_node_in_tree_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetConstraintsNodeInTreeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ConstraintsNodeInTree”

parameter.

Role:Retrieves the state of the “ConstraintsNodeInTree” 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_contextual_features_selectable_at_creation_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetContextualFeaturesSelectableAtCreationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“ContextualFeaturesSelectableAtCreation” parameter.

Role:Retrieves the state of the “ContextualFeaturesSelectableAtCreation”

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_default_colors_editability_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetDefaultColorsEditabilityInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “DefaultColorsEditability”

parameter.

Role:Retrieves the state of the “DefaultColorsEditability” 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_delete_warning_box_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetDeleteWarningBoxInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “DeleteWarningBox”

parameter.

Role:Retrieves the state of the “DeleteWarningBox” 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_geometry_after_current_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetDisplayGeometryAfterCurrentInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “DisplayGeometryAfterCurrent”

parameter.

Role:Retrieves the state of the “DisplayGeometryAfterCurrent” 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_expand_sketch_based_features_node_at_creation_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetExpandSketchBasedFeaturesNodeAtCreationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“ExpandSketchBasedFeaturesNodeAtCreation” parameter.

Role:Retrieves the state of the “ExpandSketchBasedFeaturesNodeAtCreation”

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_external_references_as_visible_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetExternalReferencesAsVisibleInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ExternalReferencesAsVisible”

parameter.

Role:Retrieves the state of the “ExternalReferencesAsVisible” 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_external_references_assembly_root_context_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetExternalReferencesAssemblyRootContextInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“ExternalReferencesAssemblyRootContext” parameter.

Role:Retrieves the state of the “ExternalReferencesAssemblyRootContext”

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_external_references_node_in_tree_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetExternalReferencesNodeInTreeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ExternalReferencesNodeInTree”

parameter.

Role:Retrieves the state of the “ExternalReferencesNodeInTree” 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_hybrid_design_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetHybridDesignModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “HybridDesignMode”

parameter.

Role:Retrieves the state of the “HybridDesignMode” 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_knowledge_in_hybrid_design_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetKnowledgeInHybridDesignModeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “KnowledgeInHybridDesignMode”

parameter.

Role:Retrieves the state of the “KnowledgeInHybridDesignMode” 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_linked_external_references_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetLinkedExternalReferencesInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “LinkedExternalReferences”

parameter.

Role:Retrieves the state of the “LinkedExternalReferences” 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_linked_external_references_only_on_publication_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetLinkedExternalReferencesOnlyOnPublicationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“LinkedExternalReferencesOnlyOnPublication” parameter.

Role:Retrieves the state of the “LinkedExternalReferencesOnlyOnPublication”

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_linked_external_references_warning_at_creation_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetLinkedExternalReferencesWarningAtCreationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“LinkedExternalReferencesWarningAtCreation” parameter.

Role:Retrieves the state of the “LinkedExternalReferencesWarningAtCreation”

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_naming_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetNamingModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “NamingMode”

parameter.

Role:Retrieves the state of the “NamingMode” 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_new_with3_d_support_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetNewWith3DSupportInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “NewWith3DSupport”

parameter.

Role:Retrieves the state of the “NewWith3DSupport” 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_new_with_axis_system_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetNewWithAxisSystemInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “NewWithAxisSystem”

parameter.

Role:Retrieves the state of the “NewWithAxisSystem” 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_new_with_gs_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetNewWithGSInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “NewWithGS”

parameter.

Role:Retrieves the state of the “NewWithGS” 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_new_with_ogs_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetNewWithOGSInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “NewWithOGS”

parameter.

Role:Retrieves the state of the “NewWithOGS” 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_new_with_panel_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetNewWithPanelInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “NewWithPanel”

parameter.

Role:Retrieves the state of the “NewWithPanel” 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_only_current_operated_solid_set_in_geometry_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetOnlyCurrentOperatedSolidSetInGeometryInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

“OnlyCurrentOperatedSolidSetInGeometry” parameter.

Role:Retrieves the state of the “OnlyCurrentOperatedSolidSetInGeometry”

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_only_current_solid_set_in_geometry_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetOnlyCurrentSolidSetInGeometryInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “OnlyCurrentSolidSetInGeometry”

parameter.

Role:Retrieves the state of the “OnlyCurrentSolidSetInGeometry” 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_parameters_node_in_tree_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetParametersNodeInTreeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ParametersNodeInTree”

parameter.

Role:Retrieves the state of the “ParametersNodeInTree” 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_publish_topological_elements_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetPublishTopologicalElementsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “PublishTopologicalElements”

parameter.

Role:Retrieves the state of the “PublishTopologicalElements” 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_relations_node_in_tree_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetRelationsNodeInTreeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “RelationsNodeInTree”

parameter.

Role:Retrieves the state of the “RelationsNodeInTree” 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_replace_only_after_current_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetReplaceOnlyAfterCurrentInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ReplaceOnlyAfterCurrent”

parameter.

Role:Retrieves the state of the “ReplaceOnlyAfterCurrent” 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_surface_elements_location_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetSurfaceElementsLocationInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “SurfaceElementsLocation”

parameter.

Role:Retrieves the state of the “SurfaceElementsLocation” 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_true_color_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetTrueColorModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “ColorInheritanceMode”

parameter.

Role:Retrieves the state of the “ColorInheritanceMode” 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_update_elements_refreshed_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetUpdateElementsRefreshedInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “UpdateElementsRefreshed”

parameter.

Role:Retrieves the state of the “UpdateElementsRefreshed” 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_update_linked_external_references_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetUpdateLinkedExternalReferencesInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “UpdateLinkedExternalReferences”

parameter.

Role:Retrieves the state of the “UpdateLinkedExternalReferences” 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_update_mode_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetUpdateModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “UpdateMode”

parameter.

Role:Retrieves the state of the “UpdateMode” 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_update_stopped_on_error_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Func GetUpdateStoppedOnErrorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the “UpdateStoppedOnError”

parameter.

Role:Retrieves the state of the “UpdateStoppedOnError” 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 hybrid_design_mode: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property HybridDesignMode() As boolean

Returns or sets the “HybridDesignMode” parameter.

Role: This parameter determines if hybrid design is possible inside Part

Bodies and bodies.

This option can be changed even after a document has been

opened.

Parameters:

oHybridDesign

Current “HybridDesignMode” parameter’s value:

TRUE or 1 if hybrid design is enabled,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property knowledge_in_hybrid_design_mode: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property KnowledgeInHybridDesignMode() As boolean

Returns or sets the “KnowledgeInHybridDesignMode”

parameter.

Role: This parameter determines if knowledge features (formulas,

parameters, rules, …) can be located inside ordered

sets.

This option can be changed even after a document has been

opened.

Parameters:

oKnowledgeInHybridDesign

Current “KnowledgeInHybridDesignMode” parameter’s

value:

TRUE or 1 if hybrid design is enabled,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property linked_external_references: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property LinkedExternalReferences() As boolean

Returns or sets the “LinkedExternalReferences” parameter.

Role: This parameter enables creation of external references with

links.

Parameters:

oWithLink

“LinkedExternalReferences” parameter’s value:

TRUE or 1 if external references are created with

links,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property linked_external_references_only_on_publication: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property LinkedExternalReferencesOnlyOnPublication() As

boolean

Returns or sets the “LinkedExternalReferencesOnlyOnPublication”

parameter.

Role: This parameter restricts the creation of external references with

links to only published elements.

This option is only used when external references are created with

link.

Parameters:

oOnlyForPublishedElements

Current “LinkedExternalReferencesOnlyOnPublication” parameter’s

value:

TRUE or 1 if external references with link are only allowed on

published elements,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property linked_external_references_warning_at_creation: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property LinkedExternalReferencesWarningAtCreation() As

boolean

Returns or sets the “LinkedExternalReferencesWarningAtCreation”

parameter.

Role: This parameter defines if a warning panel is displayed each time an

external reference with llink is created. The panel enables the user to decide

whether the link will be kept or not.

This option is only used when external references are created with

link.

Parameters:

oWarningAtCreation

Current “LinkedExternalReferencesWarningAtCreation” parameter’s

value:

TRUE or 1 if a panel is displayed upon external references with

link creation,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property naming_mode: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property NamingMode() As CatPartElementsNamingMode

Returns or sets the “NamingMode” parameter.

Role: This parameter determines how an element can be named through

Edit/Properties or any operation creating a feature (Copy-Paste,

etc.).

When this option is being changed, it only affects elements whose name is

modified afterwards.

Parameters:

oNamingMode

Current “NamingMode” parameter’s value:

catNoCheck when naming is rule-free,

catNamingCheckUnderSameNode when 2 elements cannot have the

same name under the same node,

catNamingCheckWithinUIActiveObject when 2 elements cannot have

the same name within a defined UIActiveObject.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Returns:: enum cat_part_elements_naming_mode
Return type:: int

property new_with3_d_support: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property NewWith3DSupport() As boolean

Returns or sets the “NewWith3DSupport” parameter.

Role: This parameter determines if a new .CATPart document will be created

with 3D working support.

Parameters:

o3DSupportCreated

Current “NewWith3DSupport” parameter’s value:

TRUE or 1 if a 3D support is created,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property new_with_axis_system: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property NewWithAxisSystem() As boolean

Returns or sets the “NewWithAxisSystem” parameter.

Role: This parameter determines if a new .CATPart document will be created

with an Axis System.

Parameters:

oAxisSystemCreated

Current “NewWithAxisSystem” parameter’s value:

TRUE or 1 if an axis system is created,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property new_with_gs: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property NewWithGS() As boolean

Returns or sets the “NewWithGS” parameter.

Role: This parameter determines if a new .CATPart document will be created

with a Geometrical Set.

Parameters:

oGSCreated

Current “NewWithGS” parameter’s value:

TRUE or 1 if a G.S. is created,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property new_with_ogs: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property NewWithOGS() As boolean

Returns or sets the “NewWithOGS” parameter.

Role: This parameter determines if a new .CATPart document will be created

with an Ordered Geometrical Set.

Parameters:

oOGSCreated

Current “NewWithOGS” parameter’s value:

TRUE or 1 if an O.G.S. is created,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property new_with_panel: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property NewWithPanel() As boolean

Returns or sets the “NewWithPanel” parameter.

Role: This parameter determines if a dedicated ‘New Part’ panel is

displayed when createing a new .CATPart document.

Parameters:

oNewPartPanelDisplayed

Current “NewWithPanel” parameter’s value:

TRUE or 1 if the ‘New Part’ panel is

displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property only_current_operated_solid_set_in_geometry: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property OnlyCurrentOperatedSolidSetInGeometry() As boolean

Returns or sets the “OnlyCurrentOperatedSolidSetInGeometry”

parameter.

Role: This parameter enables to visualize in the 3D only the current

operated body’s feature (operated means being aggregated in a boolean

operation), as well as all other bodies and sets direcly inserted under the

Part feature.

Parameters:

oDisplayed

Current “Display in 3D only current operated solid set” parameter’s

value:

TRUE or 1 if such is the visualization,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property only_current_solid_set_in_geometry: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property OnlyCurrentSolidSetInGeometry() As boolean

Returns or sets the “OnlyCurrentSolidSetInGeometry”

parameter.

Role: This parameter enables to visualize in the 3D only the current

operated body’s feature (operated means being aggregated in a boolean

operation), as well as all other bodies and sets direcly inserted under the

Part feature.

Parameters:

oDisplayed

Current “Display in 3D only current operated solid set” parameter’s

value:

TRUE or 1 if such is the visualization,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property parameters_node_in_tree: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ParametersNodeInTree() As boolean

Returns or sets the “ParametersNodeInTree” parameter.

Role: This parameter determines if a node called “Parameters” is created to

contain all Knowledgeware parameters.

Its value can be changed even after parameters have been created. The

result is that the specification tree node display status will be

affected.

Parameters:

oNodeDisplayed

Current “ParametersNodeInTree” parameter’s value:

TRUE or 1 if such a node is displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property publish_topological_elements: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property PublishTopologicalElements() As boolean

Returns or sets the “PublishTopologicalElements”

parameter.

Role: This parameter defines if topological elements (faces, edges,

vertices, axes extremities) can be published.

Parameters:

oTopologyAllowed

Current “PublishTopologicalElements” parameter’s

value:

TRUE or 1 if topological elements can be used for

publication,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property relations_node_in_tree: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property RelationsNodeInTree() As boolean

Returns or sets the “RelationsNodeInTree” parameter.

Role: This parameter determines if a node called “Relations” is created to

contain all Knowledgeware relations (for instance

formulas).

Its value can be changed even after parameters have been created. The

result is that the specification tree node display status will be

affected.

Parameters:

oNodeDisplayed

Current “RelationsNodeInTree” parameter’s value:

TRUE or 1 if such a node is displayed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property replace_only_after_current: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property ReplaceOnlyAfterCurrent() As boolean

Returns or sets the “ReplaceOnlyAfterCurrent” parameter.

Role: This parameter defines if the replace operation can only apply to

components located after the current object.

Parameters:

oOnlyAfterCurrent

Current “ReplaceOnlyAfterCurrent” parameter’s

value:

TRUE or 1 if the replace operation can only apply to components

located after the current object,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

set_also_delete_exclusive_parents_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetAlsoDeleteExclusiveParentsLock(boolean iLocked)

Locks or unlocks the “AlsoDeleteExclusiveParents”

parameter.

Role:Locks or unlocks the “AlsoDeleteExclusiveParents” 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_axis_system_size_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetAxisSystemSizeLock(boolean iLocked)

Locks or unlocks the “AxisSystemSize” parameter.

Role:Locks or unlocks the “AxisSystemSize” 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_bodies_under_operations_in_tree_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetBodiesUnderOperationsInTreeLock(boolean iLocked)

Locks or unlocks the “BodiesUnderOperationsInTree”

parameter.

Role:Locks or unlocks the “BodiesUnderOperationsInTree” 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_color_synchronization_editability_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetColorSynchronizationEditabilityLock(boolean

iLocked)

Locks or unlocks the “ColorSynchronizationEditability”

parameter.

Role:Locks or unlocks the “ColorSynchronizationEditability” 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_color_synchronization_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetColorSynchronizationModeLock(boolean iLocked)

Locks or unlocks the “ColorSynchronizationMode” parameter.

Role:Locks or unlocks the “ColorSynchronizationMode” 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_color_synchronization_mode_manage_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetColorSynchronizationModeManageLock(boolean iLocked)

Locks or unlocks the “ColorSynchronizationModeManage”

parameter.

Role:Locks or unlocks the “ColorSynchronizationModeManage” 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_color_synchronization_mode_on_feature_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetColorSynchronizationModeOnFeatureLock(boolean

iLocked)

Locks or unlocks the “ColorSynchronizationModeOnFeature”

parameter.

Role:Locks or unlocks the “ColorSynchronizationModeOnFeature” 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_color_synchronization_mode_on_sub_elements_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetColorSynchronizationModeOnSubElementsLock(boolean

iLocked)

Locks or unlocks the “ColorSynchronizationModeOnSubElements”

parameter.

Role:Locks or unlocks the “ColorSynchronizationModeOnSubElements” 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_colors3_d_experience_management_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetColors3DExperienceManagementLock(boolean iLocked)

Locks or unlocks the “Colors3DExperienceManagement”

parameter.

Role:Locks or unlocks the “Colors3DExperienceManagement” 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_constraints_in_geometry_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetConstraintsInGeometryLock(boolean iLocked)

Locks or unlocks the “ConstraintsInGeometry” parameter.

Role:Locks or unlocks the “ConstraintsInGeometry” 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_constraints_node_in_tree_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetConstraintsNodeInTreeLock(boolean iLocked)

Locks or unlocks the “ConstraintsNodeInTree” parameter.

Role:Locks or unlocks the “ConstraintsNodeInTree” 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_contextual_features_selectable_at_creation_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetContextualFeaturesSelectableAtCreationLock(boolean

iLocked)

Locks or unlocks the “ContextualFeaturesSelectableAtCreation”

parameter.

Role:Locks or unlocks the “ContextualFeaturesSelectableAtCreation”

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_default_colors_editability_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetDefaultColorsEditabilityLock(boolean iLocked)

Locks or unlocks the “DefaultColorsEditability” parameter.

Role:Locks or unlocks the “DefaultColorsEditability” 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_delete_warning_box_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetDeleteWarningBoxLock(boolean iLocked)

Locks or unlocks the “DeleteWarningBox” parameter.

Role:Locks or unlocks the “DeleteWarningBox” 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_geometry_after_current_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetDisplayGeometryAfterCurrentLock(boolean iLocked)

Locks or unlocks the “DisplayGeometryAfterCurrent”

parameter.

Role:Locks or unlocks the “DisplayGeometryAfterCurrent” 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_expand_sketch_based_features_node_at_creation_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetExpandSketchBasedFeaturesNodeAtCreationLock(boolean

iLocked)

Locks or unlocks the “ExpandSketchBasedFeaturesNodeAtCreation”

parameter.

Role:Locks or unlocks the “ExpandSketchBasedFeaturesNodeAtCreation”

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_external_references_as_visible_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetExternalReferencesAsVisibleLock(boolean iLocked)

Locks or unlocks the “ExternalReferencesAsVisible”

parameter.

Role:Locks or unlocks the “ExternalReferencesAsVisible” 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_external_references_assembly_root_context_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetExternalReferencesAssemblyRootContextLock(boolean

iLocked)

Locks or unlocks the “ExternalReferencesAssemblyRootContext”

parameter.

Role:Locks or unlocks the “ExternalReferencesAssemblyRootContext” 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_external_references_node_in_tree_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetExternalReferencesNodeInTreeLock(boolean iLocked)

Locks or unlocks the “ExternalReferencesNodeInTree”

parameter.

Role:Locks or unlocks the “ExternalReferencesNodeInTree” 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_hybrid_design_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetHybridDesignModeLock(boolean iLocked)

Locks or unlocks the “HybridDesignMode” parameter.

Role:Locks or unlocks the “HybridDesignMode” 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_knowledge_in_hybrid_design_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetKnowledgeInHybridDesignModeLock(boolean iLocked)

Locks or unlocks the “KnowledgeInHybridDesignMode”

parameter.

Role:Locks or unlocks the “KnowledgeInHybridDesignMode” 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_linked_external_references_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetLinkedExternalReferencesLock(boolean iLocked)

Locks or unlocks the “LinkedExternalReferences” parameter.

Role:Locks or unlocks the “LinkedExternalReferences” 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_linked_external_references_only_on_publication_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetLinkedExternalReferencesOnlyOnPublicationLock(boolean

iLocked)

Locks or unlocks the “LinkedExternalReferencesOnlyOnPublication”

parameter.

Role:Locks or unlocks the “LinkedExternalReferencesOnlyOnPublication”

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_linked_external_references_warning_at_creation_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetLinkedExternalReferencesWarningAtCreationLock(boolean

iLocked)

Locks or unlocks the “LinkedExternalReferencesWarningAtCreation”

parameter.

Role:Locks or unlocks the “LinkedExternalReferencesWarningAtCreation”

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_naming_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetNamingModeLock(boolean iLocked)

Locks or unlocks the “NamingMode” parameter.

Role:Locks or unlocks the “NamingMode” 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_new_with3_d_support_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetNewWith3DSupportLock(boolean iLocked)

Locks or unlocks the “NewWith3DSupport” parameter.

Role:Locks or unlocks the “NewWith3DSupport” 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_new_with_axis_system_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetNewWithAxisSystemLock(boolean iLocked)

Locks or unlocks the “NewWithAxisSystem” parameter.

Role:Locks or unlocks the “NewWithAxisSystem” 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_new_with_gs_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetNewWithGSLock(boolean iLocked)

Locks or unlocks the “NewWithGS” parameter.

Role:Locks or unlocks the “NewWithGS” 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_new_with_ogs_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetNewWithOGSLock(boolean iLocked)

Locks or unlocks the “NewWithOGS” parameter.

Role:Locks or unlocks the “NewWithOGS” 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_new_with_panel_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetNewWithPanelLock(boolean iLocked)

Locks or unlocks the “NewWithPanel” parameter.

Role:Locks or unlocks the “NewWithPanel” 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_only_current_operated_solid_set_in_geometry_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetOnlyCurrentOperatedSolidSetInGeometryLock(boolean

iLocked)

Locks or unlocks the “OnlyCurrentOperatedSolidSetInGeometry”

parameter.

Role:Locks or unlocks the “OnlyCurrentOperatedSolidSetInGeometry” 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_only_current_solid_set_in_geometry_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetOnlyCurrentSolidSetInGeometryLock(boolean iLocked)

Locks or unlocks the “OnlyCurrentSolidSetInGeometry”

parameter.

Role:Locks or unlocks the “OnlyCurrentSolidSetInGeometry” 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_parameters_node_in_tree_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetParametersNodeInTreeLock(boolean iLocked)

Locks or unlocks the “ParametersNodeInTree” parameter.

Role:Locks or unlocks the “ParametersNodeInTree” 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_publish_topological_elements_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetPublishTopologicalElementsLock(boolean iLocked)

Locks or unlocks the “PublishTopologicalElements”

parameter.

Role:Locks or unlocks the “PublishTopologicalElements” 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_relations_node_in_tree_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetRelationsNodeInTreeLock(boolean iLocked)

Locks or unlocks the “RelationsNodeInTree” parameter.

Role:Locks or unlocks the “RelationsNodeInTree” 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_replace_only_after_current_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetReplaceOnlyAfterCurrentLock(boolean iLocked)

Locks or unlocks the “ReplaceOnlyAfterCurrent” parameter.

Role:Locks or unlocks the “ReplaceOnlyAfterCurrent” 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_surface_elements_location_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetSurfaceElementsLocationLock(boolean iLocked)

Locks or unlocks the “SurfaceElementsLocation” parameter.

Role:Locks or unlocks the “SurfaceElementsLocation” 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_update_elements_refreshed_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetUpdateElementsRefreshedLock(boolean iLocked)

Locks or unlocks the “UpdateElementsRefreshed” parameter.

Role:Locks or unlocks the “UpdateElementsRefreshed” 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_update_linked_external_references_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetUpdateLinkedExternalReferencesLock(boolean iLocked)

Locks or unlocks the “UpdateLinkedExternalReferences”

parameter.

Role:Locks or unlocks the “UpdateLinkedExternalReferences” 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_update_mode_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetUpdateModeLock(boolean iLocked)

Locks or unlocks the “UpdateMode” parameter.

Role:Locks or unlocks the “UpdateMode” 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_update_stopped_on_error_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)): o Sub SetUpdateStoppedOnErrorLock(boolean iLocked)

Locks or unlocks the “UpdateStoppedOnError” parameter.

Role:Locks or unlocks the “UpdateStoppedOnError” 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

property surface_elements_location: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property SurfaceElementsLocation() As

CatPartSurfaceElementsLocation

Returns or sets the “SurfaceElementsLocation” parameter.

Role: This parameter determines where wireframe and surface elements are

created when hybrid design is active.

This option can be changed when hybrid design mode is not active (but

useless then), and also even after a document has been

opened.

Parameters:

oLocation

Current “SurfaceElementsLocation” parameter’s

value:

catPartBodyLocation when elements are created within a

PartBody,

catXGSLocation when elements are created within a G.S. or an

O.G.S..

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Returns:: enum cat_part_surface_elements_location
Return type:: int

property true_color_mode: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property TrueColorMode() As boolean

Returns or sets the “ColorInheritanceMode” parameter.

Role: This parameter determines color inheritance mode for absorbing

features in a part.

Color inheritance mode defines which mode of propagation will be used to

set color on an absorbing feature. If it is valuated to 1, absorbing feature

will inherit colors from all their input. If it is defined to 0, absorbing

features will inherit colors from their main input only (default mode). This

option can be changed even after a document has been

opened.

Parameters:

oActivated

Current “ColorInheritanceMode” parameter’s value:

TRUE or 1 if absorbing features inherit from all their

inputs,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property update_elements_refreshed: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property UpdateElementsRefreshed() As boolean

Returns or sets the “UpdateElementsRefreshed” parameter.

Role: This parameter determines if elements visualization has to be

refreshed individually during update tasks.

Parameters:

oElementsRefreshed

Current “UpdateElementsRefreshed” parameter’s

value:

TRUE or 1 if elements visualization is

refreshed,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property update_linked_external_references: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property UpdateLinkedExternalReferences() As boolean

Returns or sets the “UpdateLinkedExternalReferences”

parameter.

Role: This parameter determines if update tasks also apply to linked

external references.

Parameters:

oExternalReferencesUpdated

Current “UpdateLinkedExternalReferences” parameter’s

value:

TRUE or 1 if the update tasks apply to linked external

references,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

property update_mode: int¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property UpdateMode() As CatPartUpdateMode

Returns or sets the “UpdateMode” parameter.

Role: This parameter determines how the update of a .CATPart document is

conducted.

Parameters:

oUpdateMode

Current update mode:

catAutomaticUpdate when update is automatically

launched,

catManualUpdate when update has to be launched

manually.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Returns:: enum cat_part_update_mode
Return type:: int

property update_stopped_on_error: bool¶

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384): o Property UpdateStoppedOnError() As boolean

Returns or sets the “UpdateStoppedOnError” parameter.

Role: This parameter determines if update tasks stop on the first detected

error.

Parameters:

oStoppedOnError

Current “UpdateStoppedOnError” parameter’s value:

TRUE or 1 if update tasks stop,

FALSE or 0 otherwise.

Returns:

S_OK if the parameter is correctly retrieved, E_FAIL otherwise.

Return type:: bool

pycatia.mec_mod_interfaces.part_infrastructure_setting_att¶

Navigation

Related Topics