All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATIAV4Interfaces Interface CATIV4IInteropSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIV4IInteropSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIV4IInteropSettingAtt
Interface 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
Method Index
- o
GetCode_page(CATString&)
- Retrieves the value of the "Reading Code page" setting parameter.
- o
GetCode_pageInfo(CATSettingInfo*)
- Retrieves information about the "Reading Code page" setting parameter.
- o
GetConversion_Table(CATUnicodeString&)
- Retrieves the location of the "Characters Equivalence Table Path" setting parameter.
- o
GetConversion_TableInfo(CATSettingInfo*)
- Retrieves information about the "Characters Equivalence Table Path" etting parameter.
- o
GetDisplayMode(CATBoolean&)
- Retrieves the state of the "Display only elements with Sensitive Attribute"
setting parameter.
- o
GetDisplayModeInfo(CATSettingInfo*)
- Retrieves information about the "Display only elements with Sensitive Attribute"
setting parameter.
- o
GetDisplayV4Text3D(CATBoolean&)
- Retrieves the state of the "Display 3D elements labels" setting parameter.
- o
GetDisplayV4Text3DInfo(CATSettingInfo*)
- Retrieves information about the "Display 3D elements labels" setting parameter.
- o
GetDlname(CATUnicodeString&)
- Retrieves the "DlNAME" setting parameter.
- o
GetDlnameInfo(CATSettingInfo*)
- Retrieves information about the "DLNAME" setting parameter.
- o
GetDraw(CATString&)
- Retrieves the state of the "Open in Light Mode: 2D Data are not taken into
account" setting parameter.
- o
GetDrawInfo(CATSettingInfo*)
- Retrieves information about the "Open in Light Mode: 2D Data are not taken into
account" setting parameter.
- o
GetPROJECT_File_Path(CATUnicodeString&)
- Retrieves the value of the "PROJECT File Path" setting parameter.
- o
GetPROJECT_File_PathInfo(CATSettingInfo*)
- Retrieves information about the "PROJECT File Path" setting parameter.
- o
SetCode_page(CATString&)
- Sets the state of the "Reading Code page" setting parameter.
- o
SetCode_pageLock(unsigned char)
- Locks or unlocks the "Reading Code page" setting parameter.
- o
SetConversion_Table(CATUnicodeString&)
- Sets the location of the "Characters Equivalence Table Path" setting parameter.
- o
SetConversion_TableLock(unsigned char)
- Locks or unlocks the "Characters Equivalence Table Path" setting parameter.
- o
SetDisplayMode(CATBoolean)
- Sets the state of the "Display only elements with Sensitive Attribute"
setting parameter.
- o
SetDisplayModeLock(unsigned char)
- Locks or unlocks the "Display only elements with Sensitive Attribute"
setting parameter.
- o
SetDisplayV4Text3D(CATBoolean)
- Sets the state of the "Display 3D elements labels" setting parameter.
- o
SetDisplayV4Text3DLock(unsigned char)
- Locks or unlocks the "Display 3D elements labels" setting parameter.
- o
SetDlname(CATUnicodeString&)
- Sets the "DLNAME" setting parameter.
- o
SetDlnameLock(unsigned char)
- Locks or unlocks the "DLNAME" setting parameter.
- o
SetDraw(CATString&)
- Sets the state of the "Open in Light Mode: 2D Data are not taken into
account" setting parameter.
- o
SetDrawLock(unsigned char)
- Locks or unlocks the "Open in Light Mode: 2D Data are not taken into
account" setting parameter.
- o
SetPROJECT_File_Path(CATUnicodeString&)
- Sets the "PROJECT File Path" setting parameter.
- o
SetPROJECT_File_PathLock(unsigned char)
- Locks or unlocks the "PROJECT File Path" setting parameter.
Methods
o GetCode_page
-
Retrieves 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.
- Parameters:
-
- oDefaultCPage
- The state of the Code_page.
Legal values:
0: "French"
1: "Chinese"
2: "German"
3: "Italian"
4: "Japanese"
5: "Korean"
6: "Swedish"
7: "UK_English"
8: "US_English"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCode_pageInfo
-
Retrieves information about the "Reading Code page" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetConversion_Table
-
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.
- Parameters:
-
- oDefaultTab
- The table path.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetConversion_TableInfo
-
Retrieves information about the "Characters Equivalence Table Path" etting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDisplayMode
-
Retrieves 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.
- Parameters:
-
- oStateOfDisp
- The state of the setting parameter.
Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayModeInfo
-
Retrieves information about the "Display only elements with Sensitive Attribute"
setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDisplayV4Text3D
-
Retrieves 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.
- Parameters:
-
- oStateOf3DText
- The state of the setting parameter.
Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayV4Text3DInfo
-
Retrieves information about the "Display 3D elements labels" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDlname
-
Retrieves the "DlNAME" setting parameter.
Role: Retrieves the DLNAME referenced by the Model.
- Parameters:
-
- oDefaultDlname
- The Dlname.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDlnameInfo
-
Retrieves information about the "DLNAME" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDraw
-
Retrieves 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.
- Parameters:
-
- oStateOfNoDraft
- The state of the Draw.
Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDrawInfo
-
Retrieves information about the "Open in Light Mode: 2D Data are not taken into
account" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetPROJECT_File_Path
-
Retrieves 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.
- Parameters:
-
- oDefaultPrj
- The Path of the PROJECT File.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPROJECT_File_PathInfo
-
Retrieves information about the "PROJECT File Path" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetCode_page
-
Sets the state 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.
- Parameters:
-
- iDefaultCPage
- The Code_page
Legal values:
0: "French"
1: "Chinese"
2: "German"
3: "Italian"
4: "Japanese"
5: "Korean"
6: "Swedish"
7: "UK_English"
8: "US_English"
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCode_pageLock
public virtual HRESULT SetCode_pageLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "Reading Code page" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetConversion_Table
-
Sets 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.
- Parameters:
-
- iDefaultTab
- The table path.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetConversion_TableLock
public virtual HRESULT SetConversion_TableLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "Characters Equivalence Table Path" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDisplayMode
-
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.
- Parameters:
-
- iStateOfDisp
- The state of the DisplayMode option.
Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayModeLock
public virtual HRESULT SetDisplayModeLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "Display only elements with Sensitive Attribute"
setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDisplayV4Text3D
-
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.
- Parameters:
-
- iStateOf3DText
- The state of the setting parameter.
Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayV4Text3DLock
public virtual HRESULT SetDisplayV4Text3DLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "Display 3D elements labels" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDlname
-
Sets the "DLNAME" setting parameter.
Role: Sets the DLNAME referenced by the Model.
- Parameters:
-
- iDefaultDlname
- The Dlname
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDlnameLock
public virtual HRESULT SetDlnameLock( | unsigned char | iLocked)= 0 |
-
Locks or unlocks the "DLNAME" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDraw
-
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.
- Parameters:
-
- iStateOfNoDraft
- The state of the Draw option.
Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDrawLock
public virtual HRESULT SetDrawLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "Open in Light Mode: 2D Data are not taken into
account" setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetPROJECT_File_Path
-
Sets 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.
- Parameters:
-
- iDefaultPrj
- The Path of the PROJECT File.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPROJECT_File_PathLock
public virtual HRESULT SetPROJECT_File_PathLock( | unsigned char | iLocked) = 0 |
-
Locks or unlocks the "PROJECT File Path" setting parameter.
Refer to
CATSysSettingController for a detailed description.
This object is included in the file: CATIV4IInteropSettingAtt.h
If needed, your Imakefile.mk should include the module: CATV4iSettings