All Frameworks Class Hierarchy This Framework Indexes
CATIAV4Interfaces Interface CATIV4IV4WritingSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIV4IV4WritingSettingAtt
Interface representing the Saving As V4 Data setting controller object.
Role: The Saving As V4 Data setting controller object deals with the setting
parameters displayed in the Saving As V4 Data property page.
To access this property page:
- Click the Options command in the Tools menu
- Click + left of General to unfold the workbench list
- Click Compatibility
The different options for V4/V5SPEC tab:
| The Writing Code Page |
| The Model Dimension |
| The Model Unit |
| The Initial Model File Path |
| The Associativity Mode |
| The Layer For Non Associative Data |
| The Error Feature Creation if the Save is not complete |
| The Curves Associated To Face Boundaries Creation |
| The V4 Model File Name In Capitals Letters |
| The Small Edges And Faces Cleaning Tolerance |
Method Index
- o
GetAsso_modeInfo(CATSettingInfo*)
- Retrieves information about the Asso_mode setting parameter.
- o
GetAsso_mode(CATV4IV5V4AssociativityModeEnum&)
- Retrieves the Associativity Mode setting parameter value.
- o
GetCleanTolCheckInfo(CATSettingInfo*)
- Retrieves information about the CleanTolCheck setting parameter.
- o
GetCleanTolCheck(CATBoolean&)
- Retrieves the cleaning tolerance mode setting parameter value.
- o
GetCleanTolValueInfo(CATSettingInfo*)
- Retrieves information about the CleanTolValue setting parameter.
- o
GetCleanTolValue(double&)
- Retrieves the cleaning tolerance value setting parameter value.
- o
GetCode_page_DestInfo(CATSettingInfo*)
- Retrieves information about the Code_page_Dest setting parameter.
- o
GetCode_page_Dest(int&)
- Retrieves the Writing Code Page setting parameter value.
- o
GetInitial_Model_File_PathInfo(CATSettingInfo*)
- Retrieves information about the Initial_Model_File_Path setting parameter.
- o
GetInitial_Model_File_Path(CATUnicodeString&)
- Retrieves the Initial Model File Path setting parameter value.
- o
GetLayer_for_No_AssoInfo(CATSettingInfo*)
- Retrieves information about the Layer_for_No_Asso setting parameter.
- o
GetLayer_for_No_Asso(int&)
- Retrieves the Layer setting parameter value when non associative mode was chosen.
- o
GetModeCreateDisplayInfo(CATSettingInfo*)
- Retrieves information about the ModeCreateDisplay setting parameter.
- o
GetModeCreateDisplay(CATV4IV5V4InternalCurveCreationEnum&)
- Retrieves the Curve Display Mode setting parameter value.
- o
GetModeErrorDisplayInfo(CATSettingInfo*)
- Retrieves information about the ModeErrorDisplay setting parameter.
- o
GetModeErrorDisplay(CATV4IV5V4ErrorFeatureCreationEnum&)
- Retrieves the Error Feature Display setting parameter value.
- o
GetModel_DimensionInfo(CATSettingInfo*)
- Retrieves information about the Model_Dimension setting parameter.
- o
GetModel_Dimension(double&)
- Retrieves the Model Dimension Value setting parameter value.
- o
GetModel_FactorInfo(CATSettingInfo*)
- Retrieves information about the Model_Factor setting parameter.
- o
GetModel_Factor(double&)
- Retrieves the Multiplication Factor setting parameter value.
- o
GetModel_File_NameInfo(CATSettingInfo*)
- Retrieves information about the Model_File_Name setting parameter.
- o
GetModel_File_Name(CATBoolean&)
- Retrieves the Capital Letters setting parameter value.
- o
GetModel_UnitInfo(CATSettingInfo*)
- Retrieves information about the Model_Unit setting parameter.
- o
GetModel_Unit(int&)
- Retrieves the Model Dimension Unit setting parameter value.
- o
SetAsso_modeLock(unsigned char)
- Locks or unlocks the Asso_mode setting parameter.
- o
SetAsso_mode(CATV4IV5V4AssociativityModeEnum)
- Sets the Associativity Mode setting parameter value.
- o
SetCleanTolCheckLock(unsigned char)
- Locks or unlocks the CleanTolCheck setting parameter.
- o
SetCleanTolCheck(CATBoolean)
- Sets the cleaning tolerance mode setting parameter value.
- o
SetCleanTolValueLock(unsigned char)
- Locks or unlocks the CleanTolValue setting parameter.
- o
SetCleanTolValue(double)
- Sets the cleaning tolerance value setting parameter value.
- o
SetCode_page_DestLock(unsigned char)
- Locks or unlocks the Code_page_Dest setting parameter.
- o
SetCode_page_Dest(int)
- Sets the Writing Code page setting parameter value.
- o
SetInitial_Model_File_PathLock(unsigned char)
- Locks or unlocks the Initial_Model_File_Path setting parameter.
- o
SetInitial_Model_File_Path(CATUnicodeString&)
- Sets the Initial Model File Path setting parameter value.
- o
SetLayer_for_No_AssoLock(unsigned char)
- Locks or unlocks the Layer_for_No_Asso setting parameter.
- o
SetLayer_for_No_Asso(int)
- Sets the Layer setting parameter value.
- o
SetModeCreateDisplayLock(unsigned char)
- Locks or unlocks the ModeCreateDisplay setting parameter.
- o
SetModeCreateDisplay(CATV4IV5V4InternalCurveCreationEnum)
- Sets the Curve Display Mode setting parameter value.
- o
SetModeErrorDisplayLock(unsigned char)
- Locks or unlocks the ModeErrorDisplay setting parameter.
- o
SetModeErrorDisplay(CATV4IV5V4ErrorFeatureCreationEnum)
- Sets the Error Feature Display setting parameter value.
- o
SetModel_DimensionLock(unsigned char)
- Locks or unlocks the Model_Dimension setting parameter.
- o
SetModel_Dimension(double)
- Sets the Model Dimension Value setting parameter value.
- o
SetModel_FactorLock(unsigned char)
- Locks or unlocks the Model_Factor setting parameter.
- o
SetModel_Factor(double)
- Sets the Multiplication Factor setting parameter value.
- o
SetModel_File_NameLock(unsigned char)
- Locks or unlocks the Model_File_Name setting parameter.
- o
SetModel_File_Name(CATBoolean)
- Sets the Capital Letters setting parameter value.
- o
SetModel_UnitLock(unsigned char)
- Locks or unlocks the Model_Unit setting parameter.
- o
SetModel_Unit(int)
- Sets the Model Dimension Unit setting parameter value.
Methods
o GetAsso_modeInfo
| public virtual GetAsso_modeInfo( | | oInfo) |
-
Retrieves information about the Asso_mode setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetAsso_mode
| public virtual GetAsso_mode( | | oAssoMode) |
-
Retrieves the Associativity Mode setting parameter value.
Role: The Associativity Mode setting parameter manages the mode in
which save as model will be done.
- Parameters:
-
- oAssoMode
- The Associativity Mode setting parameter value
- Returns:
- S_OK if the Associativity Mode setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetCleanTolCheckInfo
| public virtual GetCleanTolCheckInfo( | | oInfo) |
-
Retrieves information about the CleanTolCheck setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetCleanTolCheck
| public virtual GetCleanTolCheck( | | oCheck) |
-
Retrieves the cleaning tolerance mode setting parameter value.
Role: The cleaning tolerance mode setting parameter manages the cleaning
of small elements in V4 model.
- Parameters:
-
- oCheck
- The cleaning tolerance mode setting parameter value
- Returns:
- S_OK if the cleaning tolerance mode setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetCleanTolValueInfo
| public virtual GetCleanTolValueInfo( | | oInfo) |
-
Retrieves information about the CleanTolValue setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetCleanTolValue
| public virtual GetCleanTolValue( | | oValue) |
-
Retrieves the cleaning tolerance value setting parameter value.
Role: The cleaning tolerance value setting parameter manages the cleaning
of small elements in V4 model.
- Parameters:
-
- oValue
- The cleaning tolerance value setting parameter value
- Returns:
- S_OK if the cleaning tolerance setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetCode_page_DestInfo
| public virtual GetCode_page_DestInfo( | | oInfo) |
-
Retrieves information about the Code_page_Dest setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetCode_page_Dest
| public virtual GetCode_page_Dest( | | oStateOfCpdest) |
-
Retrieves the Writing Code Page setting parameter value.
Role: The Writing Code Page setting parameter manages the format related with
the language used by the customer.
- Parameters:
-
- oStateOfCpdest
- The Writing code page setting parameter value that is the selected line number of the combo box.
- Returns:
- S_OK if the Writing Code page setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetInitial_Model_File_PathInfo
| public virtual GetInitial_Model_File_PathInfo( | | oInfo) |
-
Retrieves information about the Initial_Model_File_Path setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetInitial_Model_File_Path
| public virtual GetInitial_Model_File_Path( | | oDefaultInitialModelPath) |
-
Retrieves the Initial Model File Path setting parameter value.
Role: The Initial Model File Path setting parameter manages the location
of a V4 model which will be used during save as model
- Parameters:
-
- oDefaultInitialModelPath
- The Initial Model File Path setting parameter value
- Returns:
- S_OK if the Initial Model File Path setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetLayer_for_No_AssoInfo
| public virtual GetLayer_for_No_AssoInfo( | | oInfo) |
-
Retrieves information about the Layer_for_No_Asso setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetLayer_for_No_Asso
| public virtual GetLayer_for_No_Asso( | | oDefaultLayer) |
-
Retrieves the Layer setting parameter value when non associative mode was chosen.
Role: The Layer setting parameter manages the layer used
when save as model is not associative
- Parameters:
-
- oDefaultLayer
- The Layer setting parameter value
- Returns:
- S_OK if the Layer setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetModeCreateDisplayInfo
| public virtual GetModeCreateDisplayInfo( | | oInfo) |
-
Retrieves information about the ModeCreateDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetModeCreateDisplay
| public virtual GetModeCreateDisplay( | | oDefaultCreateDisplay) |
-
Retrieves the Curve Display Mode setting parameter value.
Role: The Curve Display Mode setting parameter manages the mode.
of creation of V4 curves (between faces).
- Parameters:
-
- oDefaultCreateDisplay
- The Curve Display Mode setting parameter value
- Returns:
- S_OK if the Curve Display Mode setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetModeErrorDisplayInfo
| public virtual GetModeErrorDisplayInfo( | | oInfo) |
-
Retrieves information about the ModeErrorDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetModeErrorDisplay
| public virtual GetModeErrorDisplay( | | oModeErrorDisplay) |
-
Retrieves the Error Feature Display setting parameter value.
Role: The Error Feature Display setting parameter manages the creation
of an error feature when the save is not complete.
- Parameters:
-
- oModeErrorDisplay
- The Error Feature Display setting parameter value
- Returns:
- S_OK if the Error Feature Display setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetModel_DimensionInfo
| public virtual GetModel_DimensionInfo( | | oInfo) |
-
Retrieves information about the Model_Dimension setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetModel_Dimension
| public virtual GetModel_Dimension( | | oValueOfModelDim) |
-
Retrieves the Model Dimension Value setting parameter value.
Role: The Model Dimension Value setting parameter manages the value of
the model dimension usually used in V4
- Parameters:
-
- oValueOfModelDim
- The Model Dimension Value setting parameter value
- Returns:
- S_OK if the Model Dimension Value setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetModel_FactorInfo
| public virtual GetModel_FactorInfo( | | oInfo) |
-
Retrieves information about the Model_Factor setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetModel_Factor
| public virtual GetModel_Factor( | | oDefaultModelFactor) |
-
Retrieves the Multiplication Factor setting parameter value.
Role: The Multiplication Factor setting parameter manages the conversion
of model dimension in millimeters. This parameter is used with the Model Dimension
Unit parameter in order to stock the value in millimeter in the CATSetting. The Multiplication
factor is the ratio between millimeters and the unit selected. For example if the unit selected
is Meter, then the Multiplication Factor is 1000.
- Parameters:
-
- DefaultModelFactor
- The Multiplication Factor setting parameter value
- Returns:
- S_OK if the Multiplication Factor setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetModel_File_NameInfo
| public virtual GetModel_File_NameInfo( | | oInfo) |
-
Retrieves information about the Model_File_Name setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetModel_File_Name
| public virtual GetModel_File_Name( | | oDefaultModelFileName) |
-
Retrieves the Capital Letters setting parameter value.
Role: The Capital Letters setting parameter manages the mode
of creation of the V4 model name (in capital letters or not)
- Parameters:
-
- oDefaultModelFileName
- The Capital Letters setting parameter value
- Returns:
- S_OK if the Capital Letters setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetModel_UnitInfo
| public virtual GetModel_UnitInfo( | | oInfo) |
-
Retrieves information about the Model_Unit setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetModel_Unit
| public virtual GetModel_Unit( | | oDefaultModelUnit) |
-
Retrieves the Model Dimension Unit setting parameter value.
Role: The Model Dimension Unit setting parameter manages the unit used
for save as model. As the reference unit used in CATSettings is millimeters, a factor
to convert units chosen is necessary. This factor is the Multiplication Factor parameter.
- Parameters:
-
- oDefaultModelUnit
- The Model Dimension Unit setting parameter value
- Returns:
- S_OK if the Model Dimension Unit setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetAsso_modeLock
| public virtual SetAsso_modeLock( | | iLocked) |
-
Locks or unlocks the Asso_mode setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetAsso_mode
| public virtual SetAsso_mode( | | iAssoMode) |
-
Sets the Associativity Mode setting parameter value.
- Parameters:
-
- iAssoMode
- The Associativity Mode setting parameter value.
- Returns:
- S_OK if the Associativity Mode setting parameter value
is successfully set, and E_FAIL otherwise
o SetCleanTolCheckLock
| public virtual SetCleanTolCheckLock( | | iLocked) |
-
Locks or unlocks the CleanTolCheck setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetCleanTolCheck
| public virtual SetCleanTolCheck( | | iCheck) |
-
Sets the cleaning tolerance mode setting parameter value.
Role: The cleaning tolerance mode setting parameter manages the cleaning
of small elements in V4 model.
- Parameters:
-
- iValue
- The cleaning tolerance mode setting parameter value
- Returns:
- S_OK if the cleaning tolerance mode setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetCleanTolValueLock
| public virtual SetCleanTolValueLock( | | iLocked) |
-
Locks or unlocks the CleanTolValue setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetCleanTolValue
| public virtual SetCleanTolValue( | | iValue) |
-
Sets the cleaning tolerance value setting parameter value.
Role: The cleaning tolerance value setting parameter manages the cleaning
of small elements in V4 model.
- Parameters:
-
- iValue
- The cleaning tolerance setting parameter value
- Returns:
- S_OK if the cleaning tolerance value setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetCode_page_DestLock
| public virtual SetCode_page_DestLock( | | iLocked) |
-
Locks or unlocks the Code_page_Dest setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetCode_page_Dest
| public virtual SetCode_page_Dest( | | iStateOfCpdest) |
-
Sets the Writing Code page setting parameter value.
- Parameters:
-
- iStateOfCpdest
- The Writing Code page setting parameter value that is the selected line number of the combo box.
- Returns:
- S_OK if the Writing Code page setting parameter value
is successfully set, and E_FAIL otherwise
o SetInitial_Model_File_PathLock
| public virtual SetInitial_Model_File_PathLock( | | iLocked) |
-
Locks or unlocks the Initial_Model_File_Path setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetInitial_Model_File_Path
| public virtual SetInitial_Model_File_Path( | | iDefaultInitialModelPath) |
-
Sets the Initial Model File Path setting parameter value.
- Parameters:
-
- iDefaultInitialModelPath
- The Initial Model File Path setting parameter value.
- Returns:
- S_OK if the Initial Model File Path setting parameter value
is successfully set, and E_FAIL otherwise
o SetLayer_for_No_AssoLock
| public virtual SetLayer_for_No_AssoLock( | | iLocked) |
-
Locks or unlocks the Layer_for_No_Asso setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetLayer_for_No_Asso
| public virtual SetLayer_for_No_Asso( | | iDefaultLayer) |
-
Sets the Layer setting parameter value.
- Parameters:
-
- iDefaultLayer
- The Layer setting parameter value.
- Returns:
- S_OK if the Layer setting parameter value
is successfully set, and E_FAIL otherwise
o SetModeCreateDisplayLock
| public virtual SetModeCreateDisplayLock( | | iLocked) |
-
Locks or unlocks the ModeCreateDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetModeCreateDisplay
| public virtual SetModeCreateDisplay( | | iDefaultCreateDisplay) |
-
Sets the Curve Display Mode setting parameter value.
- Parameters:
-
- iDefaultCreateDisplay
- The Curve Display Mode setting parameter value.
- Returns:
- S_OK if the Curve Display Mode setting parameter value
is successfully set, and E_FAIL otherwise
o SetModeErrorDisplayLock
| public virtual SetModeErrorDisplayLock( | | iLocked) |
-
Locks or unlocks the ModeErrorDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetModeErrorDisplay
| public virtual SetModeErrorDisplay( | | iModeErrorDisplay) |
-
Sets the Error Feature Display setting parameter value.
- Parameters:
-
- iModeErrorDisplay
- The Error Feature Display setting parameter value.
- Returns:
- S_OK if the Error Feature Display setting parameter value
is successfully set, and E_FAIL otherwise
o SetModel_DimensionLock
| public virtual SetModel_DimensionLock( | | iLocked) |
-
Locks or unlocks the Model_Dimension setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetModel_Dimension
| public virtual SetModel_Dimension( | | iValueOfModelDim) |
-
Sets the Model Dimension Value setting parameter value.
- Parameters:
-
- iValueOfModelDim
- The Model Dimension Value setting parameter value.
- Returns:
- S_OK if the Model Dimension Value setting parameter value
is successfully set, and E_FAIL otherwise
o SetModel_FactorLock
| public virtual SetModel_FactorLock( | | iLocked) |
-
Locks or unlocks the Model_Factor setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetModel_Factor
| public virtual SetModel_Factor( | | iDefaultModelFactor) |
-
Sets the Multiplication Factor setting parameter value.
- Parameters:
-
- iDefaultModelFactor
- The Multiplication Factor setting parameter value.
- Returns:
- S_OK if the Multiplication Factor setting parameter value
is successfully set, and E_FAIL otherwise
o SetModel_File_NameLock
| public virtual SetModel_File_NameLock( | | iLocked) |
-
Locks or unlocks the Model_File_Name setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetModel_File_Name
| public virtual SetModel_File_Name( | | iDefaultModelFileName) |
-
Sets the Capital Letters setting parameter value.
- Parameters:
-
- iDefaultModelFileName
- The Capital Letters setting parameter value.
- Returns:
- S_OK if the Capital Letters setting parameter value
is successfully set, and E_FAIL otherwise
o SetModel_UnitLock
| public virtual SetModel_UnitLock( | | iLocked) |
-
Locks or unlocks the Model_Unit setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetModel_Unit
| public virtual SetModel_Unit( | | iDefaultModelUnit) |
-
Sets the Model Dimension Unit setting parameter value.
- Parameters:
-
- iDefaultModelUnit
- The Model Dimension Unit setting parameter value that is the selected line number of the combo box.
- Returns:
- S_OK if the Model Dimension Unit setting parameter value
is successfully set, and E_FAIL otherwise
This object is included in the file: CATIV4IV4WritingSettingAtt.h
If needed, your Imakefile.mk should include the module: CATV4iSettings