pycatia.catia_v4_interfaces.interop_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.catia_v4_interfaces.interop_setting_att.InteropSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

InteropSettingAtt

Represents the object to handle the setting parameters of the “V4 Data Reading”

tab page.

Role: This interface is implemented by a component named

CATV4IInteropSettingCtrl which represents the controller of the Setting. The

setting parameters of the tab are the following:

“Display only elements with Sensitive Attribute”

“Display 3D elements labels”

“Open in Light Mode: 2D Data are not taken into account”

“Reading Code page”

“PROJECT File Path”

“DLNAME”

“Prj Warn”

“Characters Equivalence Table Path”

To access this property page:

Click the Options command in the Tools menu

Click + left of General to unfold the workbench list

Click Compatibility

This interface defines:

A method to get each parameter

A method to set the value of each parameter

A method to lock/unlock each parameter

A method to retrieve the informations concerning each

parameter

property code_page: str¶

Note

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

Retrieves or sets the value of the “Reading Code page” setting

parameter.

Role: The “Reading Code page” declares the language to identify the data

read if this data is not labeled. It is stored in the CATIA data to be written

when saving Version 5 CATPart documents as CATIA Version 4 models.

Return type:: str

property conversion_table: str¶

Note

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

Retrieves the location of the “Characters Equivalence Table Path” setting

parameter.

Role: The “Characters Equivalence Table” allows to convert characters

contained in CATIA V4 documents. It is mainly used to generate V5 compliant

names from V4 names by replacing special characters (”, *, /, etc…) by

standard characters.

Return type:: str

property display_mode: bool¶

Note

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

Retrieves or sets the state of the “Display only elements with Sensitive

Attribute” setting parameter.

Role: The “Display only elements with Sensitive Attribute” mode enables you

to decide whether to display or not the elements which were sensitive to the

shading mode in CATIA Version 4.

Return type:: bool

property display_v4_text_3d: bool¶

Note

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

Retrieves or sets the state of the “Display 3D elements labels” setting

parameter.

Role: The “Display 3D elements labels” mode is activated in order to enable

the reading of the 3D text associated to the V4 elements.

Return type:: bool

property dlname: str¶

Note

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

Retrieves or sets the “DLNAME” setting parameter.

Role: Retrieves the DLNAME referenced by the Model.

Return type:: str

property draw: str¶

Note

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

Retrieves or sets the state of the “Open in Light Mode: 2D Data are not

taken into account” setting parameter.

Role: This mode is activated in order to disable the reading of DRAW data

in a V4 Model.

Return type:: str

get_code_page_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “Reading Code page” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

get_conversion_table_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “Characters Equivalence Table Path” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

get_display_mode_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “Display only elements with Sensitive

Attribute” setting parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

get_display_v4_text_3d_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “Display 3D elements labels” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

get_dlname_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “DlNAME” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

get_draw_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “Open in Light Mode: 2D Data are not taken

into account” setting parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

get_project_file_path_info(admin_level: str, o_locked: str) → bool¶

Note

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

CATBSTR oLocked) As boolean

Retrieves information about the “PROJECT File Path” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Return type:

bool

property project_file_path: str¶

Note

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

Retrieves or sets the value of the “PROJECT File Path” setting

parameter.

Role: The “PROJECT File Path” field contains the location of the external

project file referenced by the V4 model.

Return type:: str

set_code_page_lock(i_lock: bool) → None¶

Note

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

Locks or unlocks the “Reading Code page” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

set_conversion_table_lock(i_lock: bool) → None¶

Note

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

Locks or unlocks the “Characters Equivalence Table Path” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

set_display_mode_lock(i_lock: bool) → None¶

Note

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

Retrieves information about the “Display only elements with Sensitive

Attribute” setting parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

set_display_v4_text_3d_lock(i_lock: bool) → None¶

Note

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

Locks or unlocks the “Display 3D elements labels” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

set_dlname_lock(i_lock: bool) → None¶

Note

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

Locks or unlocks the “DLNAME” setting parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

set_draw_lock(i_lock: bool) → None¶

Note

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

Locks or unlocks the “Open in Light Mode: 2D Data are not taken into

account” setting parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

set_project_file_path_lock(i_lock: bool) → None¶

Note

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

Locks or unlocks the “PROJECT File Path” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:: i_lock (bool) –
Return type:: None

pycatia.catia_v4_interfaces.interop_setting_att¶

Navigation

Related Topics