All Frameworks Class Hierarchy This Framework Indexes
CATIAV4Interfaces Interface CATIV4IMigrBatchSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIV4IMigrBatchSettingAtt
Interface 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
Method Index
- o
GetAffiche_AttributInfo(CATSettingInfo*)
- Retrieves information about the "Display Report Attribute" setting parameter.
- o
GetAffiche_Attribut(CATString&)
- Retrieves the state of the "Display Report Attribute" setting parameter.
- o
GetMapping_File_Save_ModeInfo(CATSettingInfo*)
- Retrieves information about the "Mapping Files Location for Saving" setting parameter.
- o
GetMapping_File_Save_Mode(CATString&)
- Retrieves the state of the "Mapping Files Location for Saving" setting
parameter.
- o
GetMapping_Saving_FileInfo(CATSettingInfo*)
- Retrieves information about the "Specified Directory" setting parameter.
- o
GetMapping_Saving_File(CATUnicodeString&)
- Retrieves the state of the "Specified Directory" setting parameter.
- o
GetMigration_FormatInfo(CATSettingInfo*)
- Retrieves information about the "Format" setting parameter.
- o
GetMigration_Format(CATString&)
- Retrieves the state of the "Format" setting parameter.
- o
GetMigration_InterfaceInfo(CATSettingInfo*)
- Retrieves information about the "Migration Interface" setting parameter.
- o
GetMigration_Interface(CATUnicodeString&)
- Retrieves the "Migration Interace" setting parameter.
- o
GetMigration_TypeInfo(CATSettingInfo*)
- Retrieves information about the "Conversion" setting parameter.
- o
GetMigration_Type(CATString&)
- Retrieves the state of the "Conversion Mode" setting parameter.
- o
GetSearch_List_Size(int&)
- Retrieves the size of the "Mapping Files Location for Retrieving" list.
- o
GetSearch_Mapping_List(CATUnicodeString**&)
- Retrieves the state of the "Mapping Files Location for Retrieving" setting
parameter.
- o
GetStartUp_Model_For_DrawingInfo(CATSettingInfo*)
- Retrieves information about the "Initial Drawing Path" setting parameter.
- o
GetStartUp_Model_For_Drawing(CATUnicodeString&)
- Retrieves the state of the "Initial Drawing Path" setting parameter.
- o
GetV4_Part_DefinitionInfo(CATSettingInfo*)
- Retrieves information about the "V4 Part Definition" setting parameter.
- o
GetV4_Part_Definition(CATString&)
- Retrieves the state of the "V4 Part Definition" setting parameter.
- o
GetVisu_Mode_2DInfo(CATSettingInfo*)
- Retrieves information about the "Projection of Space for transparent views"
setting parameter.
- o
GetVisu_Mode_2D(CATString&)
- Retrieves the state of the "Projection of Space for transparent views"
setting parameter.
- o
SetAffiche_AttributLock(unsigned char)
- Locks or unlocks the "Display Report Attribute" setting parameter.
- o
SetAffiche_Attribut(CATString&)
- Sets the state of the "Display Report Attribute" setting parameter.
- o
SetMapping_File_Save_ModeLock(unsigned char)
- Locks or unlocks the "Mapping Files Location for Saving" setting parameter.
- o
SetMapping_File_Save_Mode(CATString&)
- Sets the state of the "Mapping Files Location for Saving" setting parameter.
- o
SetMapping_Saving_FileLock(unsigned char)
- Locks or unlocks the "Specified Directory" setting parameter.
- o
SetMapping_Saving_File(CATUnicodeString&)
- Sets the state of the "Specified Directory" setting parameter.
- o
SetMigration_FormatLock(unsigned char)
- Locks or unlocks the "Format" setting parameter.
- o
SetMigration_Format(CATString&)
- Sets the state of the "Format" setting parameter.
- o
SetMigration_InterfaceLock(unsigned char)
- Locks or unlocks the "Migration Interface" setting parameter.
- o
SetMigration_Interface(CATUnicodeString&)
- Sets the state of the "Migration Interace" setting parameter.
- o
SetMigration_TypeLock(unsigned char)
- Locks or unlocks the "Conversion" setting parameter.
- o
SetMigration_Type(CATString&)
- Sets the state of the "Conversion Mode" setting parameter.
- o
SetSearch_List_Size(int)
- Sets the size of the "Mapping Files Location for Retrieving" list.
- o
SetSearch_Mapping_List(CATUnicodeString**)
- Sets the state of the "Mapping Files Location for Retrieving" setting
parameter.
- o
SetStartUp_Model_For_DrawingLock(unsigned char)
- Locks or unlocks the "Initial Drawing Path" setting parameter.
- o
SetStartUp_Model_For_Drawing(CATUnicodeString&)
- Sets the state of the "Initial Drawing Path" setting parameter.
- o
SetV4_Part_DefinitionLock(unsigned char)
- Locks or unlocks the "V4 Part Definition" setting parameter.
- o
SetV4_Part_Definition(CATString&)
- Sets the state of the "V4 Part Definition" setting parameter.
- o
SetVisu_Mode_2DLock(unsigned char)
- Locks or unlocks the "Projection of Space for transparent views" setting parameter.
- o
SetVisu_Mode_2D(CATString&)
- Sets the state of the "Projection of Space for transparent views"
setting parameter.
Methods
o GetAffiche_AttributInfo
| public virtual GetAffiche_AttributInfo( | | oInfo) |
-
Retrieves information about the "Display Report Attribute" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetAffiche_Attribut
| public virtual GetAffiche_Attribut( | | oAfficheAttr) |
-
Retrieves 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.
- Parameters:
-
- oAfficheAttr
- The state of the option.
Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMapping_File_Save_ModeInfo
| public virtual GetMapping_File_Save_ModeInfo( | | oInfo) |
-
Retrieves information about the "Mapping Files Location for Saving" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMapping_File_Save_Mode
| public virtual GetMapping_File_Save_Mode( | | oMapFileMode) |
-
Retrieves 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.
- Parameters:
-
- oMapFileMode
- The directory.
Legal values:
0: "SaveInDir"
1: "SaveWithMdl"
2: "SaveInFile"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMapping_Saving_FileInfo
| public virtual GetMapping_Saving_FileInfo( | | oInfo) |
-
Retrieves information about the "Specified Directory" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMapping_Saving_File
| public virtual GetMapping_Saving_File( | | oMapSavingFile) |
-
Retrieves 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.
- Parameters:
-
- oMapFileMode
- The path of the specified directory.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMigration_FormatInfo
| public virtual GetMigration_FormatInfo( | | oInfo) |
-
Retrieves information about the "Format" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMigration_Format
| public virtual GetMigration_Format( | | oMigrFormat) |
-
Retrieves 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.
- Parameters:
-
- oMigrFormat
- The migration format.
Legal values:
0: "Spec"
1: "Result"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMigration_InterfaceInfo
| public virtual GetMigration_InterfaceInfo( | | oInfo) |
-
Retrieves information about the "Migration Interface" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMigration_Interface
| public virtual GetMigration_Interface( | | oMigrItf) |
-
Retrieves 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
- Parameters:
-
- oMigrItf
- The name of the interface.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMigration_TypeInfo
| public virtual GetMigration_TypeInfo( | | oInfo) |
-
Retrieves information about the "Conversion" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetMigration_Type
| public virtual GetMigration_Type( | | oMigrType) |
-
Retrieves 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.
- Parameters:
-
- oMigrType
- The conversion mode.
Legal values:
0: "SpaceDraw"
1: "Space"
2: "Draw"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSearch_List_Size
| public virtual GetSearch_List_Size( | | oListSize) |
-
Retrieves 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.
- Parameters:
-
- oListSize
- The list size.
o GetSearch_Mapping_List
| public virtual GetSearch_Mapping_List( | | oMapList) |
-
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.
- Parameters:
-
- oMapList
- The Mapping files path.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetStartUp_Model_For_DrawingInfo
| public virtual GetStartUp_Model_For_DrawingInfo( | | oInfo) |
-
Retrieves information about the "Initial Drawing Path" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetStartUp_Model_For_Drawing
| public virtual GetStartUp_Model_For_Drawing( | | oInitialModel) |
-
Retrieves 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.
- Parameters:
-
- oInitialModel
- The path of the document used as a template.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetV4_Part_DefinitionInfo
| public virtual GetV4_Part_DefinitionInfo( | | oInfo) |
-
Retrieves information about the "V4 Part Definition" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetV4_Part_Definition
| public virtual GetV4_Part_Definition( | | oV4PartDef) |
-
Retrieves 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.
.
- Parameters:
-
- oV4PartDef
- The state of the setting parameter.
Legal values:
0: "SetGeo"
1: "Solid"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetVisu_Mode_2DInfo
| public virtual GetVisu_Mode_2DInfo( | | oInfo) |
-
Retrieves information about the "Projection of Space for transparent views"
setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetVisu_Mode_2D
| public virtual GetVisu_Mode_2D( | | o2DVisuMode) |
-
Retrieves 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.
- Parameters:
-
- o2DVisuMode
- The type of projection mode.
Legal values:
0: "NHR_2DVisuMode"
1: "HLR_2DVisuMode"
2: "SameAsV4Mode"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAffiche_AttributLock
| public virtual SetAffiche_AttributLock( | | iLocked) |
-
Locks or unlocks the "Display Report Attribute" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetAffiche_Attribut
| public virtual SetAffiche_Attribut( | | iAfficheAttr) |
-
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.
- Parameters:
-
- iAfficheAttr
- The state of the option.
Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMapping_File_Save_ModeLock
| public virtual SetMapping_File_Save_ModeLock( | | iLocked) |
-
Locks or unlocks the "Mapping Files Location for Saving" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMapping_File_Save_Mode
| public virtual SetMapping_File_Save_Mode( | | iMapFileMode) |
-
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.
- Parameters:
-
- iMapFileMode
- The directory.
Legal values:
0: "SaveInDir"
1: "SaveWithMdl"
2: "SaveInFile"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMapping_Saving_FileLock
| public virtual SetMapping_Saving_FileLock( | | iLocked) |
-
Locks or unlocks the "Specified Directory" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMapping_Saving_File
| public virtual SetMapping_Saving_File( | | iMapSavingFile) |
-
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.
- Parameters:
-
- iMapFileMode
- The path of the specified directory.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMigration_FormatLock
| public virtual SetMigration_FormatLock( | | iLocked) |
-
Locks or unlocks the "Format" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMigration_Format
| public virtual SetMigration_Format( | | iMigrFormat) |
-
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.
- Parameters:
-
- iMigrFormat
- The migration format.
Legal values:
0: "Spec"
1: "Result"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMigration_InterfaceLock
| public virtual SetMigration_InterfaceLock( | | iLocked) |
-
Locks or unlocks the "Migration Interface" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMigration_Interface
| public virtual SetMigration_Interface( | | iMigrItf) |
-
Sets the state of 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
- Parameters:
-
- iMigrItf
- The name of the interface.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMigration_TypeLock
| public virtual SetMigration_TypeLock( | | iLocked) |
-
Locks or unlocks the "Conversion" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMigration_Type
| public virtual SetMigration_Type( | | iMigrType) |
-
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.
- Parameters:
-
- iMigrType
- The conversion mode.
Legal values:
0: "SpaceDraw"
1: "Space"
2: "Draw"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSearch_List_Size
| public virtual SetSearch_List_Size( | | iListSize) |
-
Sets the size of the "Mapping Files Location for Retrieving" list.
Role: This setting enables to set the size of the "Mapping
Files Location for Retrieving" list.
- Parameters:
-
- oListSize
- The list size.
o SetSearch_Mapping_List
| public virtual SetSearch_Mapping_List( | | iMapList) |
-
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:
-
- iMapList
- The Mapping files path.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetStartUp_Model_For_DrawingLock
| public virtual SetStartUp_Model_For_DrawingLock( | | iLocked) |
-
Locks or unlocks the "Initial Drawing Path" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetStartUp_Model_For_Drawing
| public virtual SetStartUp_Model_For_Drawing( | | iInitialModel) |
-
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.
- Parameters:
-
- iInitialModel
- The path of the document used as a template.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetV4_Part_DefinitionLock
| public virtual SetV4_Part_DefinitionLock( | | iLocked) |
-
Locks or unlocks the "V4 Part Definition" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetV4_Part_Definition
| public virtual SetV4_Part_Definition( | | iV4PartDef) |
-
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.
.
- Parameters:
-
- iV4PartDef
- The state of the setting parameter.
Legal values:
0: "SetGeo"
1: "Solid"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetVisu_Mode_2DLock
| public virtual SetVisu_Mode_2DLock( | | iLocked) |
-
Locks or unlocks the "Projection of Space for transparent views" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetVisu_Mode_2D
| public virtual SetVisu_Mode_2D( | | i2DVisuMode) |
-
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.
- Parameters:
-
- i2DVisuMode
- The type of projection mode.
Legal values:
0: "NHR_2DVisuMode"
1: "HLR_2DVisuMode"
2: "SameAsV4Mode"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: CATIV4IMigrBatchSettingAtt.h
If needed, your Imakefile.mk should include the module: CATV4iSettings