All Frameworks Class Hierarchy This Framework Indexes
KnowledgeInterfaces Interface CATILieUnitsSheetSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATILieUnitsSheetSettingAtt
The interface to access a CATILieUnitsSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values
of Units sheet.
Method Index
- o
CommitForUnits()
- Validates the unit settings in session.
- o
GetDecimalReadOnly(CATUnicodeString&,int*)
- Retrieves the DecimalReadOnly attribute.
- o
GetDecimalReadWrite(CATUnicodeString&,int*)
- Retrieves the DecimalReadWrite attribute.
- o
GetDimensionsDisplayInfo(CATSettingInfo*)
- Retrieves information about the DimensionsDisplay setting parameter.
- o
GetDisplayTrailingZerosInfo(CATSettingInfo*)
-
- o
GetDisplayTrailingZeros(int*)
- Retrieves the DisplayTrailingZeros attribute.
- o
GetExpNotationValuesGreaterInfo(CATSettingInfo*)
-
- o
GetExpNotationValuesGreater(int*)
- Retrieves the ExpNotationValuesGreater attribute.
- o
GetExpNotationValuesLowerInfo(CATSettingInfo*)
-
- o
GetExpNotationValuesLower(int*)
- Retrieves the ExpNotationValuesLower attribute.
- o
GetListOfMagnitudesInfo(CATSettingInfo*)
- Retrieves information about the ListOfMagnitudes setting parameter.
- o
GetListOfMagnitudesSize(int*)
- Retrieves the list of magnitudes size attribute.
- o
GetListOfMagnitudes(CATSafeArrayVariant&)
- Retrieves the list of magnitudes attribute.
- o
GetMagnitudeUnit(CATICkeMagnitude_var&,CATUnicodeString&)
- Retrieves the MagnitudeValues attribute.
- o
GetMagnitudeValues(CATUnicodeString&,CATUnicodeString&,int*,int*)
- Retrieves the MagnitudeValues attribute.
- o
GetSameDisplayInfo(CATSettingInfo*)
-
- o
GetSameDisplay(int*)
- Retrieves the SameDisplay attribute.
- o
ResetToAdminValuesForUnits()
- Resets the unit settings to default values.
- o
RollbackForUnits()
- Rollbacks the unit settings.
- o
SaveRepositoryForUnits()
- Saves the unit settings in repository.
- o
SetDimensionsDisplayLock(unsigned char)
- Locks or unlocks the DimensionsDisplay setting parameter.
- o
SetDisplayTrailingZerosLock(unsigned char)
-
- o
SetDisplayTrailingZeros(int*)
- Sets the DisplayTrailingZeros attribute.
- o
SetExpNotationValuesGreaterLock(unsigned char)
-
- o
SetExpNotationValuesGreater(int*)
- Sets the ExpNotationValuesGreater attribute.
- o
SetExpNotationValuesLowerLock(unsigned char)
-
- o
SetExpNotationValuesLower(int*)
- Sets the ExpNotationValuesLower attribute.
- o
SetListOfMagnitudesLock(unsigned char)
- Locks or unlocks the ListOfMagnitudes setting parameter.
- o
SetMagnitudeValues(CATUnicodeString&,CATUnicodeString&,int*,int*)
- Sets the MagnitudeValues attribute.
- o
SetSameDisplayLock(unsigned char)
-
- o
SetSameDisplay(int*)
- *
Sets the SameDisplay attribute.
Methods
o CommitForUnits
| public virtual CommitForUnits( | ) |
-
Validates the unit settings in session.
o GetDecimalReadOnly
| public virtual GetDecimalReadOnly( | | iMagnitudeName, |
| | oDecimalPlaceReadOnly) |
-
Retrieves the DecimalReadOnly attribute.
Role:Return the GetDecimalReadOnly parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the Magnitude.
- oDecimalPlaceReadOnly
- The value of the DecimalReadOnly attribute corresponding to the Magnitude.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDecimalReadWrite
| public virtual GetDecimalReadWrite( | | iMagnitudeName, |
| | oDecimalPlaceReadWrite) |
-
Retrieves the DecimalReadWrite attribute.
Role:Return the DecimalReadWrite parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the Magnitude.
- oDecimalPlaceReadWrite
- The value of the DecimalReadWrite attribute corresponding to the Magnitude.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDimensionsDisplayInfo
| public virtual GetDimensionsDisplayInfo( | | oInfo) |
-
Retrieves information about the DimensionsDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetDisplayTrailingZerosInfo
| public virtual GetDisplayTrailingZerosInfo( | | oInfo) |
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the DisplayTrailingZeros parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayTrailingZeros
| public virtual GetDisplayTrailingZeros( | | ioDisplayTrailingZeros) |
-
Retrieves the DisplayTrailingZeros attribute.
Role:Return the DisplayTrailingZeros parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioDisplayTrailingZeros
- Legal values:
0 : to not display trailing zeros
1 : to display trailing zeros.
o GetExpNotationValuesGreaterInfo
| public virtual GetExpNotationValuesGreaterInfo( | | oInfo) |
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the ExpNotationValuesGreater parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExpNotationValuesGreater
| public virtual GetExpNotationValuesGreater( | | ioExpNotationValuesGreater) |
-
Retrieves the ExpNotationValuesGreater attribute.
Role:Return the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioExpNotationValuesGreater
- The minimum value for exponential notation values.
o GetExpNotationValuesLowerInfo
| public virtual GetExpNotationValuesLowerInfo( | | oInfo) |
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the ExpNotationValuesLower parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetExpNotationValuesLower
| public virtual GetExpNotationValuesLower( | | ioExpNotationValuesLower) |
-
Retrieves the ExpNotationValuesLower attribute.
Role:Return the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioExpNotationValuesLower
- The maximum value for exponential notation values.
o GetListOfMagnitudesInfo
| public virtual GetListOfMagnitudesInfo( | | oInfo) |
-
Retrieves information about the ListOfMagnitudes setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetListOfMagnitudesSize
| public virtual GetListOfMagnitudesSize( | | oListOfMagnitudesSize) |
-
Retrieves the list of magnitudes size attribute.
Role:Return the ListOfMagnitudesSize parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oListOfMagnitudes
- address of an object int.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetListOfMagnitudes
| public virtual GetListOfMagnitudes( | | oListOfMagnitudes) |
-
Retrieves the list of magnitudes attribute.
Role:Return the ListOfMagnitudes parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- oListOfMagnitudes
- The list of magnitudes
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMagnitudeUnit
| public virtual GetMagnitudeUnit( | const | iMagnitude, |
| | oUnitName) |
-
Retrieves the MagnitudeValues attribute.
Role:Return the UnitName parameter for the given iMagnitude if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The Magnitude
- Returns:
- The value of the UnitName corresponding to the Magnitude.
o GetMagnitudeValues
| public virtual GetMagnitudeValues( | | iMagnitudeName, |
| | oUnitName, |
| | oDecimalPlaceReadWrite, |
| | oDecimalPlaceReadOnly) |
-
Retrieves the MagnitudeValues attribute.
Role:Return the MagnitudeValues parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the Magnitude.
- oUnitName
- The value of the UnitName corresponding to the Magnitude.
- oDecimalPlaceReadWrite
- The number of decimals for ReadWrite number.
- oDecimalPlaceReadOnly
-
The number of decimals for ReadOnly number.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSameDisplayInfo
| public virtual GetSameDisplayInfo( | | oInfo) |
-
- Deprecated:
- V5R15. Use GetDimensionsDisplayInfo.
Retrieves the state of the SameDisplay parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSameDisplay
| public virtual GetSameDisplay( | | ioSameDisplay) |
-
Retrieves the SameDisplay attribute.
Role:Return the SameDisplay parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- ioSameDisplay
- Legal values:
0 : to not display same display
1 : to display same display.
o ResetToAdminValuesForUnits
| public virtual ResetToAdminValuesForUnits( | ) |
-
Resets the unit settings to default values.
o RollbackForUnits
| public virtual RollbackForUnits( | ) |
-
Rollbacks the unit settings.
o SaveRepositoryForUnits
| public virtual SaveRepositoryForUnits( | ) |
-
Saves the unit settings in repository.
o SetDimensionsDisplayLock
| public virtual SetDimensionsDisplayLock( | | iLocked) |
-
Locks or unlocks the DimensionsDisplay setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDisplayTrailingZerosLock
| public virtual SetDisplayTrailingZerosLock( | | iLocked) |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the DisplayTrailingZeros parameter.
Role: Locks or unlocks the DisplayTrailingZeros parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayTrailingZeros
| public virtual SetDisplayTrailingZeros( | | iDisplayTrailingZeros) |
-
Sets the DisplayTrailingZeros attribute.
Role:Set the DisplayTrailingZeros parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iDisplayTrailingZeros
- Legal values:
0 : to not display trailing zeros
1 : to display trailing zeros.
o SetExpNotationValuesGreaterLock
| public virtual SetExpNotationValuesGreaterLock( | | iLocked) |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the ExpNotationValuesGreater parameter.
Role: Locks or unlocks the ExpNotationValuesGreater parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetExpNotationValuesGreater
| public virtual SetExpNotationValuesGreater( | | iExpNotationValuesGreater) |
-
Sets the ExpNotationValuesGreater attribute.
Role:Set the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iExpNotationValuesGreater
- The minimum value for exponential notation values.
o SetExpNotationValuesLowerLock
| public virtual SetExpNotationValuesLowerLock( | | iLocked) |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the ExpNotationValuesLower parameter.
Role: Locks or unlocks the ExpNotationValuesLower parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetExpNotationValuesLower
| public virtual SetExpNotationValuesLower( | | iExpNotationValuesLower) |
-
Sets the ExpNotationValuesLower attribute.
Role:Set the ExpNotationValuesGreater parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iExpNotationValuesLower
- The maximum value for exponential notation values.
o SetListOfMagnitudesLock
| public virtual SetListOfMagnitudesLock( | | iLocked) |
-
Locks or unlocks the ListOfMagnitudes setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetMagnitudeValues
| public virtual SetMagnitudeValues( | | iMagnitudeName, |
| | iUnitName, |
| | iDecimalPlaceReadWrite, |
| | iDecimalPlaceReadOnly) |
-
Sets the MagnitudeValues attribute.
Role:Set the MagnitudeValues parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iMagnitudeName
- The name of the magnitude.
- iUnitName
- The name of the unit.
- iDecimalPlaceReadWrite
- The number of decimals for read/write number.
- iDecimalPlaceReadOnly
- The number of decimals for read/only number.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSameDisplayLock
| public virtual SetSameDisplayLock( | | iLocked) |
-
- Deprecated:
- V5R15. Use SetDimensionsDisplayLock.
Locks or unlocks the SameDisplay parameter.
Role: Locks or unlocks the SameDisplay parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSameDisplay
| public virtual SetSameDisplay( | | iSameDisplay) |
-
*
Sets the SameDisplay attribute.
Role:Set the SameDisplay parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
- Parameters:
-
- iSameDisplay
- Legal values:
0 : to not display same display
1 : to display same display.
This object is included in the file: CATILieUnitsSheetSettingAtt.h
If needed, your Imakefile.mk should include the module: KnowledgeItf