pycatia.catia_v4_interfaces.migr_batch_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.migr_batch_setting_att.MigrBatchSettingAtt(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

MigrBatchSettingAtt

Represents the object to handle the setting parameters of the “Migration Batch”

tab page.

Role: This interface is implemented by a component named

CATV4IMigrBatchSettingCtrl which represents the controller of the Setting. The

setting parameters of the tab are the following:

“Format”

“V4 Part Definition”

“Conversion Mode”

“Display Report Attribute”

“Initial Drawing Path “

“Projection of Space for transparent views”

“Mapping Files Location for Saving “

“Specified Directory “

“Mapping Files Location for Retrieving “

“Interface Name”

To access this property page:

Click the Options command in the Tools menu

Click + left of General to unfold the workbench list

Click Compatibility

Click on the Migration Batch

tabpage

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 affiche_attribut: str

Note

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

o Property Affiche_Attribut() As CATBSTR

Retrieves or sets the state of the “Display Report Attribute” setting

parameter.

Role: This functionality allows the visualization of 3D elements attributes

in the Migration Report. For each element, the list of its attributes is

displayed with their names and values.

Return type:

str

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

Note

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

o Func GetAffiche_AttributInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Display Report Attribute” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetMapping_File_Save_ModeInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Mapping Files Location for Saving” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetMapping_Saving_FileInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Specified Directory” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetMigration_FormatInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Format” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetMigration_InterfaceInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Migration Interface” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetMigration_TypeInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Conversion” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_search_mapping_list() → tuple

Note

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

o Func GetSearch_Mapping_List() As CATSafeArrayVariant

Retrieves the state of the “Mapping Files Location for Retrieving” setting

parameter.

Role: The “Mapping Files Location for Retrieving “ mode enables you to

store a list of mapping tables.

Return type:

tuple

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

Note

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

o Func GetStartUp_Model_For_DrawingInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Initial Drawing Path” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetV4_Part_DefinitionInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “V4 Part Definition” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

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

Note

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

o Func GetVisu_Mode_2DInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the “Projection of Space for transparent views”

setting parameter.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

property mapping_file_save_mode: str

Note

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

o Property Mapping_File_Save_Mode() As CATBSTR

Retrieves or sets the state of the “Mapping Files Location for Saving”

setting parameter.

Role: The “Mapping Files Location for Saving “ mode enables you to store a

file which indicates the pointed entities in V4 MML Solids and which allows to

retrieve associativity in CATIA V5. You can specify the directory path of your

choice: Batch Target Directory, Model Directory or Specified Directory.

Return type:

str

property mapping_saving_file: str

Note

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

o Property Mapping_Saving_File() As CATBSTR

Retrieves or sets the state of the “Specified Directory” setting

parameter.

Role: The “Specified Directory” mode enables you to find pointed entities

in V4 MML Solids and to retrieve associativity in CATIA V5. You can specify the

directory path of your choice.

Return type:

str

property migration_format: str

Note

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

o Property Migration_Format() As CATBSTR

Retrieves or sets the state of the “Format” setting

parameter.

Role: The “Format” mode enables you to select the format of the Migration

in Batch Mode: AS SPEC or AS RESULT.

Return type:

str

property migration_interface: str

Note

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

o Property Migration_Interface() As CATBSTR

Retrieves or sets the “Migration Interace” setting

parameter.

Role: This option allows you to customize migrations from CATIA V4 to CATIA

V5. You can choose how your applicative data will be migrated by writing source

code

Return type:

str

property migration_type: str

Note

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

o Property Migration_Type() As CATBSTR

Retrieves or sets the state of the “Conversion Mode” setting

parameter.

Role: The “Conversion Mode” mode enables you to separate the treatment of

SPACE data and DRAW data when a model is migrated.

Return type:

str

put_search_mapping_list(i_rel_path: tuple) → None

Note

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

o Sub PutSearch_Mapping_List(CATSafeArrayVariant iRelPath)

Sets the state of the “Mapping Files Location for Retrieving” setting

parameter.

Role: The “Mapping Files Location for Retrieving “ mode enables you to

store a list of mapping tables.

Parameters:

i_rel_path (tuple) –

Return type:

None

property search_list_size: int

Note

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

o Property Search_List_Size() As long

Retrieves or sets the size of the “Mapping Files Location for Retrieving”

list.

Role: This setting enables to retrieve the size of the “Mapping Files

Location for Retrieving” list.

Return type:

int

set_affiche_attribut_lock(i_lock: bool) → None

Note

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

o Sub SetAffiche_AttributLock(boolean iLock)

Locks or unlocks the “Display Report Attribute” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_mapping_file_save_mode_lock(i_lock: bool) → None

Note

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

o Sub SetMapping_File_Save_ModeLock(boolean iLock)

Locks or unlocks the “Mapping Files Location for Saving” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_mapping_saving_file_lock(i_lock: bool) → None

Note

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

o Sub SetMapping_Saving_FileLock(boolean iLock)

Locks or unlocks the “Specified Directory” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_migration_format_lock(i_lock: bool) → None

Note

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

o Sub SetMigration_FormatLock(boolean iLock)

Locks or unlocks the “Format” setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_migration_interface_lock(i_lock: bool) → None

Note

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

o Sub SetMigration_InterfaceLock(boolean iLock)

Locks or unlocks the “Migration Interface” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_migration_type_lock(i_lock: bool) → None

Note

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

o Sub SetMigration_TypeLock(boolean iLock)

Locks or unlocks the “Conversion” setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_start_up_model_for_drawing_lock(i_lock: bool) → None

Note

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

o Sub SetStartUp_Model_For_DrawingLock(boolean iLock)

Locks or unlocks the “Initial Drawing Path” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_v4_part_definition_lock(i_lock: bool) → None

Note

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

o Sub SetV4_Part_DefinitionLock(boolean iLock)

Locks or unlocks the “V4 Part Definition” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

set_visu_mode_2d_lock(i_lock: bool) → None

Note

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

o Sub SetVisu_Mode_2DLock(boolean iLock)

Locks or unlocks the “Projection of Space for transparent views” setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

i_lock (bool) –

Return type:

None

property start_up_model_for_drawing: str

Note

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

o Property StartUp_Model_For_Drawing() As CATBSTR

Retrieves or sets the state of the “Initial Drawing Path” setting

parameter.

Role: The “Initial Drawing Path” mode enables you to specify a .CATDrawing

document which will serve as a template. The standard used by this document

will be used during the migration.

Return type:

str

property v4_part_definition: str

Note

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

o Property V4_Part_Definition() As CATBSTR

Retrieves or sets the state of the “V4 Part Definition” setting

parameter.

Role: The “V4 Part Definition” mode enables you to define the CATParts

obtained after the migration: A CATPart by Geometric Set or A CATPart by Solid.

.

Return type:

str

property visu_mode_2d: str

Note

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

o Property Visu_Mode_2D() As CATBSTR

Retrieves or sets the state of the “Projection of Space for transparent

views” setting parameter.

Role: The “Projection of Space for transparent views” mode enables you to

specify what kind of projection mode you want to use for transparent views

during the migration: NHR, HLR or the same projection mode as the V4 model.

Return type:

str