pycatia.knowledge_interfaces.units_sheet_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.knowledge_interfaces.units_sheet_setting_att.UnitsSheetSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

UnitsSheetSettingAtt

The interface to access a CATIAUnitsSheetSettingAtt.

This interface may be used to read or modify in the CATIA/Tools/Option the

settings values of Units sheet.

commit_for_units() → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CommitForUnits()

Implements a function from an interface.

See also:

UnitsSheetSettingAtt.CommitForUnits

Return type:

None

property display_trailing_zeros: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DisplayTrailingZeros() As short

Returns or sets the DisplayTrailingZeros parameter.

Role:Return or Set the DisplayTrailingZeros parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oDisplayTrailingZeros

Legal values:

0 : to not display trailing zeros

1 : to display trailing zeros.

Return type:

int

property exp_notation_values_greater: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ExpNotationValuesGreater() As double

Returns or sets the ExpNotationValuesGreater parameter.

Role:Return or Set the ExpNotationValuesGreater parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

oExpNotationValuesGreater

The minimum value for exponential notation values.

Return type:

float

property exp_notation_values_lower: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ExpNotationValuesLower() As double

Returns or sets the ExpNotationValuesLower parameter.

Role:Return or Set the ExpNotationValuesGreater parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

oExpNotationValuesLower

The maximum value for exponential notation values.

Return type:

float

get_decimal_read_only(i_magnitude_name: str, o_decimal_place_read_only: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetDecimalReadOnly(CATBSTR iMagnitudeName,

double oDecimalPlaceReadOnly)

Returns the number of decimals for ReadOnly number.

Parameters:

• i_magnitude_name (str) –

• o_decimal_place_read_only (float) –

Return type:

None

get_decimal_read_write(i_magnitude_name: str, o_decimal_place_read_write: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetDecimalReadWrite(CATBSTR iMagnitudeName,

double oDecimalPlaceReadWrite)

Returns the number of decimals for ReadWrite number.

Parameters:

• i_magnitude_name (str) –

• o_decimal_place_read_write (float) –

Return type:

None

get_dimensions_display_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDimensionsDisplayInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the DimensionsDisplay setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_display_trailing_zeros_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDisplayTrailingZerosInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisplayTrailingZeros

parameter.

Role:Retrieves the state of the DisplayTrailingZeros parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_exp_notation_values_greater_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetExpNotationValuesGreaterInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ExpNotationValuesGreater

parameter.

Role:Retrieves the state of the ExpNotationValuesGreater parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_exp_notation_values_lower_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetExpNotationValuesLowerInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ExpNotationValuesLower

parameter.

Role:Retrieves the state of the ExpNotationValuesLower parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_list_of_magnitudes_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetListOfMagnitudesInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ListOfMagnitudes setting

parameter.

Refer to SettingController for a detailed description.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_magnitude_values(i_magnitude_name: str, o_unit_name: str, o_decimal_place_read_write: float, o_decimal_place_read_only: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetMagnitudeValues(CATBSTR iMagnitudeName,

CATBSTR oUnitName,

double oDecimalPlaceReadWrite,

double oDecimalPlaceReadOnly)

Returns the Magnitude parameters.

Ensure consistency with the C++ interface to which the work is delegated.

Parameters:

• i_magnitude_name (str) –

• o_unit_name (str) –

• o_decimal_place_read_write (float) –

• o_decimal_place_read_only (float) –

Return type:

None

get_same_display_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetSameDisplayInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SameDisplay

parameter.

Role:Retrieves the state of the SameDisplay parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property list_of_magnitudes: tuple

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ListOfMagnitudes() As CATSafeArrayVariant (Read

Only)

Returns or sets the ListOfMagnitudes parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

tuple

property list_of_magnitudes_size: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ListOfMagnitudesSize() As double (Read Only)

Returns or sets the ListOfMagnitudesSize parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

float

reset_to_admin_values_for_units() → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ResetToAdminValuesForUnits()

Implements a function from an interface.

See also:

UnitsSheetSettingAtt.ResetToAdminValuesForUnits

Return type:

None

rollback_for_units() → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RollbackForUnits()

Implements a function from an interface.

See also:

UnitsSheetSettingAtt.RollbackForUnits

Return type:

None

property same_display: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SameDisplay() As short

Returns or sets the SameDisplay parameter.

Role:Return or Set the SameDisplay parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oSameDisplay

Legal values:

0 : to not display same display

1 : to display same display.

Return type:

int

save_repository_for_units() → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SaveRepositoryForUnits()

Implements a function from an interface.

See also:

UnitsSheetSettingAtt.SaveRepositoryForUnits

Return type:

None

set_dimensions_display_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDimensionsDisplayLock(boolean iLocked)

Locks or unlocks the DimensionsDisplay setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_display_trailing_zeros_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDisplayTrailingZerosLock(boolean iLocked)

Deprecated:

V5R15. Use SetDimensionsDisplayLock. Locks or unlocks the

DisplayTrailingZeros parameter.

Role:Locks or unlocks the DisplayTrailingZeros parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_exp_notation_values_greater_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetExpNotationValuesGreaterLock(boolean iLocked)

Deprecated:

V5R15. Use SetSameDisplayLock. Locks or unlocks the

ExpNotationValuesGreater parameter.

Role:Locks or unlocks the ExpNotationValuesGreater parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_exp_notation_values_lower_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetExpNotationValuesLowerLock(boolean iLocked)

Deprecated:

V5R15. Use SetDimensionsDisplayLock. Locks or unlocks the

ExpNotationValuesLower parameter.

Role:Locks or unlocks the ExpNotationValuesLower parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_list_of_magnitudes_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetListOfMagnitudesLock(boolean iLocked)

Locks or unlocks the ListOfMagnitudes setting parameter.

Refer to SettingController for a detailed description.

Parameters:

i_locked (bool) –

Return type:

None

set_magnitude_values(i_magnitude_name: str, i_unit_name: str, i_decimal_place_read_write: float, i_decimal_place_read_only: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMagnitudeValues(CATBSTR iMagnitudeName,

CATBSTR iUnitName,

double iDecimalPlaceReadWrite,

double iDecimalPlaceReadOnly)

Sets the Magnitude parameters.

Ensure consistency with the C++ interface to which the work is delegated.

Parameters:

• i_magnitude_name (str) –

• i_unit_name (str) –

• i_decimal_place_read_write (float) –

• i_decimal_place_read_only (float) –

Return type:

None

set_same_display_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetSameDisplayLock(boolean iLocked)

Deprecated:

V5R15. Use SetDimensionsDisplayLock. Locks or unlocks the SameDisplay

parameter.

Role:Locks or unlocks the SameDisplay parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None