All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CATIAV4Interfaces Interface CATIV4IV4WritingSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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:


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_mode(CATV4IV5V4AssociativityModeEnum&)
Retrieves the Associativity Mode setting parameter value.
o GetAsso_modeInfo(CATSettingInfo*)
Retrieves information about the Asso_mode setting parameter.
o GetCleanTolCheck(CATBoolean&)
Retrieves the cleaning tolerance mode setting parameter value.
o GetCleanTolCheckInfo(CATSettingInfo*)
Retrieves information about the CleanTolCheck setting parameter.
o GetCleanTolValue(double&)
Retrieves the cleaning tolerance value setting parameter value.
o GetCleanTolValueInfo(CATSettingInfo*)
Retrieves information about the CleanTolValue setting parameter.
o GetCode_page_Dest(int&)
Retrieves the Writing Code Page setting parameter value.
o GetCode_page_DestInfo(CATSettingInfo*)
Retrieves information about the Code_page_Dest setting parameter.
o GetInitial_Model_File_Path(CATUnicodeString&)
Retrieves the Initial Model File Path setting parameter value.
o GetInitial_Model_File_PathInfo(CATSettingInfo*)
Retrieves information about the Initial_Model_File_Path setting parameter.
o GetLayer_for_No_Asso(int&)
Retrieves the Layer setting parameter value when non associative mode was chosen.
o GetLayer_for_No_AssoInfo(CATSettingInfo*)
Retrieves information about the Layer_for_No_Asso setting parameter.
o GetModeCreateDisplay(CATV4IV5V4InternalCurveCreationEnum&)
Retrieves the Curve Display Mode setting parameter value.
o GetModeCreateDisplayInfo(CATSettingInfo*)
Retrieves information about the ModeCreateDisplay setting parameter.
o GetModeErrorDisplay(CATV4IV5V4ErrorFeatureCreationEnum&)
Retrieves the Error Feature Display setting parameter value.
o GetModeErrorDisplayInfo(CATSettingInfo*)
Retrieves information about the ModeErrorDisplay setting parameter.
o GetModel_Dimension(double&)
Retrieves the Model Dimension Value setting parameter value.
o GetModel_DimensionInfo(CATSettingInfo*)
Retrieves information about the Model_Dimension setting parameter.
o GetModel_Factor(double&)
Retrieves the Multiplication Factor setting parameter value.
o GetModel_FactorInfo(CATSettingInfo*)
Retrieves information about the Model_Factor setting parameter.
o GetModel_File_Name(CATBoolean&)
Retrieves the Capital Letters setting parameter value.
o GetModel_File_NameInfo(CATSettingInfo*)
Retrieves information about the Model_File_Name setting parameter.
o GetModel_Unit(int&)
Retrieves the Model Dimension Unit setting parameter value.
o GetModel_UnitInfo(CATSettingInfo*)
Retrieves information about the Model_Unit setting parameter.
o SetAsso_mode(CATV4IV5V4AssociativityModeEnum)
Sets the Associativity Mode setting parameter value.
o SetAsso_modeLock(unsigned char)
Locks or unlocks the Asso_mode setting parameter.
o SetCleanTolCheck(CATBoolean)
Sets the cleaning tolerance mode setting parameter value.
o SetCleanTolCheckLock(unsigned char)
Locks or unlocks the CleanTolCheck setting parameter.
o SetCleanTolValue(double)
Sets the cleaning tolerance value setting parameter value.
o SetCleanTolValueLock(unsigned char)
Locks or unlocks the CleanTolValue setting parameter.
o SetCode_page_Dest(int)
Sets the Writing Code page setting parameter value.
o SetCode_page_DestLock(unsigned char)
Locks or unlocks the Code_page_Dest setting parameter.
o SetInitial_Model_File_Path(CATUnicodeString&)
Sets the Initial Model File Path setting parameter value.
o SetInitial_Model_File_PathLock(unsigned char)
Locks or unlocks the Initial_Model_File_Path setting parameter.
o SetLayer_for_No_Asso(int)
Sets the Layer setting parameter value.
o SetLayer_for_No_AssoLock(unsigned char)
Locks or unlocks the Layer_for_No_Asso setting parameter.
o SetModeCreateDisplay(CATV4IV5V4InternalCurveCreationEnum)
Sets the Curve Display Mode setting parameter value.
o SetModeCreateDisplayLock(unsigned char)
Locks or unlocks the ModeCreateDisplay setting parameter.
o SetModeErrorDisplay(CATV4IV5V4ErrorFeatureCreationEnum)
Sets the Error Feature Display setting parameter value.
o SetModeErrorDisplayLock(unsigned char)
Locks or unlocks the ModeErrorDisplay setting parameter.
o SetModel_Dimension(double)
Sets the Model Dimension Value setting parameter value.
o SetModel_DimensionLock(unsigned char)
Locks or unlocks the Model_Dimension setting parameter.
o SetModel_Factor(double)
Sets the Multiplication Factor setting parameter value.
o SetModel_FactorLock(unsigned char)
Locks or unlocks the Model_Factor setting parameter.
o SetModel_File_Name(CATBoolean)
Sets the Capital Letters setting parameter value.
o SetModel_File_NameLock(unsigned char)
Locks or unlocks the Model_File_Name setting parameter.
o SetModel_Unit(int)
Sets the Model Dimension Unit setting parameter value.
o SetModel_UnitLock(unsigned char)
Locks or unlocks the Model_Unit setting parameter.

Methods


o GetAsso_mode
public virtual HRESULT GetAsso_mode(CATV4IV5V4AssociativityModeEnum& oAssoMode) = 0
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 GetAsso_modeInfo
public virtual HRESULT GetAsso_modeInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Asso_mode setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetCleanTolCheck
public virtual HRESULT GetCleanTolCheck(CATBoolean& oCheck)=0
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 GetCleanTolCheckInfo
public virtual HRESULT GetCleanTolCheckInfo(CATSettingInfo* oInfo)=0
Retrieves information about the CleanTolCheck setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetCleanTolValue
public virtual HRESULT GetCleanTolValue(double& oValue)=0
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 GetCleanTolValueInfo
public virtual HRESULT GetCleanTolValueInfo(CATSettingInfo* oInfo)=0
Retrieves information about the CleanTolValue setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetCode_page_Dest
public virtual HRESULT GetCode_page_Dest(int& oStateOfCpdest)= 0
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 GetCode_page_DestInfo
public virtual HRESULT GetCode_page_DestInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Code_page_Dest setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetInitial_Model_File_Path
public virtual HRESULT GetInitial_Model_File_Path(CATUnicodeString& oDefaultInitialModelPath)= 0
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 GetInitial_Model_File_PathInfo
public virtual HRESULT GetInitial_Model_File_PathInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Initial_Model_File_Path setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetLayer_for_No_Asso
public virtual HRESULT GetLayer_for_No_Asso(int& oDefaultLayer)= 0
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 GetLayer_for_No_AssoInfo
public virtual HRESULT GetLayer_for_No_AssoInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Layer_for_No_Asso setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetModeCreateDisplay
public virtual HRESULT GetModeCreateDisplay(CATV4IV5V4InternalCurveCreationEnum& oDefaultCreateDisplay)= 0
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 GetModeCreateDisplayInfo
public virtual HRESULT GetModeCreateDisplayInfo(CATSettingInfo* oInfo) = 0
Retrieves information about the ModeCreateDisplay setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetModeErrorDisplay
public virtual HRESULT GetModeErrorDisplay(CATV4IV5V4ErrorFeatureCreationEnum& oModeErrorDisplay)= 0
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 GetModeErrorDisplayInfo
public virtual HRESULT GetModeErrorDisplayInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the ModeErrorDisplay setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetModel_Dimension
public virtual HRESULT GetModel_Dimension(double& oValueOfModelDim) =0
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_DimensionInfo
public virtual HRESULT GetModel_DimensionInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Model_Dimension setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetModel_Factor
public virtual HRESULT GetModel_Factor(double& oDefaultModelFactor)= 0
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_FactorInfo
public virtual HRESULT GetModel_FactorInfo(CATSettingInfo* oInfo) = 0
Retrieves information about the Model_Factor setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetModel_File_Name
public virtual HRESULT GetModel_File_Name(CATBoolean& oDefaultModelFileName)= 0
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_File_NameInfo
public virtual HRESULT GetModel_File_NameInfo(CATSettingInfo* oInfo) = 0
Retrieves information about the Model_File_Name setting parameter.
Refer to CATSysSettingController for a detailed description.
o GetModel_Unit
public virtual HRESULT GetModel_Unit(int& oDefaultModelUnit)= 0
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 GetModel_UnitInfo
public virtual HRESULT GetModel_UnitInfo(CATSettingInfo* oInfo)= 0
Retrieves information about the Model_Unit setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetAsso_mode
public virtual HRESULT SetAsso_mode(CATV4IV5V4AssociativityModeEnum iAssoMode)= 0
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 SetAsso_modeLock
public virtual HRESULT SetAsso_modeLock(unsigned char iLocked)= 0
Locks or unlocks the Asso_mode setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetCleanTolCheck
public virtual HRESULT SetCleanTolCheck(CATBoolean iCheck)=0
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 SetCleanTolCheckLock
public virtual HRESULT SetCleanTolCheckLock(unsigned char iLocked)=0
Locks or unlocks the CleanTolCheck setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetCleanTolValue
public virtual HRESULT SetCleanTolValue(double iValue)=0
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 SetCleanTolValueLock
public virtual HRESULT SetCleanTolValueLock(unsigned char iLocked)=0
Locks or unlocks the CleanTolValue setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetCode_page_Dest
public virtual HRESULT SetCode_page_Dest(int iStateOfCpdest)= 0
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 SetCode_page_DestLock
public virtual HRESULT SetCode_page_DestLock(unsigned char iLocked)= 0
Locks or unlocks the Code_page_Dest setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetInitial_Model_File_Path
public virtual HRESULT SetInitial_Model_File_Path(CATUnicodeString& iDefaultInitialModelPath) = 0
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 SetInitial_Model_File_PathLock
public virtual HRESULT SetInitial_Model_File_PathLock(unsigned char iLocked)= 0
Locks or unlocks the Initial_Model_File_Path setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetLayer_for_No_Asso
public virtual HRESULT SetLayer_for_No_Asso(int iDefaultLayer)= 0
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 SetLayer_for_No_AssoLock
public virtual HRESULT SetLayer_for_No_AssoLock(unsigned char iLocked)=0
Locks or unlocks the Layer_for_No_Asso setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetModeCreateDisplay
public virtual HRESULT SetModeCreateDisplay(CATV4IV5V4InternalCurveCreationEnum iDefaultCreateDisplay)= 0
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 SetModeCreateDisplayLock
public virtual HRESULT SetModeCreateDisplayLock(unsigned char iLocked)= 0
Locks or unlocks the ModeCreateDisplay setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetModeErrorDisplay
public virtual HRESULT SetModeErrorDisplay(CATV4IV5V4ErrorFeatureCreationEnum iModeErrorDisplay)= 0
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 SetModeErrorDisplayLock
public virtual HRESULT SetModeErrorDisplayLock(unsigned char iLocked)= 0
Locks or unlocks the ModeErrorDisplay setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetModel_Dimension
public virtual HRESULT SetModel_Dimension(double iValueOfModelDim)= 0
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_DimensionLock
public virtual HRESULT SetModel_DimensionLock(unsigned char iLocked)= 0
Locks or unlocks the Model_Dimension setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetModel_Factor
public virtual HRESULT SetModel_Factor(double iDefaultModelFactor)= 0
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_FactorLock
public virtual HRESULT SetModel_FactorLock(unsigned char iLocked)= 0
Locks or unlocks the Model_Factor setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetModel_File_Name
public virtual HRESULT SetModel_File_Name(CATBoolean iDefaultModelFileName)= 0
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_File_NameLock
public virtual HRESULT SetModel_File_NameLock(unsigned char iLocked)= 0
Locks or unlocks the Model_File_Name setting parameter.
Refer to CATSysSettingController for a detailed description.
o SetModel_Unit
public virtual HRESULT SetModel_Unit(int iDefaultModelUnit) = 0
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
o SetModel_UnitLock
public virtual HRESULT SetModel_UnitLock(unsigned char iLocked)= 0
Locks or unlocks the Model_Unit setting parameter.
Refer to CATSysSettingController for a detailed description.

This object is included in the file: CATIV4IV4WritingSettingAtt.h
If needed, your Imakefile.mk should include the module: CATV4iSettings

Copyright © 2003, Dassault Systèmes. All rights reserved.